oracle.igf.ids

Class CustomGroupManager

java.lang.Object

oracle.igf.ids.AbstractEntityManager

oracle.igf.ids.GroupManager

oracle.igf.ids.CustomGroupManager

public abstract class CustomGroupManager
extends GroupManager

This abstract class acts as a bridge between any custom implementations of the GroupManager object and the default GroupManager class. All custom implementations of GroupManager must extend this class and use it to get the custom GroupManager implementation using the custom IdentityDirectory implementation. This class provides methods which can be implemented by custom GroupManager implementations to handle operations like read, create and search of group entity

Constructor Summary

Constructors

Constructor and Description
CustomGroupManager(IdentityDirectory ids, java.lang.String entityName) This is the constructor any custom GroupManager must use to get the GroupManager object instance.

Method Summary

Modifier and Type	Method and Description
boolean	compareEntityAttr(java.security.Principal principal, java.lang.String attrname, char[] attrvalue) This method can be implemented to provide a functionality to compared the attribute value for a particular attribute name.
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	createGroup(java.util.List<Attribute> attrVals, CreateOptions opts) This method should be implemented by any custom GroupManager implementations to create group in the repository with given list of attribute values
void	deleteGroup(java.security.Principal principal, DeleteOptions opts) This method should be implemented by any custom GroupManager implementations to deletes the group from the repository for given user principal.
void	deleteGroup(java.lang.String id, DeleteOptions opts) This method should be implemented by any custom GroupManager implementations to delete the group from the repository for a given id attribute value
void	deleteGroup(java.lang.String attrName, java.lang.String attrVal, DeleteOptions opts) This method should be implemented by any custom GroupManagaer implementations to deletes the group from the repository for the 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.
EntityCapabilities	getCapabilities() This method is used to get the capabilities for any group 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() Returns 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.
Group	getGroup(java.security.Principal principal, ReadOptions opts) This method should be implemented by any custom GroupManager implementations to get the group for the given principal identifier
java.lang.String	getIdAttribute() This method can be implemented to get the id attribute corresponding to a given entityName.
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 group, identified by the Principal cast object of the group.
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 group, 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 group, 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 group, identified by the Principal cast object of the group.
Group	searchGroup(java.lang.String id, ReadOptions opts) This method should be implemented by any custom GroupManager implementations to search for group matching given id attribute value that uniquely identifies the user
Group	searchGroup(java.lang.String attrName, java.lang.String attrVal, ReadOptions opts) This method should be implemented by any custom GroupManager implementations to find a group matching given attribute name and value
Group	searchGroupByGuid(java.lang.String guid, ReadOptions opts) This method should be implemented by any custom GroupManager implementations to search for a group matching given GUID value that uniquely identifies the group
ResultSet<Group>	searchGroups(SearchFilter filter, SearchOptions opts) This method should be implemented by any custom GroupManager implementations to search the repository and returns list of group matching the given filter condition .Pagesize, Sorting and other options can be specified in the search options.

Methods inherited from class java.lang.Object

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

Constructor Detail

CustomGroupManager

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

This is the constructor any custom GroupManager must use to get the GroupManager object instance.

Parameters:

ids - Is the IdentityDirectory object which uses the custom Group Manager implementation

entityName - Is the entityName with which this custom GroupManager implementation is related.

Method Detail

createGroup

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

This method should be implemented by any custom GroupManager implementations to create group in the repository with given list of attribute values

Overrides:

createGroup in class GroupManager

Parameters:

attrVals - List of attribute values

opts - Create operation options

Returns:

Principal identifier of the group created

Throws:

IDSException - Generic Identity Directory Service exception

EntityAlreadyExistsException - When the group to be created already exists

OperationNotSupportedException - If the group create operation is not supported

InvalidAttributesException - When the add attributes list is invalid

AuthorizationException - If user does not have sufficient privileges

getGroup

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

This method should be implemented by any custom GroupManager implementations to get the group for the given principal identifier

