oracle.igf.ids

Class AppRoleManager

java.lang.Object

oracle.igf.ids.AbstractEntityManager

oracle.igf.ids.EntityManager

oracle.igf.ids.AppRoleManager

public class AppRoleManager
extends EntityManager

Class to get the operations on AppRole

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
java.security.Principal	createEntity(java.util.List<Attribute> attrVals, CreateOptions opts) This method is not supported for AppRole entities.
void	deleteEntity(java.security.Principal principal, DeleteOptions opts) This method is not supported for AppRole entities.
void	deleteEntity(java.lang.String id, DeleteOptions opts) This method is not supported for AppRole entities.
void	deleteEntity(java.lang.String attrName, java.lang.String attrVal, DeleteOptions opts) This method is not supported for AppRole entities.
ResultSet<Group>	getAppRoleGroupMembers(java.lang.String appRoleDisplayName, java.lang.String appName, SearchFilter filter, SearchOptions opts, boolean directMembersOnly) Get approle group members This method should only be used to get groups of specified approle
ResultSet<User>	getAppRoleMembers(java.lang.String appRoleDisplayName, java.lang.String appName, SearchFilter filter, SearchOptions opts) Get Direct and Indirect AppRole members This method should be only used to get users of specified approle
ResultSet<User>	getAppRoleMembers(java.lang.String appRoleDisplayName, java.lang.String appName, SearchFilter filter, SearchOptions opts, boolean directMembersOnly) Get AppRole members This method should be only used to get users of specified approle
ResultSet<AppRole>	getAppRoleMembershipsOfUser(java.lang.String userGUID, boolean directMembershipsOnly, SearchOptions opts) Get the list of AppRoles for which the given user is a member of.
ResultSet<AppRole>	getUserMemberOfAppRoles(java.lang.String userGUID, SearchFilter filter, SearchOptions opts) Get AppRole members
void	modify(java.security.Principal principal, java.util.List<ModAttribute> attrVals, ModifyOptions opts) This method is not supported for AppRole entities.
void	modify(java.lang.String id, java.util.List<ModAttribute> attrVals, ModifyOptions opts) This method is not supported for AppRole entities.
void	modify(java.lang.String attrName, java.lang.String attrVal, java.util.List<ModAttribute> attrVals, ModifyOptions opts) This method is not supported for AppRole entities.
void	rename(java.security.Principal principal, java.lang.String newName, java.lang.String newContainer, ModifyOptions opts) This method is not supported for AppRole entities.
ResultSet<AppRole>	searchAppRoles(SearchFilter filter, SearchOptions opts) Search AppRole based on the provided filter and search options
ResultSet<Entity>	searchEntities(SearchFilter filter, SearchOptions opts) This method is not supported for AppRole entities.
Entity	searchEntity(java.lang.String id, ReadOptions opts) This method is not supported for AppRole entities.
Entity	searchEntity(java.lang.String attrName, java.lang.String attrVal, ReadOptions opts) This method is not supported for AppRole entities.
Entity	searchEntityByGuid(java.lang.String guid, ReadOptions opts) This method is not supported for AppRole entities.

Methods inherited from class oracle.igf.ids.EntityManager

getCapabilities, getEntity, getEntityName

Methods inherited from class oracle.igf.ids.AbstractEntityManager

compareEntityAttr, compareEntityAttr, getAttributeDef, getAttributeRef, getEntityAttributes, getEntityDef, getEntityRelationships, getGlobalCommonIdAttribute, getIdAttribute

Methods inherited from class java.lang.Object

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

Constructor Detail

AppRoleManager

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

Method Detail

searchAppRoles

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

Search AppRole based on the provided filter and search options

Parameters:

filter - filter to be used

opts - Search options to use

Returns:

List of AppRoles

Throws:

InvalidFilterException

IDSException

OperationNotSupportedException

AuthorizationException

InvalidAttributesException

getUserMemberOfAppRoles

public ResultSet<AppRole> getUserMemberOfAppRoles(java.lang.String userGUID,
                                                  SearchFilter filter,
                                                  SearchOptions opts)
                                           throws InvalidFilterException,
                                                  IDSException,
                                                  OperationNotSupportedException,
                                                  AuthorizationException,
                                                  InvalidAttributesException

Get AppRole members

Parameters:

userGUID - GUID of user

filter - filter to be used

