oracle.igf.ids

Class CustomUserManager

java.lang.Object

oracle.igf.ids.AbstractEntityManager

oracle.igf.ids.UserManager

oracle.igf.ids.CustomUserManager

public abstract class CustomUserManager
extends UserManager

This abstract class acts as a bridge between the custom implementations of the UserManager object , if any , and the default implementation UserManager. Any custom UserManager implementations need to extend this class along with a custom IdentityDirectory implementation.

Constructor Summary

Constructors

Constructor and Description
CustomUserManager(IdentityDirectory ids, java.lang.String entityName)

Method Summary

Modifier and Type	Method and Description
boolean	authenticateUser(java.security.Principal principal, char[] password) This method should be implemented by any custom UserManager implementations to authenticate a user for a given User principal and password.
boolean	authenticateUser(java.security.Principal principal, char[] password, boolean checkPwdPolicyWarning) This method should be implemented by any custom UserManager implementations to authenticate a user for a given User principal and password.
User	authenticateUser(java.lang.String id, char[] password, ReadOptions opts) This method should be implemented by any custom UserManagaer implementations to authenticate the user for a given id and password
User	authenticateUser(java.lang.String id, char[] password, ReadOptions opts, boolean checkPwdPolicyWarning) This method should be implemented by any custom UserManagaer implementations to authenticate a user for a given id and password.
User	authenticateUser(java.lang.String attrName, java.lang.String attrVal, char[] password, ReadOptions opts) This method should be implemented by any custom UserManagaer implementations to authenticate a user for a given unique attribute name , attribute value and password.
User	authenticateUser(java.lang.String attrName, java.lang.String attrVal, char[] password, ReadOptions opts, boolean checkPwdPolicyWarning) This method should be implemented by any custom UserManagaer implementations to authenticate a user for a given unique attribute name, attribute value and password.
void	changePassword(java.security.Principal principal, char[] oldPassword, char[] newPassword, ModifyOptions opts) This method should be implemented by any custom UserManager implementations to change user password given the old and the new password
void	changePassword(java.lang.String id, char[] oldPassword, char[] newPassword, ModifyOptions opts) This method should be implemented by any custom UserManager implementations to change user password given the old and the new password
void	changePassword(java.lang.String attrName, java.lang.String attrVal, char[] oldPassword, char[] newPassword, ModifyOptions opts) This method should be implemented by any custom UserManager implementations to change user password given the old and the new password
boolean	compareEntityAttr(java.security.Principal principal, java.lang.String attrname, char[] attrvalue) This method can be implemented compared the attribute value for a particular attribute name.The attribute value parameter is given in a character array, making this method suitable for comparing passwords and sensitive data.
boolean	compareEntityAttr(java.security.Principal principal, java.lang.String attrname, java.lang.String attrvalue) This method can be implemented to provide a functionality to compared the attribute value for a particular attribute name.
java.security.Principal	createUser(java.util.List<Attribute> attrVals, CreateOptions opts) This method should be implemented by any custom UserManager implementations to creates user in the repository with given list of attribute values.
void	deleteUser(java.security.Principal principal, DeleteOptions opts) This method should be implemented by any custom UserManager implementations to delete a user from the repository for a given user principal
void	deleteUser(java.lang.String id, DeleteOptions opts) This method should be implemented by any custom UserManager implementations to deletes the user from the repository for a given user id attribute value
void	deleteUser(java.lang.String attrName, java.lang.String attrVal, DeleteOptions opts) This method should be implemented by any custom UserManagaer implementations to deletes the user from the repository for given unique attribute name and value.
AttributeDef	getAttributeDef(java.lang.String attrName) Gets attribute definition for a given attribute name.
AttributeRef	getAttributeRef(java.lang.String attrName) Gets entity attribute reference for given attribute name.
UserCapabilities	getCapabilities() Get the capabilities for any user to run the following operations - Create, Read, Update , Delete.
java.util.List<java.lang.String>	getEntityAttributes() Get entity attributes from entity definition Return default attributes unless modified using the custom IdentityDirectory implementation.
EntityDef	getEntityDef() Get the entity definition.
java.util.List<EntityRelationship>	getEntityRelationships() Gets all entity relationships where current entity is part of the entity relationship definition
java.lang.String	getGlobalCommonIdAttribute(java.lang.String entityName) This method can be implemented to get the global common id attribute name configured in the entity definition, as required.
java.lang.String	getIdAttribute() This method can be implemented to get the id attribute corresponding to a given entityName.
User	getUser(java.security.Principal principal, ReadOptions opts) This method should be implemented by any custom UserManager implementations to get the user for the given principal identifier.
void	modify(java.security.Principal principal, java.util.List<ModAttribute> attrVals, ModifyOptions opts) This method can be implemented to provide a functionality to modify the attributes of a user, identified by the Principal cast object of the user.
void	modify(java.lang.String id, java.util.List<ModAttribute> attrVals, ModifyOptions opts) This method can be implemented to provide a functionality to modify the attributes of a user, identified by an id.
void	modify(java.lang.String attrName, java.lang.String attrVal, java.util.List<ModAttribute> attrVals, ModifyOptions opts) This method can be implemented to provide a functionality to modify the attributes of a user, identified by an attribute value matching an attribute name
void	rename(java.security.Principal principal, java.lang.String newName, java.lang.String newContainer, ModifyOptions opts) This method can be implemented to provide a functionality to rename a user, identified by the Principal cast object of the user.
void	resetPassword(java.security.Principal principal, char[] password, ModifyOptions opts) This method should be implemented by any custom UserManager implementations to reset the user password
void	resetPassword(java.lang.String id, char[] password, ModifyOptions opts) This method should be implemented by any custom UserManager implementations to reset the user password
void	resetPassword(java.lang.String attrName, java.lang.String attrVal, char[] password, ModifyOptions opts) This method should be implemented by any custom UserManager implementations to reset the user password
User	searchUser(java.lang.String id, ReadOptions opts) This method should be implemented by any custom UserManager implementations to search for a user matching given id attribute value that uniquely identifies the user.
User	searchUser(java.lang.String attrName, java.lang.String attrVal, ReadOptions opts) This method should be implemented by any custom UserManager implementations to find a user matching given attribute name and value
User	searchUserByGuid(java.lang.String guid, ReadOptions opts) This method should be implemented by any custom UserManager implementations to search for a user matching given GUID value that uniquely identifies the user
ResultSet<User>	searchUsers(SearchFilter filter, SearchOptions opts) This method should be implemented by any custom UserManager implementations to search the repository and returns list of users matching the given filter condition.
boolean	validatePassword(java.security.Principal principal, char[] password) This method should be implemented by any custom UserManager implementations to validates user password for a given principal without bind in the LDAP repository.
boolean	validatePassword(java.security.Principal principal, char[] password, boolean checkPwdPolicyWarning) This method should be implemented by any custom UserManager implementations to validate user password for the given principal without bind in the LDAP repository.
User	validatePassword(java.lang.String id, char[] password, ReadOptions opts) This method should be implemented by any custom UserManager implementations to validate user password for a given id without bind in LDAP repository.
User	validatePassword(java.lang.String id, char[] password, ReadOptions opts, boolean checkPwdPolicyWarning) This method should be implemented by any custom UserManager implementations to validate user password for a given id without bind in LDAP repository.
User	validatePassword(java.lang.String attrName, java.lang.String attrVal, char[] password, ReadOptions opts) This method should be implemented by any custom UserManager implementations to validates user password for a given attribute name and attribute value without bind in the LDAP repository.
User	validatePassword(java.lang.String attrName, java.lang.String attrVal, char[] password, ReadOptions opts, boolean checkPwdPolicyWarning) This method should be implemented by an custom UserManager implementations to validate user password for a given attribute name and attribute value without bind in the LDAP repository.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CustomUserManager