Overrides:

getGroup in class GroupManager

Parameters:

principal - Principal identifier of the group

opts - Read operation options

Returns:

Group for the requested principal identifier

Throws:

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

IDSException - Generic Identity Directory Service exception

InvalidAttributesException - If the requested attributes is invalid

AuthorizationException - If user does not have sufficient privileges

searchGroup

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

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

Overrides:

searchGroup in class GroupManager

Parameters:

id - Value of the group's id attribute

opts - Read operation options

Returns:

Group matching given ID value

Throws:

IDSException - Generic Identity Directory Service exception

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

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

InvalidAttributesException - If the requested attributes is invalid

AuthorizationException - If user does not have sufficient privileges

searchGroup

public Group searchGroup(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 GroupManager implementations to find a group matching given attribute name and value

Overrides:

searchGroup in class GroupManager

Parameters:

attrName - Name of the attribute

attrVal - Attribute value

opts - Read operation options

Returns:

Group matching given search filter

Throws:

IDSException - Generic Identity Directory Service exception

EntityNotFoundException - When no group found for given search filter

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

InvalidFilterException - If the attribute is invalid filter attribute

InvalidAttributesException - If the requested attributes is invalid

AuthorizationException - If user does not have sufficient privileges

searchGroupByGuid

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

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

Overrides:

searchGroupByGuid in class GroupManager

Parameters:

guid - guid value of group

opts - Read operation options

Returns:

Group matching given GUID value

Throws:

IDSException - Generic Identity Directory Service exception

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

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

InvalidAttributesException - If the requested attributes is invalid

AuthorizationException - If user does not have sufficient privileges

searchGroups

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

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

Overrides:

searchGroups in class GroupManager

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

deleteGroup

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

This method should be implemented by any custom GroupManager implementations to deletes the group from the repository for given user principal.

Overrides:

deleteGroup in class GroupManager

Parameters:

principal - Group principal

opts - Delete operation options

Throws:

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

IDSException - Generic Identity Directory Service exception

OperationNotSupportedException - If the group delete operation is not supported

AuthorizationException - If user does not have sufficient privileges

deleteGroup

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

This method should be implemented by any custom GroupManager implementations to delete the group from the repository for a given id attribute value

Overrides:

deleteGroup in class GroupManager

Parameters:

id - id value

opts - Delete operation options

Throws:

EntityNotFoundException - When there is no group in the repository for given id value

IDSException - Generic Identity Directory Service exception

OperationNotSupportedException - If the group delete operation is not supported

AuthorizationException - If user does not have sufficient privileges

deleteGroup

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

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

Overrides:

deleteGroup in class GroupManager

Parameters:

attrName - Name of the attribute

attrVal - Attribute value

opts - Delete operation options

Throws:

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

IDSException - Generic Identity Directory Service exception

OperationNotSupportedException - If the group delete operation is not supported

AuthorizationException - If user does not have sufficient privileges

getCapabilities

public EntityCapabilities getCapabilities()

This method is used to get the capabilities for any group to run the following operations - Create, Read, Update , Delete. By default the group is set to be allowed to run all these operations. This modifiable method can be extended to change the default behaviour, if required.

Overrides:

getCapabilities in class GroupManager

Returns:

A EntitiyCapabilities object corresponding to the operations allowed for the group.

getEntityDef

public EntityDef getEntityDef()

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

Overrides:

getEntityDef in class AbstractEntityManager

Returns:

entity definition

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 group 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 to provide a functionality to 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 group 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 group, identified by an id.

Overrides:

modify in class AbstractEntityManager

Parameters:

id - Is the id of the group 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 group, identified by the Principal cast object of the group.

Overrides:

modify in class AbstractEntityManager

Parameters:

principal - Is the Principal cast object of the group 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 group, 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 group, identified by the Principal cast object of the group.

Overrides:

rename in class AbstractEntityManager

Parameters:

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

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

newContainer - Is the new Container of the group, 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