public final class DirectoryDefaultHelper extends Object
DirectoryDefault
class.
Underlying user and role entities managed by this class are persisted in the
EBX® repository.Constructor and Description |
---|
DirectoryDefaultHelper() |
Modifier and Type | Method and Description |
---|---|
static ProcedureResult |
deleteRole(Role aRole,
String aTrackingInfoOrNull,
DirectoryDefault aDirectory)
Deletes the role entity corresponding to the specified role.
|
static ProcedureResult |
deleteUser(UserReference aUserReference,
String aTrackingInfoOrNull,
DirectoryDefault aDirectory)
Deletes the user entity corresponding to the specified user reference.
|
static DirectoryDefault.RoleEntity |
findRole(Role aRole,
DirectoryDefault aDirectory)
Returns the role entity corresponding to the specified role if it exists,
null otherwise. |
static DirectoryDefault.UserEntity |
findUser(UserReference aUserReference,
DirectoryDefault aDirectory)
Returns the user entity corresponding to the specified user reference if it exists,
null otherwise. |
static DirectoryDefault.RoleEntity |
newRole(Role aRole)
Returns a new role entity whose key is the specified role.
|
static DirectoryDefault.UserEntity |
newUser(UserReference aUserReference,
DirectoryDefault aDirectory)
Returns a new user entity whose key is the specified user reference.
|
static ProcedureResult |
saveRole(DirectoryDefault.RoleEntity aRole,
String aTrackingInfoOrNull,
DirectoryDefault aDirectory)
Makes the specified role entity persistent if it does not yet exist in the
EBX® repository; updates it if it exists.
|
static ProcedureResult |
saveUser(DirectoryDefault.UserEntity aUser,
String aTrackingInfoOrNull,
DirectoryDefault aDirectory)
Makes the specified user entity persistent if it does not exist yet in the
EBX® repository; updates it if it exists.
|
public static DirectoryDefault.RoleEntity findRole(Role aRole, DirectoryDefault aDirectory)
null
otherwise.IllegalArgumentException
- if the specified role is a built-in role.public static DirectoryDefault.UserEntity findUser(UserReference aUserReference, DirectoryDefault aDirectory)
null
otherwise.public static DirectoryDefault.RoleEntity newRole(Role aRole)
saveRole
must be called to make it persistent.IllegalArgumentException
- if the specified role is a built-in role.public static DirectoryDefault.UserEntity newUser(UserReference aUserReference, DirectoryDefault aDirectory)
saveUser
must be called to make it persistent.public static ProcedureResult saveRole(DirectoryDefault.RoleEntity aRole, String aTrackingInfoOrNull, DirectoryDefault aDirectory)
public static ProcedureResult saveUser(DirectoryDefault.UserEntity aUser, String aTrackingInfoOrNull, DirectoryDefault aDirectory)
public static ProcedureResult deleteRole(Role aRole, String aTrackingInfoOrNull, DirectoryDefault aDirectory)
IllegalArgumentException
- if the specified role is a built-in role.public static ProcedureResult deleteUser(UserReference aUserReference, String aTrackingInfoOrNull, DirectoryDefault aDirectory)