public CustomUserManager(IdentityDirectory ids,
                         java.lang.String entityName)

Method Detail

createUser

public java.security.Principal createUser(java.util.List<Attribute> attrVals,
                                          CreateOptions opts)
                                   throws IDSException,
                                          EntityAlreadyExistsException,
                                          OperationNotSupportedException,
                                          AuthorizationException,
                                          InvalidAttributesException

This method should be implemented by any custom UserManager implementations to creates user in the repository with given list of attribute values.

Overrides:

createUser in class UserManager

Parameters:

attrVals - List of attribute values

opts - Create operation options

Returns:

Principal identifier of the user created

Throws:

IDSException - Generic Identity Directory Service exception

EntityAlreadyExistsException - When the user to be created already exists

OperationNotSupportedException - If the user create operation is not supported

InvalidAttributesException - When the add attributes list is invalid

AuthorizationException - If user does not have sufficient privileges

getUser

public User getUser(java.security.Principal principal,
                    ReadOptions opts)
             throws EntityNotFoundException,
                    IDSException,
                    AuthorizationException,
                    InvalidAttributesException

This method should be implemented by any custom UserManager implementations to get the user for the given principal identifier.

Overrides:

getUser in class UserManager

Parameters:

principal - Principal identifier of the user

opts - Read operation options

Returns:

User for the requested principal identifier

Throws:

EntityNotFoundException - When there is no user in the repository for given user principal

IDSException - Generic Identity Directory Service exception

InvalidAttributesException - If the requested attributes is invalid

AuthorizationException - If user does not have sufficient privileges

searchUser

public User searchUser(java.lang.String id,
                       ReadOptions opts)
                throws IDSException,
                       EntityNotFoundException,
                       EntityNotUniqueException,
                       AuthorizationException,
                       InvalidAttributesException

This method should be implemented by any custom UserManager implementations to search for a user matching given id attribute value that uniquely identifies the user.

Overrides:

searchUser in class UserManager

Parameters:

id - Value of the user's id attribute

opts - Read operation options