opts - Search options to use

Returns:

List of AppRoles

Throws:

InvalidFilterException

IDSException

OperationNotSupportedException

AuthorizationException

InvalidAttributesException

getAppRoleMembershipsOfUser

public ResultSet<AppRole> getAppRoleMembershipsOfUser(java.lang.String userGUID,
                                                      boolean directMembershipsOnly,
                                                      SearchOptions opts)
                                               throws InvalidFilterException,
                                                      OperationNotSupportedException,
                                                      InvalidAttributesException,
                                                      IDSException

Get the list of AppRoles for which the given user is a member of.

Parameters:

userGUID - GUID of user

directMembershipsOnly - If true, then return only AppRoles of which the specified user is a direct member. Other wise return AppRoles of which the specified user is either a direct member or an indirect member.

opts - Search options to use

Returns:

List of AppRoles of which the specified user is a member.

Throws:

InvalidFilterException

OperationNotSupportedException

InvalidAttributesException

IDSException

getAppRoleMembers

public ResultSet<User> getAppRoleMembers(java.lang.String appRoleDisplayName,
                                         java.lang.String appName,
                                         SearchFilter filter,
                                         SearchOptions opts)
                                  throws InvalidFilterException,
                                         IDSException,
                                         OperationNotSupportedException,
                                         AuthorizationException,
                                         InvalidAttributesException

Get Direct and Indirect AppRole members This method should be only used to get users of specified approle

Parameters:

appRoleDisplayName - appRole display name

appName - app name

filter - filter to be used

opts - search options

Returns:

List of users

Throws:

InvalidFilterException

IDSException

OperationNotSupportedException

AuthorizationException

InvalidAttributesException

getAppRoleMembers

public ResultSet<User> getAppRoleMembers(java.lang.String appRoleDisplayName,
                                         java.lang.String appName,
                                         SearchFilter filter,
                                         SearchOptions opts,
                                         boolean directMembersOnly)
                                  throws InvalidFilterException,
                                         IDSException,
                                         OperationNotSupportedException,
                                         AuthorizationException,
                                         InvalidAttributesException

Get AppRole members This method should be only used to get users of specified approle

Parameters:

appRoleDisplayName - appRole display name

appName - app name

filter - filter to be used

opts - search options

directMembersOnly - flag which indicates direct or indirect users when querying specified app role

Returns:

List of users

Throws:

InvalidFilterException

IDSException

OperationNotSupportedException

AuthorizationException

InvalidAttributesException

getAppRoleGroupMembers

public ResultSet<Group> getAppRoleGroupMembers(java.lang.String appRoleDisplayName,
                                               java.lang.String appName,
                                               SearchFilter filter,
                                               SearchOptions opts,
                                               boolean directMembersOnly)
                                        throws InvalidFilterException,
                                               IDSException,
                                               OperationNotSupportedException,
                                               AuthorizationException,
                                               InvalidAttributesException

Get approle group members This method should only be used to get groups of specified approle

Parameters:

appRoleDisplayName - app role display name

appName - app role name

filter - filter to be applied

opts - search options

directMembersOnly - flag which indicates direct or indirect groups when querying specified app role

Returns:

Resultset of groups

Throws:

InvalidFilterException

IDSException

OperationNotSupportedException

AuthorizationException

InvalidAttributesException

searchEntity

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

This method is not supported for AppRole entities.

Overrides:

searchEntity in class EntityManager

Parameters:

id - Value of the entity's id attribute

opts - Read operation options

Returns:

Entity matching given ID value

Throws:

OperationNotSupportedException - Always thrown, since this method is not supported.

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

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

IDSException - Generic Identity Directory Service exception

InvalidAttributesException - If the requested attributes is invalid

AuthorizationException - If user does not have sufficient privileges

searchEntity

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

This method is not supported for AppRole entities.

Overrides:

searchEntity in class EntityManager

Parameters:

attrName - Name of the attribute

attrVal - Attribute value

opts - Read operation options

Returns:

Entity matching given search filter

Throws:

OperationNotSupportedException - Always thrown, since this method is not supported.

EntityNotFoundException - When no entity found for given search filter

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

InvalidFilterException - If the attribute is invalid filter attribute

IDSException - Generic Identity Directory Service exception

InvalidAttributesException - If the requested attributes is invalid

AuthorizationException - If user does not have sufficient privileges

