public class AppRoleManager extends EntityManager
Constructor and Description |
---|
AppRoleManager(IdentityDirectory ids, java.lang.String entityName) |
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> |
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.
|
getCapabilities, getEntity, getEntityName
compareEntityAttr, compareEntityAttr, getAttributeDef, getAttributeRef, getEntityAttributes, getEntityDef, getEntityRelationships, getGlobalCommonIdAttribute, getIdAttribute
public AppRoleManager(IdentityDirectory ids, java.lang.String entityName)
public ResultSet<AppRole> searchAppRoles(SearchFilter filter, SearchOptions opts) throws InvalidFilterException, IDSException, OperationNotSupportedException, AuthorizationException, InvalidAttributesException
filter
- filter to be usedopts
- Search options to useInvalidFilterException
IDSException
OperationNotSupportedException
AuthorizationException
InvalidAttributesException
public ResultSet<AppRole> getUserMemberOfAppRoles(java.lang.String userGUID, SearchFilter filter, SearchOptions opts) throws InvalidFilterException, IDSException, OperationNotSupportedException, AuthorizationException, InvalidAttributesException
userGUID
- GUID of userfilter
- filter to be usedopts
- Search options to useInvalidFilterException
IDSException
OperationNotSupportedException
AuthorizationException
InvalidAttributesException
public ResultSet<User> getAppRoleMembers(java.lang.String appRoleDisplayName, java.lang.String appName, SearchFilter filter, SearchOptions opts) throws InvalidFilterException, IDSException, OperationNotSupportedException, AuthorizationException, InvalidAttributesException
appRoleDisplayName
- appRole display nameappName
- app namefilter
- filter to be usedopts
- search optionsInvalidFilterException
IDSException
OperationNotSupportedException
AuthorizationException
InvalidAttributesException
public ResultSet<User> getAppRoleMembers(java.lang.String appRoleDisplayName, java.lang.String appName, SearchFilter filter, SearchOptions opts, boolean directMembersOnly) throws InvalidFilterException, IDSException, OperationNotSupportedException, AuthorizationException, InvalidAttributesException
appRoleDisplayName
- appRole display nameappName
- app namefilter
- filter to be usedopts
- search optionsdirectMembersOnly
- flag which indicates direct or indirect users when querying specified app roleInvalidFilterException
IDSException
OperationNotSupportedException
AuthorizationException
InvalidAttributesException
public ResultSet<Group> getAppRoleGroupMembers(java.lang.String appRoleDisplayName, java.lang.String appName, SearchFilter filter, SearchOptions opts, boolean directMembersOnly) throws InvalidFilterException, IDSException, OperationNotSupportedException, AuthorizationException, InvalidAttributesException
appRoleDisplayName
- app role display nameappName
- app role namefilter
- filter to be appliedopts
- search optionsdirectMembersOnly
- flag which indicates direct or indirect groups when querying specified app roleInvalidFilterException
IDSException
OperationNotSupportedException
AuthorizationException
InvalidAttributesException
public Entity searchEntity(java.lang.String id, ReadOptions opts) throws EntityNotFoundException, EntityNotUniqueException, IDSException, AuthorizationException, InvalidAttributesException
searchEntity
in class EntityManager
id
- Value of the entity's id attributeopts
- Read operation optionsOperationNotSupportedException
- Always thrown, since this method is not supported.EntityNotFoundException
- When there is no entity found for given ID valueEntityNotUniqueException
- When the given filter condition does not uniquely identify the entityIDSException
- Generic Identity Directory Service exceptionInvalidAttributesException
- If the requested attributes is invalidAuthorizationException
- If user does not have sufficient privilegespublic Entity searchEntity(java.lang.String attrName, java.lang.String attrVal, ReadOptions opts) throws EntityNotFoundException, EntityNotUniqueException, InvalidFilterException, IDSException, AuthorizationException, InvalidAttributesException
searchEntity
in class EntityManager
attrName
- Name of the attributeattrVal
- Attribute valueopts
- Read operation optionsOperationNotSupportedException
- Always thrown, since this method is not supported.EntityNotFoundException
- When no entity found for given search filterEntityNotUniqueException
- When the given filter condition does not uniquely identify the entityInvalidFilterException
- If the attribute is invalid filter attributeIDSException
- Generic Identity Directory Service exceptionInvalidAttributesException
- If the requested attributes is invalidAuthorizationException
- If user does not have sufficient privilegespublic Entity searchEntityByGuid(java.lang.String guid, ReadOptions opts) throws IDSException, EntityNotFoundException, EntityNotUniqueException, AuthorizationException, InvalidAttributesException
searchEntityByGuid
in class EntityManager
guid
- guid value of entityopts
- Read operation optionsOperationNotSupportedException
- Always thrown, since this method is not supported.IDSException
- Generic Identity Directory Service exceptionEntityNotFoundException
- When there is no entity found for given GUID valueEntityNotUniqueException
- When the given GUID values does not uniquely identify the entityInvalidAttributesException
- If the requested attributes is invalidAuthorizationException
- If user does not have sufficient privilegespublic java.security.Principal createEntity(java.util.List<Attribute> attrVals, CreateOptions opts) throws EntityAlreadyExistsException, IDSException, InvalidAttributesException, AuthorizationException, OperationNotSupportedException
createEntity
in class EntityManager
attrVals
- List of attribute valuesopts
- Create operation optionsOperationNotSupportedException
- Always thrown, since this method is not supported.IDSException
- Generic Identity Directory Service exceptionEntityNotUniqueException
- When the entity to be created already existsInvalidAttributesException
- When the add attributes list is invalidAuthorizationException
- If user does not have sufficient privilegesEntityAlreadyExistsException
public void deleteEntity(java.security.Principal principal, DeleteOptions opts) throws EntityNotFoundException, IDSException, AuthorizationException, OperationNotSupportedException
deleteEntity
in class EntityManager
principal
- Entity principalopts
- Delete operation optionsOperationNotSupportedException
- Always thrown, since this method is not supported.EntityNotFoundException
- When there is no entity in the repository for given entity principalIDSException
- Generic Identity Directory Service exceptionAuthorizationException
- If user does not have sufficient privilegespublic void deleteEntity(java.lang.String id, DeleteOptions opts) throws EntityNotFoundException, IDSException, AuthorizationException, OperationNotSupportedException
deleteEntity
in class EntityManager
id
- id valueopts
- Delete operation optionsOperationNotSupportedException
- Always thrown, since this method is not supported.EntityNotFoundException
- When there is no entity in the repository for given id valueIDSException
- Generic Identity Directory Service exceptionAuthorizationException
- If user does not have sufficient privilegespublic void deleteEntity(java.lang.String attrName, java.lang.String attrVal, DeleteOptions opts) throws EntityNotFoundException, IDSException, AuthorizationException, OperationNotSupportedException
deleteEntity
in class EntityManager
attrName
- Name of the attributeattrVal
- Attribute valueopts
- Delete operation optionsOperationNotSupportedException
- Always thrown, since this method is not supported.EntityNotFoundException
- When there is no entity in the repository for given entity principalIDSException
- Generic Identity Directory Service exceptionAuthorizationException
- If user does not have sufficient privilegespublic ResultSet<Entity> searchEntities(SearchFilter filter, SearchOptions opts) throws InvalidFilterException, IDSException, OperationNotSupportedException, AuthorizationException, InvalidAttributesException
searchEntities
in class EntityManager
filter
- Search filteropts
- Search operation optionsOperationNotSupportedException
- Always thrown, since this method is not supported.InvalidFilterException
- When the input search filter is not validIDSException
- Generic Identity Directory Service exceptionInvalidAttributesException
- When the requested attributes or the attributes in the search filter are invalidAuthorizationException
- If user does not have sufficient privilegespublic void modify(java.lang.String id, java.util.List<ModAttribute> attrVals, ModifyOptions opts) throws IDSException, EntityNotFoundException, OperationNotSupportedException, AuthorizationException, InvalidAttributesException
modify
in class AbstractEntityManager
id
- Value of the entity's id attributeattrVals
- List of mod attribute valuesopts
- Modify operation optionsOperationNotSupportedException
- Always thrown, since this method is not supported.IDSException
- Generic Identity Directory Service exceptionEntityNotFoundException
- When the entity to be modified is not foundInvalidAttributesException
- When the mod attributes are invalidAuthorizationException
- If user does not have sufficient privilegespublic void modify(java.security.Principal principal, java.util.List<ModAttribute> attrVals, ModifyOptions opts) throws IDSException, EntityNotFoundException, OperationNotSupportedException, AuthorizationException, InvalidAttributesException
modify
in class AbstractEntityManager
principal
- Principal identifier of the entityattrVals
- List of mod attribute valuesopts
- Modify operation optionsOperationNotSupportedException
- Always thrown, since this method is not supported.IDSException
- Generic Identity Directory Service exceptionEntityNotFoundException
- When the entity to be modified is not foundInvalidAttributesException
- When the mod attributes are invalidAuthorizationException
- If user does not have sufficient privilegespublic void modify(java.lang.String attrName, java.lang.String attrVal, java.util.List<ModAttribute> attrVals, ModifyOptions opts) throws IDSException, EntityNotFoundException, OperationNotSupportedException, AuthorizationException, InvalidAttributesException
modify
in class AbstractEntityManager
attrName
- Name of the unique attributeattrVal
- Attribute valueattrVals
- List of mod attribute valuesopts
- Modify operation optionsOperationNotSupportedException
- Always thrown, since this method is not supported.IDSException
- Generic Identity Directory Service exceptionEntityNotFoundException
- When the entity to be modified is not foundInvalidAttributesException
- When the mod attributes are invalidAuthorizationException
- If user does not have sufficient privilegespublic void rename(java.security.Principal principal, java.lang.String newName, java.lang.String newContainer, ModifyOptions opts) throws IDSException, EntityNotFoundException, OperationNotSupportedException, AuthorizationException, InvalidAttributesException
rename
in class AbstractEntityManager
principal
- Principal identifier of the entitynewName
- 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.OperationNotSupportedException
- Always thrown, since this method is not supported.IDSException
- Generic Identity Directory Service exceptionEntityNotFoundException
- When the entity to be modified is not foundInvalidAttributesException
- When the mod attributes are invalidAuthorizationException
- If user does not have sufficient privileges