Returns:

User matching given ID value

Throws:

IDSException - Generic Identity Directory Service exception

EntityNotFoundException - When there is no user found for given ID value

EntityNotUniqueException - When the given filter condition does not uniquely identify the user

InvalidAttributesException - If the requested attributes is invalid

AuthorizationException - If user does not have sufficient privileges

searchUser

public User searchUser(java.lang.String attrName,
                       java.lang.String attrVal,
                       ReadOptions opts)
                throws IDSException,
                       EntityNotFoundException,
                       EntityNotUniqueException,
                       InvalidFilterException,
                       AuthorizationException,
                       InvalidAttributesException

This method should be implemented by any custom UserManager implementations to find a user matching given attribute name and value

Overrides:

searchUser in class UserManager

Parameters:

attrName - Name of the attribute

attrVal - Attribute value

opts - Read operation options

Returns:

User matching given search filter

Throws:

IDSException - Generic Identity Directory Service exception

EntityNotFoundException - When no user found for given search filter

EntityNotUniqueException - When the given filter condition does not uniquely identify the user

InvalidFilterException - If the attribute is invalid filter attribute

InvalidAttributesException - If the requested attributes is invalid

AuthorizationException - If user does not have sufficient privileges

searchUserByGuid

public User searchUserByGuid(java.lang.String guid,
                             ReadOptions opts)
                      throws IDSException,
                             EntityNotFoundException,
                             EntityNotUniqueException,
                             AuthorizationException,
                             InvalidAttributesException

This method should be implemented by any custom UserManager implementations to search for a user matching given GUID value that uniquely identifies the user

Overrides:

searchUserByGuid in class UserManager

Parameters:

guid - GUID value of user

opts - Read operation options

Returns:

User matching given GUID value

Throws:

IDSException - Generic Identity Directory Service exception

EntityNotFoundException - When there is no user found for given GUID value

EntityNotUniqueException - When the given GUID values does not uniquely identify the user

InvalidAttributesException - If the requested attributes is invalid

AuthorizationException - If user does not have sufficient privileges

searchUsers

public ResultSet<User> searchUsers(SearchFilter filter,
                                   SearchOptions opts)
                            throws IDSException,
                                   InvalidFilterException,
                                   OperationNotSupportedException,
                                   AuthorizationException,
                                   InvalidAttributesException

This method should be implemented by any custom UserManager implementations to search the repository and returns list of users matching the given filter condition. Pagesize, Sorting and other options can be specified in the search options.

Overrides:

searchUsers in class UserManager

Parameters:

filter - Search filter

opts - Search operation options

Returns:

Search results matching given filter

Throws:

IDSException - Generic Identity Directory Service exception

InvalidFilterException - When the input search filter is not valid

OperationNotSupportedException - When this user search operation is not supported

InvalidAttributesException - When the requested attributes or the attributes in the search filter are invalid

AuthorizationException - If user does not have sufficient privileges

deleteUser

public void deleteUser(java.security.Principal principal,
                       DeleteOptions opts)
                throws EntityNotFoundException,
                       IDSException,
                       AuthorizationException,
                       OperationNotSupportedException

This method should be implemented by any custom UserManager implementations to delete a user from the repository for a given user principal

Overrides:

deleteUser in class UserManager

Parameters:

principal - User principal

opts - Delete operation options

Throws:

EntityNotFoundException - When there is no user in the repository for given user principal

IDSException - Generic Identity Directory Service exception

OperationNotSupportedException - If the user delete operation is not supported

AuthorizationException - If user does not have sufficient privileges

deleteUser

public void deleteUser(java.lang.String id,
                       DeleteOptions opts)
                throws EntityNotFoundException,
                       IDSException,
                       AuthorizationException,
                       OperationNotSupportedException

This method should be implemented by any custom UserManager implementations to deletes the user from the repository for a given user id attribute value

Overrides:

deleteUser in class UserManager

Parameters:

id - User id value

opts - Delete operation options

Throws:

EntityNotFoundException - When there is no user in the repository for given user principal

IDSException - Generic Identity Directory Service exception

OperationNotSupportedException - If the user delete operation is not supported

AuthorizationException - If user does not have sufficient privileges

deleteUser

public void deleteUser(java.lang.String attrName,
                       java.lang.String attrVal,
                       DeleteOptions opts)
                throws EntityNotFoundException,
                       IDSException,
                       AuthorizationException,
                       OperationNotSupportedException

This method should be implemented by any custom UserManagaer implementations to deletes the user from the repository for given unique attribute name and value.

Overrides:

deleteUser in class UserManager

Parameters:

attrName - Name of the attribute

attrVal - Attribute value

opts - Delete operation options

Throws:

EntityNotFoundException - When there is no user in the repository for given user principal

IDSException - Generic Identity Directory Service exception

OperationNotSupportedException - If the user delete operation is not supported

AuthorizationException - If user does not have sufficient privileges

authenticateUser