searchEntityByGuid

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

This method is not supported for AppRole entities.

Overrides:

searchEntityByGuid in class EntityManager

Parameters:

guid - guid value of entity

opts - Read operation options

Returns:

Entity matching given GUID value

Throws:

OperationNotSupportedException - Always thrown, since this method is not supported.

IDSException - Generic Identity Directory Service exception

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

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

InvalidAttributesException - If the requested attributes is invalid

AuthorizationException - If user does not have sufficient privileges

createEntity

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

This method is not supported for AppRole entities.

Overrides:

createEntity in class EntityManager

Parameters:

attrVals - List of attribute values

opts - Create operation options

Returns:

Principal identifier of the entity created

Throws:

OperationNotSupportedException - Always thrown, since this method is not supported.

IDSException - Generic Identity Directory Service exception

EntityNotUniqueException - When the entity to be created already exists

InvalidAttributesException - When the add attributes list is invalid

AuthorizationException - If user does not have sufficient privileges

EntityAlreadyExistsException

deleteEntity

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

This method is not supported for AppRole entities.

Overrides:

deleteEntity in class EntityManager

Parameters:

principal - Entity principal

opts - Delete operation options

Throws:

OperationNotSupportedException - Always thrown, since this method is not supported.

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

IDSException - Generic Identity Directory Service exception

AuthorizationException - If user does not have sufficient privileges

deleteEntity

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

This method is not supported for AppRole entities.

Overrides:

deleteEntity in class EntityManager

Parameters:

id - id value

opts - Delete operation options

Throws:

OperationNotSupportedException - Always thrown, since this method is not supported.

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

IDSException - Generic Identity Directory Service exception

AuthorizationException - If user does not have sufficient privileges

deleteEntity

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

This method is not supported for AppRole entities.

Overrides:

deleteEntity in class EntityManager

Parameters:

attrName - Name of the attribute

attrVal - Attribute value

opts - Delete operation options

Throws:

OperationNotSupportedException - Always thrown, since this method is not supported.

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

IDSException - Generic Identity Directory Service exception

AuthorizationException - If user does not have sufficient privileges

searchEntities

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

This method is not supported for AppRole entities.

Overrides:

searchEntities in class EntityManager

Parameters:

filter - Search filter

opts - Search operation options

Returns:

Search results matching given filter

Throws:

OperationNotSupportedException - Always thrown, since this method is not supported.

InvalidFilterException - When the input search filter is not valid

IDSException - Generic Identity Directory Service exception

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

AuthorizationException - If user does not have sufficient privileges

modify

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

This method is not supported for AppRole entities.

Overrides:

modify in class AbstractEntityManager

Parameters:

id - Value of the entity's id attribute

attrVals - List of mod attribute values

opts - Modify operation options

Throws:

OperationNotSupportedException - Always thrown, since this method is not supported.

IDSException - Generic Identity Directory Service exception

EntityNotFoundException - When the entity to be modified is not found

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 is not supported for AppRole entities.

Overrides:

modify in class AbstractEntityManager

Parameters:

principal - Principal identifier of the entity

attrVals - List of mod attribute values

opts - Modify operation options

Throws:

OperationNotSupportedException - Always thrown, since this method is not supported.

IDSException - Generic Identity Directory Service exception

EntityNotFoundException - When the entity to be modified is not found

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 is not supported for AppRole entities.

Overrides:

modify in class AbstractEntityManager

Parameters:

attrName - Name of the unique attribute

attrVal - Attribute value

attrVals - List of mod attribute values

opts - Modify operation options

Throws:

OperationNotSupportedException - Always thrown, since this method is not supported.

IDSException - Generic Identity Directory Service exception

EntityNotFoundException - When the entity to be modified is not found

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 is not supported for AppRole entities.

Overrides:

rename in class AbstractEntityManager

Parameters:

principal - Principal identifier of the entity

newName - new name value. If the entity is moved under different container keeping the name same then the newName should be same as old name value.

newContainer - new container where this entity is moved under. If this is just name change then this can be null.

Throws:

OperationNotSupportedException - Always thrown, since this method is not supported.

IDSException - Generic Identity Directory Service exception

EntityNotFoundException - When the entity to be modified is not found

InvalidAttributesException - When the mod attributes are invalid

AuthorizationException - If user does not have sufficient privileges