public User authenticateUser(java.lang.String id,
                             char[] password,
                             ReadOptions opts)
                      throws IDSException,
                             EntityNotFoundException,
                             EntityNotUniqueException,
                             OperationNotSupportedException,
                             AuthenticationException

This method should be implemented by any custom UserManagaer implementations to authenticate the user for a given id and password

Overrides:

authenticateUser in class UserManager

Parameters:

id - Id attribute value. ID attribute is defined in the entity configuration that uniquely identifies the user entity

password - User password to be verified

opts - Read operation options

Returns:

user matching the given ID value and authenticated successfully

Throws:

IDSException - Generic Identity Directory Service exception

EntityNotFoundException - When no user found for given ID value

EntityNotUniqueException - If the given ID value does not uniquely identify the user

OperationNotSupportedException - If the user authentication operation is not supported

AuthenticationException - If user authentication failed

authenticateUser

public User authenticateUser(java.lang.String id,
                             char[] password,
                             ReadOptions opts,
                             boolean checkPwdPolicyWarning)
                      throws IDSException,
                             EntityNotFoundException,
                             EntityNotUniqueException,
                             OperationNotSupportedException,
                             AuthenticationWarningException,
                             AuthenticationException

This method should be implemented by any custom UserManagaer implementations to authenticate a user for a given id and password.

Overrides:

authenticateUser in class UserManager

Parameters:

id - Id attribute value. ID attribute is defined in the entity configuration that uniquely identifies the user entity

password - User password to be verified

opts - Read operation options

checkPwdPolicyWarning - If true and there are any password policy related warnings throws AuthenticationWarningException

Returns:

user matching the given ID value and authenticated successfully

Throws:

IDSException - Generic Identity Directory Service exception

EntityNotFoundException - When no user found for given ID value

EntityNotUniqueException - If the given ID value does not uniquely identify the user

OperationNotSupportedException - If the user authentication operation is not supported

AuthenticationWarningException - If there are any password policy related warnings like Password must change, Grace Login, Password expire, etc

AuthenticationException - If user authentication failed

authenticateUser

public User authenticateUser(java.lang.String attrName,
                             java.lang.String attrVal,
                             char[] password,
                             ReadOptions opts)
                      throws IDSException,
                             EntityNotFoundException,
                             EntityNotUniqueException,
                             OperationNotSupportedException,
                             AuthenticationException

This method should be implemented by any custom UserManagaer implementations to authenticate a user for a given unique attribute name , attribute value and password.

Overrides:

authenticateUser in class UserManager

Parameters:

attrName - Name of the attribute that uniquely identifies the user

attrVal - Attribute value

password - User password to be verified

opts - Read operation options

Returns:

user matching the given attrname, value and authenticated successfully

Throws:

IDSException - Generic Identity Directory Service exception

EntityNotFoundException - When no user found for given ID value

EntityNotUniqueException - If the given ID value does not uniquely identify the user

OperationNotSupportedException - If the user authentication operation is not supported

AuthenticationException - If user authentication failed

authenticateUser

public User authenticateUser(java.lang.String attrName,
                             java.lang.String attrVal,
                             char[] password,
                             ReadOptions opts,
                             boolean checkPwdPolicyWarning)
                      throws IDSException,
                             EntityNotFoundException,
                             EntityNotUniqueException,
                             OperationNotSupportedException,
                             AuthenticationWarningException,
                             AuthenticationException

This method should be implemented by any custom UserManagaer implementations to authenticate a user for a given unique attribute name, attribute value and password.

Overrides:

authenticateUser in class UserManager

Parameters:

attrName - Name of the attribute that uniquely identifies the user

attrVal - Attribute value

password - User password to be verified

opts - Read operation options

checkPwdPolicyWarning - If true and there are any password policy related warnings throws AuthenticationWarningException

Returns:

user matching the given attrname, attrvalue and authenticated successfully

Throws:

IDSException - Generic Identity Directory Service exception

EntityNotFoundException - When no user found for given ID value

EntityNotUniqueException - If the given ID value does not uniquely identify the user

OperationNotSupportedException - If the user authentication operation is not supported

AuthenticationWarningException - If there are any password policy related warnings like Password must change, Grace Login, Password expire, etc

AuthenticationException - If user authentication failed

authenticateUser

public boolean authenticateUser(java.security.Principal principal,
                                char[] password)
                         throws IDSException,
                                EntityNotFoundException,
                                OperationNotSupportedException,
                                AuthenticationException

This method should be implemented by any custom UserManager implementations to authenticate a user for a given User principal and password.

Overrides:

authenticateUser in class UserManager

Parameters:

principal - Principal identifier of the user

password - User password

Returns:

true if authenticated successfully ; false otherwise

Throws:

IDSException - Generic Identity Directory Service exception

EntityNotFoundException - When no user found for given ID value

OperationNotSupportedException - If the user authenticate operation is not supported

AuthenticationException - If user authentication failed

authenticateUser

public boolean authenticateUser(java.security.Principal principal,
                                char[] password,
                                boolean checkPwdPolicyWarning)
                         throws IDSException,
                                EntityNotFoundException,
                                OperationNotSupportedException,
                                AuthenticationWarningException,
                                AuthenticationException

This method should be implemented by any custom UserManager implementations to authenticate a user for a given User principal and password.

Overrides:

authenticateUser in class UserManager

Parameters:

principal - Principal identifier of the user

password - User password

checkPwdPolicyWarning - If true and there are any password policy related warnings throws AuthenticationWarningException

Returns:

true if authenticated successfully ; false otherwise

Throws:

IDSException - Generic Identity Directory Service exception

EntityNotFoundException - When no user found for given ID value

OperationNotSupportedException - If the user authenticate operation is not supported

AuthenticationWarningException - If there are any password policy related warnings like Password must change, Grace Login, Password expire, etc

AuthenticationException - If user authentication failed

validatePassword

public User validatePassword(java.lang.String id,
                             char[] password,
                             ReadOptions opts)
                      throws IDSException,
                             EntityNotFoundException,
                             EntityNotUniqueException,
                             OperationNotSupportedException,
                             AuthenticationException

This method should be implemented by any custom UserManager implementations to validate user password for a given id without bind in LDAP repository.

Overrides:

validatePassword in class UserManager

Parameters:

id - Id attribute value. ID attribute is defined in the entity configuration that uniquely identifies the user entity

password - User password to be validated

opts - Read operation options

Returns:

user matching the given ID value and password

Throws:

IDSException - Generic Identity Directory Service exception

EntityNotFoundException - When no user found for given ID value

EntityNotUniqueException - If the given ID value does not uniquely identify the user

OperationNotSupportedException - If the user authentication operation is not supported

AuthenticationException - If user authentication failed

validatePassword

public User validatePassword(java.lang.String id,
                             char[] password,
                             ReadOptions opts,
                             boolean checkPwdPolicyWarning)
                      throws IDSException,
                             EntityNotFoundException,
                             EntityNotUniqueException,
                             OperationNotSupportedException,
                             AuthenticationWarningException,
                             AuthenticationException

This method should be implemented by any custom UserManager implementations to validate user password for a given id without bind in LDAP repository.

Overrides:

validatePassword in class UserManager

Parameters:

id - Id attribute value. ID attribute is defined in the entity configuration that uniquely identifies the user entity

password - User password to be validated

opts - Read operation options

checkPwdPolicyWarning - If true and there are any password policy related warnings throws AuthenticationWarningException

Returns:

user matching the given ID value and password

Throws:

IDSException - Generic Identity Directory Service exception

EntityNotFoundException - When no user found for given ID value

EntityNotUniqueException - If the given ID value does not uniquely identify the user

OperationNotSupportedException - If the user authentication operation is not supported

AuthenticationWarningException - If there are any password policy related warnings like Password must change, Grace Login, Password expire, etc

AuthenticationException - If user authentication failed

validatePassword

public User validatePassword(java.lang.String attrName,
                             java.lang.String attrVal,
                             char[] password,
                             ReadOptions opts)
                      throws IDSException,
                             EntityNotFoundException,
                             EntityNotUniqueException,
                             OperationNotSupportedException,
                             AuthenticationException

This method should be implemented by any custom UserManager implementations to validates user password for a given attribute name and attribute value without bind in the LDAP repository.

Overrides:

validatePassword in class UserManager

Parameters:

attrName - Name of the attribute that uniquely identifies the user

attrVal - Attribute value

password - User password to be validated

opts - Read operation options

Returns:

user matching the given attrname, value and authenticated successfully

Throws:

IDSException - Generic Identity Directory Service exception

EntityNotFoundException - When no user found for given ID value

EntityNotUniqueException - If the given ID value does not uniquely identify the user

OperationNotSupportedException - If the user authentication operation is not supported

AuthenticationException - If user authentication failed

validatePassword

public User validatePassword(java.lang.String attrName,
                             java.lang.String attrVal,
                             char[] password,
                             ReadOptions opts,
                             boolean checkPwdPolicyWarning)
                      throws IDSException,
                             EntityNotFoundException,
                             EntityNotUniqueException,
                             OperationNotSupportedException,
                             AuthenticationWarningException,
                             AuthenticationException

This method should be implemented by an custom UserManager implementations to validate user password for a given attribute name and attribute value without bind in the LDAP repository.

Overrides:

validatePassword in class UserManager

Parameters:

attrName - Name of the attribute that uniquely identifies the user

attrVal - Attribute value

password - User password to be validated

opts - Read operation options

checkPwdPolicyWarning - If true and there are any password policy related warnings throws AuthenticationWarningException

Returns:

user matching the given attrname, value and authenticated successfully

Throws:

IDSException - Generic Identity Directory Service exception

EntityNotFoundException - When no user found for given ID value

EntityNotUniqueException - If the given ID value does not uniquely identify the user

OperationNotSupportedException - If the user authentication operation is not supported

AuthenticationWarningException - If there are any password policy related warnings like Password must change, Grace Login, Password expire, etc

AuthenticationException - If user authentication failed

validatePassword

public boolean validatePassword(java.security.Principal principal,
                                char[] password)
                         throws IDSException,
                                EntityNotFoundException,
                                OperationNotSupportedException,
                                AuthenticationException

This method should be implemented by any custom UserManager implementations to validates user password for a given principal without bind in the LDAP repository.

Overrides:

validatePassword in class UserManager

Parameters:

principal - Principal identifier of the user

password - User password

Returns:

true if authenticated successfully ; false otherwise

Throws:

IDSException - Generic Identity Directory Service exception

EntityNotFoundException - When no user found for given ID value

OperationNotSupportedException - If the user authenticate operation is not supported

AuthenticationException - If user authentication failed

validatePassword

public boolean validatePassword(java.security.Principal principal,
                                char[] password,
                                boolean checkPwdPolicyWarning)
                         throws IDSException,
                                EntityNotFoundException,
                                OperationNotSupportedException,
                                AuthenticationWarningException,
                                AuthenticationException

This method should be implemented by any custom UserManager implementations to validate user password for the given principal without bind in the LDAP repository.

Overrides:

validatePassword in class UserManager

Parameters:

principal - Principal identifier of the user

password - User password

checkPwdPolicyWarning - If true and there are any password policy related warnings throws AuthenticationWarningException

Returns:

true if authenticated successfully ; false otherwise

Throws:

IDSException - Generic Identity Directory Service exception

EntityNotFoundException - When no user found for given ID value

OperationNotSupportedException - If the user authenticate operation is not supported

AuthenticationWarningException - If there are any password policy related warnings like Password must change, Grace Login, Password expire, etc

AuthenticationException - If user authentication failed

changePassword

public void changePassword(java.security.Principal principal,
                           char[] oldPassword,
                           char[] newPassword,
                           ModifyOptions opts)
                    throws AuthenticationException,
                           OperationNotSupportedException,
                           EntityNotFoundException,
                           AuthorizationException,
                           PasswordPolicyException,
                           IDSException

This method should be implemented by any custom UserManager implementations to change user password given the old and the new password

Overrides:

changePassword in class UserManager

Parameters:

principal - Principal identifier of the user

oldPassword - Old password of the user

newPassword - New password of the user

opts - Modify options

Throws:

IDSException - Generic Identity Directory Service exception

EntityNotFoundException - When this user is not found

OperationNotSupportedException - If the user authenticate operation is not supported

AuthenticationException - If user authentication failed

PasswordPolicyException - If there are any password policy errors

AuthorizationException - If user does not have sufficient privileges

changePassword

public void changePassword(java.lang.String id,
                           char[] oldPassword,
                           char[] newPassword,
                           ModifyOptions opts)
                    throws AuthenticationException,
                           OperationNotSupportedException,
                           EntityNotFoundException,
                           AuthorizationException,
                           PasswordPolicyException,
                           IDSException

This method should be implemented by any custom UserManager implementations to change user password given the old and the new password

Overrides:

changePassword in class UserManager

Parameters:

id - Id attribute value. ID attribute is defined in the entity configuration that uniquely identifies the user entity

oldPassword - Old password of the user

newPassword - New password of the user

opts - Modify options

Throws:

IDSException - Generic Identity Directory Service exception

EntityNotFoundException - When this user is not found

OperationNotSupportedException - If the user authenticate operation is not supported

AuthenticationException - If user authentication failed

PasswordPolicyException - If there are any password policy errors

AuthorizationException - If user does not have sufficient privileges

changePassword

public void changePassword(java.lang.String attrName,
                           java.lang.String attrVal,
                           char[] oldPassword,
                           char[] newPassword,
                           ModifyOptions opts)
                    throws AuthenticationException,
                           OperationNotSupportedException,
                           EntityNotFoundException,
                           AuthorizationException,
                           PasswordPolicyException,
                           IDSException

This method should be implemented by any custom UserManager implementations to change user password given the old and the new password

Overrides:

changePassword in class UserManager

Parameters:

attrName - Name of the attribute that uniquely identifies the user

attrVal - Attribute value

oldPassword - Old password of the user

newPassword - New password of the user

opts - Modify options

Throws:

IDSException - Generic Identity Directory Service exception

EntityNotFoundException - When this user is not found

OperationNotSupportedException - If the user authenticate operation is not supported

AuthenticationException - If user authentication failed

PasswordPolicyException - If there are any password policy errors

AuthorizationException - If user does not have sufficient privileges

resetPassword

public void resetPassword(java.security.Principal principal,
                          char[] password,
                          ModifyOptions opts)
                   throws OperationNotSupportedException,
                          EntityNotFoundException,
                          AuthorizationException,
                          PasswordPolicyException,
                          IDSException

This method should be implemented by any custom UserManager implementations to reset the user password

Overrides:

resetPassword in class UserManager

Parameters:

principal - Principal identifier of the user

password - User's new password

opts - Modify options

Throws:

IDSException - Generic Identity Directory Service exception

EntityNotFoundException - When this user is not found

OperationNotSupportedException - If the user authenticate operation is not supported

PasswordPolicyException - If there are any password policy errors

AuthorizationException - If user does not have sufficient privileges

resetPassword

public void resetPassword(java.lang.String id,
                          char[] password,
                          ModifyOptions opts)
                   throws OperationNotSupportedException,
                          EntityNotFoundException,
                          AuthorizationException,
                          PasswordPolicyException,
                          IDSException

This method should be implemented by any custom UserManager implementations to reset the user password

Overrides:

resetPassword in class UserManager

Parameters:

id - Id attribute value. ID attribute is defined in the entity configuration that uniquely identifies the user entity

password - User's new password

opts - Modify options

Throws:

IDSException - Generic Identity Directory Service exception

EntityNotFoundException - When this user is not found

OperationNotSupportedException - If the user authenticate operation is not supported

PasswordPolicyException - If there are any password policy errors

AuthorizationException - If user does not have sufficient privileges

resetPassword

public void resetPassword(java.lang.String attrName,
                          java.lang.String attrVal,
                          char[] password,
                          ModifyOptions opts)
                   throws OperationNotSupportedException,
                          EntityNotFoundException,
                          AuthorizationException,
                          PasswordPolicyException,
                          IDSException

This method should be implemented by any custom UserManager implementations to reset the user password

Overrides:

resetPassword in class UserManager

Parameters:

attrName - Name of the attribute that uniquely identifies the user

attrVal - Attribute value

password - User's new password

opts - Modify options

Throws:

IDSException - Generic Identity Directory Service exception

EntityNotFoundException - When this user is not found

OperationNotSupportedException - If the user authenticate operation is not supported

PasswordPolicyException - If there are any password policy errors

AuthorizationException - If user does not have sufficient privileges

getCapabilities

public UserCapabilities getCapabilities()

Get the capabilities for any user to run the following operations - Create, Read, Update , Delete. By default the user is set to be allowed all these operations, which can be changed.

Overrides:

getCapabilities in class UserManager

Returns:

A UserCapabilities object corresponding to the operations allowed for the user.

getEntityDef

public EntityDef getEntityDef()

Get the entity definition. The default EntitiesConfig is returned if not modified by the custom IdentityDirectory implementation.

Overrides:

getEntityDef in class AbstractEntityManager

Returns:

entity definitions for the entities.

getEntityAttributes

public java.util.List<java.lang.String> getEntityAttributes()

Get entity attributes from entity definition Return default attributes unless modified using the custom IdentityDirectory implementation.

Overrides:

getEntityAttributes in class AbstractEntityManager

Returns:

List of entity attributes.

getAttributeDef

public AttributeDef getAttributeDef(java.lang.String attrName)

Gets attribute definition for a given attribute name. Returns the default attribute definitions unless modified by the custom IdentityDirectory implementation.

Overrides:

getAttributeDef in class AbstractEntityManager

Parameters:

Name - of the attribute

Returns:

attribute definition

getAttributeRef

public AttributeRef getAttributeRef(java.lang.String attrName)

Gets entity attribute reference for given attribute name. Returns default values unless modified using the custom IdentityDirectory implementation.

Overrides:

getAttributeRef in class AbstractEntityManager

Parameters:

attrName - Name of the attribute

Returns:

entity attribute reference

getEntityRelationships

public java.util.List<EntityRelationship> getEntityRelationships()

Gets all entity relationships where current entity is part of the entity relationship definition

Overrides:

getEntityRelationships in class AbstractEntityManager

Returns:

list of entity relationship definitions

getIdAttribute

public java.lang.String getIdAttribute()

This method can be implemented to get the id attribute corresponding to a given entityName.

Overrides:

getIdAttribute in class AbstractEntityManager

Returns:

id attribute name

getGlobalCommonIdAttribute

public java.lang.String getGlobalCommonIdAttribute(java.lang.String entityName)

This method can be implemented to get the global common id attribute name configured in the entity definition, as required.

Overrides:

getGlobalCommonIdAttribute in class AbstractEntityManager

Returns:

global commond id attribute name

compareEntityAttr

public boolean compareEntityAttr(java.security.Principal principal,
                                 java.lang.String attrname,
                                 java.lang.String attrvalue)
                          throws IDSException,
                                 EntityNotFoundException,
                                 OperationNotSupportedException

This method can be implemented to provide a functionality to compared the attribute value for a particular attribute name.

Overrides:

compareEntityAttr in class AbstractEntityManager

Parameters:

principal - Is a Principal object cast of the user on which the compare operation is run.

attrname - Is the name of the attribute to compare.

attrvalue - Is the value of the attribute to be compared.

Returns:

A boolean value suggesting whether the given attribute value matches against the actual value or not.

Throws:

IDSException - Generic Identity Directory Service exception

EntityNotFoundException - When no user found for given ID value

OperationNotSupportedException - If the user authenticate operation is not supported

compareEntityAttr

public boolean compareEntityAttr(java.security.Principal principal,
                                 java.lang.String attrname,
                                 char[] attrvalue)
                          throws IDSException,
                                 EntityNotFoundException,
                                 OperationNotSupportedException

This method can be implemented compared the attribute value for a particular attribute name.The attribute value parameter is given in a character array, making this method suitable for comparing passwords and sensitive data.

Overrides:

compareEntityAttr in class AbstractEntityManager

Parameters:

principal - Is a Principal object cast of the user on which the compare operation is run.

attrname - Is the name of the attribute to compare.

attrvalue - Is the value of the attribute to be compared.

Returns:

A boolean value suggesting whether the given attribute value matches against the actual value or not.

Throws:

IDSException - Generic Identity Directory Service exception

EntityNotFoundException - When no user found for given ID value

OperationNotSupportedException - If the user authenticate operation is not supported

modify

public void modify(java.lang.String id,
                   java.util.List<ModAttribute> attrVals,
                   ModifyOptions opts)
            throws IDSException,
                   EntityNotFoundException,
                   OperationNotSupportedException,
                   AuthorizationException,
                   InvalidAttributesException

This method can be implemented to provide a functionality to modify the attributes of a user, identified by an id.

Overrides:

modify in class AbstractEntityManager

Parameters:

id - Is the id of the user for which the attributes have to be modified.

attrVals - Is a list of ModAttribute objects specifying the values of the attributes to be modified.

opts - Is a ModifyOptions object that can be used to specify the options related to this modify command.

Throws:

IDSException - Generic Identity Directory Service exception

EntityNotFoundException - When the entity to be modified is not found

OperationNotSupportedException - When this entity modify operation is not supported

InvalidAttributesException - When the mod attributes are invalid

AuthorizationException - If user does not have sufficient privileges

modify

public void modify(java.security.Principal principal,
                   java.util.List<ModAttribute> attrVals,
                   ModifyOptions opts)
            throws IDSException,
                   EntityNotFoundException,
                   OperationNotSupportedException,
                   AuthorizationException,
                   InvalidAttributesException

This method can be implemented to provide a functionality to modify the attributes of a user, identified by the Principal cast object of the user.

Overrides:

modify in class AbstractEntityManager

Parameters:

principal - Is the Principal cast object of the user for which the attributes have to be modified.

attrVals - Is a list of ModAttribute objects specifying the values of the attributes to be modified.

opts - Is a ModifyOptions object that can be used to specify the options related to this modify command,

Throws:

IDSException - Generic Identity Directory Service exception

EntityNotFoundException - When the entity to be modified is not found

OperationNotSupportedException - When this entity modify operation is not supported

InvalidAttributesException - When the mod attributes are invalid

AuthorizationException - If user does not have sufficient privileges

modify

public void modify(java.lang.String attrName,
                   java.lang.String attrVal,
                   java.util.List<ModAttribute> attrVals,
                   ModifyOptions opts)
            throws IDSException,
                   EntityNotFoundException,
                   OperationNotSupportedException,
                   AuthorizationException,
                   InvalidAttributesException

This method can be implemented to provide a functionality to modify the attributes of a user, identified by an attribute value matching an attribute name

Overrides:

modify in class AbstractEntityManager

Parameters:

attrName - Is the name of the attribute used for matching.

attrVal - Is the value used for matching the attribute given as attrName.

attrVals - Is a list of ModAttribute objects specifying the values of the attributes to be modified.

opts - Is a ModifyOptions object that can be used to specify the options related to this modify command.

Throws:

IDSException - Generic Identity Directory Service exception

EntityNotFoundException - When the entity to be modified is not found

OperationNotSupportedException - When this entity modify operation is not supported

InvalidAttributesException - When the mod attributes are invalid

AuthorizationException - If user does not have sufficient privileges

rename

public void rename(java.security.Principal principal,
                   java.lang.String newName,
                   java.lang.String newContainer,
                   ModifyOptions opts)
            throws IDSException,
                   EntityNotFoundException,
                   OperationNotSupportedException,
                   AuthorizationException,
                   InvalidAttributesException

This method can be implemented to provide a functionality to rename a user, identified by the Principal cast object of the user.

Overrides:

rename in class AbstractEntityManager

Parameters:

principal - Is the Principal cast object of the user to rename.

newName - Is the new name of the user, to be set.

newContainer - Is the new Container of the user, to be set.

opts - Is a ModifyOptions object that can be used to specify the options related to this modify command.

Throws:

IDSException - Generic Identity Directory Service exception

EntityNotFoundException - When the entity to be modified is not found

OperationNotSupportedException - When this entity modify operation is not supported

InvalidAttributesException - When the mod attributes are invalid

AuthorizationException - If user does not have sufficient privileges