RoleManager (Oracle® Fusion Middleware Java API Reference for Identity Governance Framework UserRole)

java.lang.Object
- org.openliberty.arisidbeans.IGFObjectManager
- - oracle.igf.userrole.RoleManager

```
public class RoleManager
extends IGFObjectManager
```
This RoleManager class generated from CARML file userrole.xml has methods corresponding to the interactions defined in the CARML file.

Constructor Summary

Constructors
Constructor and Description
`RoleManager()` RoleManager default Constructor.
`RoleManager(java.util.Map<java.lang.String,java.lang.Object> properties)` RoleManager is initialized with the CARML file, userrole.xml
`RoleManager(java.lang.String carmlFile, java.util.Map<java.lang.String,java.lang.Object> properties)` RoleManager constructor initialized with given CARML file
`RoleManager(java.net.URI carmlLoc, java.util.Map<java.lang.String,java.lang.Object> properties)` RoleManager constructor initialized with given CARML URI

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`IPrincipalIdentifier`	`createRole(java.util.List<PropertyValue> attrVals)`
`IPrincipalIdentifier`	`createRole(java.util.List<PropertyValue> attrVals, java.util.Map<java.lang.String,java.lang.Object> appCtxMap)` Creates new Role Creates Role for given list of attributes.
`void`	`dropRole(IPrincipalIdentifier principal)`
`void`	`dropRole(IPrincipalIdentifier principal, java.util.Map<java.lang.String,java.lang.Object> appCtxMap)` Delete Role Deletes the Role from Attribute Authority for a given principal identifier
`void`	`dropRole(Role subj)`
`void`	`dropRole(Role subj, java.util.Map<java.lang.String,java.lang.Object> appCtxMap)` Delete Role Deletes the Role from Attribute Authority
`boolean`	`exists(Role subj)`
`boolean`	`exists(Role subj, java.util.Map<java.lang.String,java.lang.Object> appCtxMap)` Returns true if the Role exists in Attribute Authority
`static java.lang.String`	`getDefaultCarmlFile()` Get Default CARML declaration file
`java.util.List<Role>`	`getGrantedRoles(Role role, int nLevels)`
`java.util.List<Role>`	`getGrantedRoles(Role role, int nLevels, java.util.Map<java.lang.String,java.lang.Object> appCtxMap)` Get granted roles of a member
`java.util.List<Role>`	`getGrantedRoles(User user, int nLevels)`
`java.util.List<Role>`	`getGrantedRoles(User user, int nLevels, java.util.Map<java.lang.String,java.lang.Object> appCtxMap)` Get granted roles of a member
`java.util.List<java.lang.String>`	`getGranteeNames(Role role, int nLevels)`
`java.util.List<java.lang.String>`	`getGranteeNames(Role role, int nLevels, java.util.Map<java.lang.String,java.lang.Object> appCtxMap)` Get member names of a role
`java.util.List<User>`	`getGrantees(Role role, int nLevels, UserManager usermanager)`
`java.util.List<User>`	`getGrantees(Role role, int nLevels, UserManager usermanager, java.util.Map<java.lang.String,java.lang.Object> appCtxMap)` Get members of a role
`java.util.List<Role>`	`getManagedRoles(Role role, int nLevels)`
`java.util.List<Role>`	`getManagedRoles(Role role, int nLevels, java.util.Map<java.lang.String,java.lang.Object> appCtxMap)` Get owned roles of an user/role
`java.util.List<Role>`	`getManagedRoles(User user, int nLevels)`
`java.util.List<Role>`	`getManagedRoles(User user, int nLevels, java.util.Map<java.lang.String,java.lang.Object> appCtxMap)` Get owned roles of an user/role
`java.util.List<User>`	`getManagers(Role role, int nLevels, UserManager usermanager)`
`java.util.List<User>`	`getManagers(Role role, int nLevels, UserManager usermanager, java.util.Map<java.lang.String,java.lang.Object> appCtxMap)` Get managers of a role
`java.util.List<java.lang.Object>`	`getMembersandRoles(Role role, int nLevels, UserManager usermanager)`
`java.util.List<java.lang.Object>`	`getMembersandRoles(Role role, int nLevels, UserManager usermanager, java.util.Map<java.lang.String,java.lang.Object> appCtxMap)` Get members and subroles of a role
`java.util.List<Role>`	`getOwnedRoles(Role role, int nLevels)`
`java.util.List<Role>`	`getOwnedRoles(Role role, int nLevels, java.util.Map<java.lang.String,java.lang.Object> appCtxMap)` Get owned roles of an user/role
`java.util.List<Role>`	`getOwnedRoles(User user, int nLevels)`
`java.util.List<Role>`	`getOwnedRoles(User user, int nLevels, java.util.Map<java.lang.String,java.lang.Object> appCtxMap)` Get owned roles of an user/role
`java.util.List<User>`	`getOwners(Role role, int nLevels, UserManager usermanager)`
`java.util.List<User>`	`getOwners(Role role, int nLevels, UserManager usermanager, java.util.Map<java.lang.String,java.lang.Object> appCtxMap)` Get owners of a role
`Role`	`getRole(javax.servlet.http.HttpServletRequest request)`
`Role`	`getRole(javax.servlet.http.HttpServletRequest request, java.util.Map<java.lang.String,java.lang.Object> appCtxMap)` get role profile Retrieves Role from Attribute Authority for a given HTTPServletRequest
`Role`	`getRole(IPrincipalIdentifier principal)`
`Role`	`getRole(IPrincipalIdentifier principal, java.util.List<java.lang.String> reqProps, java.util.Map<java.lang.String,java.lang.Object> appCtxMap)` get role profile Retrieves Role from Attribute Authority for a given Principal Identifier
`Role`	`getRole(IPrincipalIdentifier principal, java.util.Map<java.lang.String,java.lang.Object> appCtxMap)`
`Role`	`getRoleMembers(javax.servlet.http.HttpServletRequest request)`
`Role`	`getRoleMembers(javax.servlet.http.HttpServletRequest request, java.util.Map<java.lang.String,java.lang.Object> appCtxMap)` get role members Retrieves Role from Attribute Authority for a given HTTPServletRequest
`Role`	`getRoleMembers(IPrincipalIdentifier principal)`
`Role`	`getRoleMembers(IPrincipalIdentifier principal, java.util.List<java.lang.String> reqProps, java.util.Map<java.lang.String,java.lang.Object> appCtxMap)` get role members Retrieves Role from Attribute Authority for a given Principal Identifier
`Role`	`getRoleMembers(IPrincipalIdentifier principal, java.util.Map<java.lang.String,java.lang.Object> appCtxMap)`
`boolean`	`isCreateRoleSupported()` Check if create Role is supported
`boolean`	`isDropRoleSupported()` Check if drop Role is supported
`boolean`	`isManager(Role role, Role rolemanager, boolean direct)`
`boolean`	`isManager(Role role, Role rolemanager, boolean direct, java.util.Map<java.lang.String,java.lang.Object> appCtxMap)` Return TRUE if inputOwner is owner of a role
`boolean`	`isManager(Role role, User rolemanager, boolean direct)`
`boolean`	`isManager(Role role, User rolemanager, boolean direct, java.util.Map<java.lang.String,java.lang.Object> appCtxMap)` Return TRUE if inputOwner is owner of a role
`boolean`	`isMember(Role role, Role member, boolean direct)`
`boolean`	`isMember(Role role, Role member, boolean direct, java.util.Map<java.lang.String,java.lang.Object> appCtxMap)` Return TRUE if inputMember is a member of a role
`boolean`	`isMember(Role role, User member, boolean direct)`
`boolean`	`isMember(Role role, User member, boolean direct, java.util.Map<java.lang.String,java.lang.Object> appCtxMap)` Return TRUE if inputMember is a member of a role
`boolean`	`isModifyRoleSupported()` Check if modify Role is supported
`boolean`	`isOwner(Role role, Role owner, boolean direct)`
`boolean`	`isOwner(Role role, Role owner, boolean direct, java.util.Map<java.lang.String,java.lang.Object> appCtxMap)` Return TRUE if inputOwner is owner of a role
`boolean`	`isOwner(Role role, User owner, boolean direct)`
`boolean`	`isOwner(Role role, User owner, boolean direct, java.util.Map<java.lang.String,java.lang.Object> appCtxMap)` Return TRUE if inputOwner is owner of a role
`void`	`modifyRole(IPrincipalIdentifier principal, java.util.List<ModPropertyValue> attrVals)`
`void`	`modifyRole(IPrincipalIdentifier principal, java.util.List<ModPropertyValue> attrVals, java.util.Map<java.lang.String,java.lang.Object> appCtxMap)` Updates a Role Modifies Role for given Principal Identifier with given list of attributes.
`void`	`modifyRole(IPrincipalIdentifier principal, java.lang.String attrName, java.lang.String attrValue)`
`void`	`modifyRole(IPrincipalIdentifier principal, java.lang.String attrName, java.lang.String attrValue, java.util.Map<java.lang.String,java.lang.Object> appCtxMap)` Updates a Role Modifies Role for given Principal Identifier with single attribute name/value pair.
`java.util.List<Role>`	`searchRoles(java.util.List<PropertyFilterValue> attrFiltersList)`
`java.util.List<Role>`	`searchRoles(java.util.List<PropertyFilterValue> attrFiltersList, java.util.Map<java.lang.String,java.lang.Object> appCtxMap)` Returns all Roles matching given filter condition Searches the Attribute Authority and returns list of Digital Entities matching the given filter condition.
`java.util.List<Role>`	`searchRoles(SearchFilter filter, java.util.List<java.lang.String> reqProps, java.util.Map<java.lang.String,java.lang.Object> appCtxMap)` Returns all Roles matching given filter condition Searches the Attribute Authority and returns list of Digital Entities matching the given filter condition.
`java.util.List<Role>`	`searchRolesbyAllAttr(java.util.List<PropertyFilterValue> attrFiltersList)`
`java.util.List<Role>`	`searchRolesbyAllAttr(java.util.List<PropertyFilterValue> attrFiltersList, java.util.Map<java.lang.String,java.lang.Object> appCtxMap)` Returns all Roles matching given 'AND' filter condition Searches the Attribute Authority and returns list of Digital Entities matching the given filter condition.
`java.util.List<Role>`	`searchRolesbyAllAttr(SearchFilter filter, java.util.List<java.lang.String> reqProps, java.util.Map<java.lang.String,java.lang.Object> appCtxMap)` Returns all Roles matching given 'AND' filter condition Searches the Attribute Authority and returns list of Digital Entities matching the given filter condition.
`SearchResults<Role>`	`searchRolesbyAllAttrbyPage(java.util.List<PropertyFilterValue> attrFiltersList)`
`SearchResults<Role>`	`searchRolesbyAllAttrbyPage(java.util.List<PropertyFilterValue> attrFiltersList, java.util.Map<java.lang.String,java.lang.Object> appCtxMap)` Returns all Roles matching given 'AND' filter condition Searches the Attribute Authority and returns list of Digital Entities matching the given filter condition.
`SearchResults<Role>`	`searchRolesbyAllAttrbyPage(SearchFilter filter, java.util.List<java.lang.String> reqProps, java.util.Map<java.lang.String,java.lang.Object> appCtxMap)` Returns all Roles matching given 'AND' filter condition Searches the Attribute Authority and returns list of Digital Entities matching the given filter condition.
`java.util.List<Role>`	`searchRolesbyAnyAttr(java.util.List<PropertyFilterValue> attrFiltersList)`
`java.util.List<Role>`	`searchRolesbyAnyAttr(java.util.List<PropertyFilterValue> attrFiltersList, java.util.Map<java.lang.String,java.lang.Object> appCtxMap)` Returns all Roles matching given 'OR' filter condition Searches the Attribute Authority and returns list of Digital Entities matching the given filter condition.
`java.util.List<Role>`	`searchRolesbyAnyAttr(SearchFilter filter, java.util.List<java.lang.String> reqProps, java.util.Map<java.lang.String,java.lang.Object> appCtxMap)` Returns all Roles matching given 'OR' filter condition Searches the Attribute Authority and returns list of Digital Entities matching the given filter condition.
`SearchResults<Role>`	`searchRolesbyAnyAttrbyPage(java.util.List<PropertyFilterValue> attrFiltersList)`
`SearchResults<Role>`	`searchRolesbyAnyAttrbyPage(java.util.List<PropertyFilterValue> attrFiltersList, java.util.Map<java.lang.String,java.lang.Object> appCtxMap)` Returns all Roles matching given 'OR' filter condition Searches the Attribute Authority and returns list of Digital Entities matching the given filter condition.
`SearchResults<Role>`	`searchRolesbyAnyAttrbyPage(SearchFilter filter, java.util.List<java.lang.String> reqProps, java.util.Map<java.lang.String,java.lang.Object> appCtxMap)` Returns all Roles matching given 'OR' filter condition Searches the Attribute Authority and returns list of Digital Entities matching the given filter condition.
`SearchResults<Role>`	`searchRolesbyPage(java.util.List<PropertyFilterValue> attrFiltersList)`
`SearchResults<Role>`	`searchRolesbyPage(java.util.List<PropertyFilterValue> attrFiltersList, java.util.Map<java.lang.String,java.lang.Object> appCtxMap)` Returns all Roles matching given filter condition Searches the Attribute Authority and returns list of Digital Entities matching the given filter condition.
`SearchResults<Role>`	`searchRolesbyPage(SearchFilter filter, java.util.List<java.lang.String> reqProps, java.util.Map<java.lang.String,java.lang.Object> appCtxMap)` Returns all Roles matching given filter condition Searches the Attribute Authority and returns list of Digital Entities matching the given filter condition.

Methods inherited from class org.openliberty.arisidbeans.IGFObjectManager
dispose, finalize, getAllAttributeNames, getAllAttributeNames, getAllInteractions, getAllInteractions, getAllPredicateNames, getAllPredicateNames, getAllPropertyNames, getAllPropertyNames, getAllRoles, getAllRoles, getAttributeDef, getPredicateDef, getRoleDef, isAttribute, isPredicate, isRole

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- RoleManager
```
public RoleManager()
            throws java.io.FileNotFoundException,
                   java.net.URISyntaxException,
                   java.lang.IllegalAccessException,
                   IDBeanException
```
  RoleManager default Constructor. RoleManager is initialized with the CARML file, userrole.xml
  
  Throws:
  
  java.io.FileNotFoundException - Thrown when the CARML document cannot be located through the provided URI.
  
  java.net.URISyntaxException - Thrown when the referenced external CARML URI is invalid
  
  java.lang.IllegalAccessException - An Exception has occurred with XML parser
  
  IDBeanException - General IdentityManagement Exception
- RoleManager
```
public RoleManager(java.util.Map<java.lang.String,java.lang.Object> properties)
            throws java.io.FileNotFoundException,
                   java.net.URISyntaxException,
                   java.lang.IllegalAccessException,
                   IDBeanException
```
  RoleManager is initialized with the CARML file, userrole.xml
  
  Parameters:
  
  properties - Map with IdentityBeans parameter values
  
  Throws:
  
  java.io.FileNotFoundException - Thrown when the CARML document cannot be located through the provided URI.
  
  java.net.URISyntaxException - Thrown when the referenced external CARML URI is invalid
  
  java.lang.IllegalAccessException - An Exception has occurred with XML parser
  
  IDBeanException - General IdentityManagement Exception
- RoleManager
```
public RoleManager(java.lang.String carmlFile,
                   java.util.Map<java.lang.String,java.lang.Object> properties)
            throws java.io.FileNotFoundException,
                   java.net.URISyntaxException,
                   java.lang.IllegalAccessException,
                   IDBeanException
```
  RoleManager constructor initialized with given CARML file
  
  Parameters:
  
  carmlFile - CARML file with location from which this Role bean has been generated
  
  properties - Map with IdentityBeans parameter values
  
  Throws:
  
  java.io.FileNotFoundException - Thrown when the CARML document cannot be located through the provided URI.
  
  java.net.URISyntaxException - Thrown when the referenced external CARML URI is invalid
  
  java.lang.IllegalAccessException - An Exception has occurred with XML parser
  
  IDBeanException - General IdentityManagement Exception
- RoleManager
```
public RoleManager(java.net.URI carmlLoc,
                   java.util.Map<java.lang.String,java.lang.Object> properties)
            throws java.io.FileNotFoundException,
                   IDBeanException,
                   java.lang.IllegalAccessException
```
  RoleManager constructor initialized with given CARML URI
  
  Parameters:
  
  carmlLoc - URI of the CARML file from which this Role bean has been generated
  
  properties - Map with IdentityBeans parameter values
  
  Throws:
  
  java.io.FileNotFoundException - Thrown when the CARML document cannot be located through the provided URI.
  
  java.lang.IllegalAccessException - An Exception has occurred with XML parser
  
  IDBeanException - General IdentityManagement Exception

Method Detail

getDefaultCarmlFile
```
public static java.lang.String getDefaultCarmlFile()
```
Get Default CARML declaration file

Returns:

default CARML declaration filename

createRole
```
public IPrincipalIdentifier createRole(java.util.List<PropertyValue> attrVals,
                                       java.util.Map<java.lang.String,java.lang.Object> appCtxMap)
                                throws IDBeanException,
                                       ConnectionException,
                                       PolicyException,
                                       SubjectNotUniqueException,
                                       NoSuchSubjectException
```
Creates new Role Creates Role for given list of attributes. List of attributes being added should exist in addInteraction in CARML document.

Parameters:

attrVals - Array of attributes of the Digital Subject to be created. Attributes being added should exist in addInteraction in CARML document

appCtxMap - The application context as a hash map will contain Language constraint if any and the Principal user.

Returns:

principal added in attribute authority

Throws:

NoSuchSubjectException - The attribute service could not find a subject within the mapped context to authenticate

ConnectionException - Occurs when there was a connection error trying to connect to the appropriate attribute authority.

PolicyException - Occurs when the add is refused due to policy restrictions

SubjectNotUniqueException - Is thrown when a subject already exists and policy has determined that the add may not be converted to a modify.

IDBeanException - General IdentityManagement Exception

createRole

public IPrincipalIdentifier createRole(java.util.List<PropertyValue> attrVals)
                                throws IDBeanException,
                                       ConnectionException,
                                       PolicyException,
                                       SubjectNotUniqueException,
                                       NoSuchSubjectException

Throws:: IDBeanException; ConnectionException; PolicyException; SubjectNotUniqueException; NoSuchSubjectException

getRole
```
public Role getRole(IPrincipalIdentifier principal,
                    java.util.List<java.lang.String> reqProps,
                    java.util.Map<java.lang.String,java.lang.Object> appCtxMap)
             throws NoSuchSubjectException,
                    ConnectionException,
                    PolicyException,
                    SubjectNotUniqueException,
                    IDBeanException
```
get role profile Retrieves Role from Attribute Authority for a given Principal Identifier

Parameters:

principal - Principal Identifier in the Digital Subject

reqProps - List of properties requested to be fetched

appCtxMap - The application context as a hash map will contain Language constraint if any and the Principal user.

Returns:

Role for the requested Principal Identifier

Throws:

NoSuchSubjectException - The attribute service could not find a subject within the mapped context

ConnectionException - Occurs when there was a connection error trying to connect to the appropriate attribute authority.

PolicyException - Transaction has failed due to policy or consent failure

SubjectNotUniqueException - Thrown when the subject or user cannot be uniquely mapped to a single context or is not unique within a context.

IDBeanException - General IdentityManagement Exception

getRole

public Role getRole(IPrincipalIdentifier principal,
                    java.util.Map<java.lang.String,java.lang.Object> appCtxMap)
             throws NoSuchSubjectException,
                    ConnectionException,
                    PolicyException,
                    SubjectNotUniqueException,
                    IDBeanException

Throws:: NoSuchSubjectException; ConnectionException; PolicyException; SubjectNotUniqueException; IDBeanException

getRole

public Role getRole(IPrincipalIdentifier principal)
             throws NoSuchSubjectException,
                    ConnectionException,
                    PolicyException,
                    SubjectNotUniqueException,
                    IDBeanException

Throws:: NoSuchSubjectException; ConnectionException; PolicyException; SubjectNotUniqueException; IDBeanException

getRole
```
public Role getRole(javax.servlet.http.HttpServletRequest request,
                    java.util.Map<java.lang.String,java.lang.Object> appCtxMap)
             throws NoSuchSubjectException,
                    ConnectionException,
                    PolicyException,
                    SubjectNotUniqueException,
                    IDBeanException
```
get role profile Retrieves Role from Attribute Authority for a given HTTPServletRequest

Parameters:

request - HttpServerletRequest object to be parsed for a Subject context

appCtxMap - The application context as a hash map will contain Language constraint if any and the Principal user.

Returns:

Role for the requested Principal Identifier

Throws:

NoSuchSubjectException - The attribute service could not find a subject within the mapped context

ConnectionException - Occurs when there was a connection error trying to connect to the appropriate attribute authority.

PolicyException - Transaction has failed due to policy or consent failure

SubjectNotUniqueException - Thrown when the subject or user cannot be uniquely mapped to a single context or is not unique within a context.

IDBeanException - General IdentityManagement Exception

getRole

public Role getRole(javax.servlet.http.HttpServletRequest request)
             throws NoSuchSubjectException,
                    ConnectionException,
                    PolicyException,
                    SubjectNotUniqueException,
                    IDBeanException

Throws:: NoSuchSubjectException; ConnectionException; PolicyException; SubjectNotUniqueException; IDBeanException

dropRole
```
public void dropRole(IPrincipalIdentifier principal,
                     java.util.Map<java.lang.String,java.lang.Object> appCtxMap)
              throws IDBeanException,
                     ConnectionException,
                     PolicyException,
                     NoSuchSubjectException,
                     SubjectNotUniqueException
```
Delete Role Deletes the Role from Attribute Authority for a given principal identifier

Parameters:

principal - Principal Identifier in the Digital Subject

appCtxMap - The application context as a hash map will contain Language constraint if any and the Principal user.

Throws:

NoSuchSubjectException - The attribute service could not find a subject within the mapped context to authenticate

ConnectionException - Occurs when there was a connection error trying to connect to the appropriate attribute authority.

PolicyException - Occurs when the delete is refused due to policy restrictions

SubjectNotUniqueException - Occurs when the delete would impact more than one Subject

InvalidFilterException - If an invalid filter or filter value has been specified

IDBeanException - General IdentityManagement Exception

dropRole

public void dropRole(IPrincipalIdentifier principal)
              throws IDBeanException,
                     ConnectionException,
                     PolicyException,
                     NoSuchSubjectException,
                     SubjectNotUniqueException

Throws:: IDBeanException; ConnectionException; PolicyException; NoSuchSubjectException; SubjectNotUniqueException

dropRole
```
public void dropRole(Role subj,
                     java.util.Map<java.lang.String,java.lang.Object> appCtxMap)
              throws IDBeanException,
                     ConnectionException,
                     PolicyException,
                     NoSuchSubjectException,
                     SubjectNotUniqueException
```
Delete Role Deletes the Role from Attribute Authority

Parameters:

subj - Role object to be deleted from Attribute Authority

appCtxMap - The application context as a hash map will contain Language constraint if any and the Principal user.

Throws:

NoSuchSubjectException - The attribute service could not find a subject within the mapped context to authenticate

ConnectionException - Occurs when there was a connection error trying to connect to the appropriate attribute authority.

PolicyException - Occurs when the delete is refused due to policy restrictions

SubjectNotUniqueException - Occurs when the delete would impact more than one Subject

InvalidFilterException - If an invalid filter or filter value has been specified

IDBeanException - General IdentityManagement Exception

dropRole

public void dropRole(Role subj)
              throws IDBeanException,
                     ConnectionException,
                     PolicyException,
                     NoSuchSubjectException,
                     SubjectNotUniqueException

Throws:: IDBeanException; ConnectionException; PolicyException; NoSuchSubjectException; SubjectNotUniqueException

getRoleMembers
```
public Role getRoleMembers(IPrincipalIdentifier principal,
                           java.util.List<java.lang.String> reqProps,
                           java.util.Map<java.lang.String,java.lang.Object> appCtxMap)
                    throws NoSuchSubjectException,
                           ConnectionException,
                           PolicyException,
                           SubjectNotUniqueException,
                           IDBeanException
```
get role members Retrieves Role from Attribute Authority for a given Principal Identifier

Parameters:

principal - Principal Identifier in the Digital Subject

reqProps - List of properties requested to be fetched

appCtxMap - The application context as a hash map will contain Language constraint if any and the Principal user.

Returns:

Role for the requested Principal Identifier

Throws:

NoSuchSubjectException - The attribute service could not find a subject within the mapped context

ConnectionException - Occurs when there was a connection error trying to connect to the appropriate attribute authority.

PolicyException - Transaction has failed due to policy or consent failure

SubjectNotUniqueException - Thrown when the subject or user cannot be uniquely mapped to a single context or is not unique within a context.

IDBeanException - General IdentityManagement Exception

getRoleMembers

public Role getRoleMembers(IPrincipalIdentifier principal,
                           java.util.Map<java.lang.String,java.lang.Object> appCtxMap)
                    throws NoSuchSubjectException,
                           ConnectionException,
                           PolicyException,
                           SubjectNotUniqueException,
                           IDBeanException

Throws:: NoSuchSubjectException; ConnectionException; PolicyException; SubjectNotUniqueException; IDBeanException

getRoleMembers

public Role getRoleMembers(IPrincipalIdentifier principal)
                    throws NoSuchSubjectException,
                           ConnectionException,
                           PolicyException,
                           SubjectNotUniqueException,
                           IDBeanException

Throws:: NoSuchSubjectException; ConnectionException; PolicyException; SubjectNotUniqueException; IDBeanException

getRoleMembers
```
public Role getRoleMembers(javax.servlet.http.HttpServletRequest request,
                           java.util.Map<java.lang.String,java.lang.Object> appCtxMap)
                    throws NoSuchSubjectException,
                           ConnectionException,
                           PolicyException,
                           SubjectNotUniqueException,
                           IDBeanException
```
get role members Retrieves Role from Attribute Authority for a given HTTPServletRequest

Parameters:

request - HttpServerletRequest object to be parsed for a Subject context

appCtxMap - The application context as a hash map will contain Language constraint if any and the Principal user.

Returns:

Role for the requested Principal Identifier

Throws:

NoSuchSubjectException - The attribute service could not find a subject within the mapped context

ConnectionException - Occurs when there was a connection error trying to connect to the appropriate attribute authority.

PolicyException - Transaction has failed due to policy or consent failure

SubjectNotUniqueException - Thrown when the subject or user cannot be uniquely mapped to a single context or is not unique within a context.

IDBeanException - General IdentityManagement Exception

getRoleMembers

public Role getRoleMembers(javax.servlet.http.HttpServletRequest request)
                    throws NoSuchSubjectException,
                           ConnectionException,
                           PolicyException,
                           SubjectNotUniqueException,
                           IDBeanException

Throws:: NoSuchSubjectException; ConnectionException; PolicyException; SubjectNotUniqueException; IDBeanException

modifyRole
```
public void modifyRole(IPrincipalIdentifier principal,
                       java.lang.String attrName,
                       java.lang.String attrValue,
                       java.util.Map<java.lang.String,java.lang.Object> appCtxMap)
                throws ConnectionException,
                       PolicyException,
                       NoSuchSubjectException,
                       SubjectNotUniqueException,
                       IDBeanException
```
Updates a Role Modifies Role for given Principal Identifier with single attribute name/value pair. List of attributes being modified should exist in modifyInteraction in CARML document as modifiable attributes.

Parameters:

principal - Principal Identifier in the Digital Subject

attrName - Attribute name to be modified for the given principal

attrValue - Attribute Value to be set in Attribute Authority for the given principal

appCtxMap - The application context as a hash map will contain Language constraint if any and the Principal user.

Throws:

NoSuchSubjectException - The attribute service could not find a subject within the mapped context to authenticate

ConnectionException - Occurs when there was a connection error trying to connect to the appropriate attribute authority.

PolicyException - Occurs when the modify is refused due to policy restrictions

SubjectNotUniqueException - subject or user cannot be uniquely mapped to a single context or is not unique within a context

IDBeanException - General IdentityManagement Exception

modifyRole

public void modifyRole(IPrincipalIdentifier principal,
                       java.lang.String attrName,
                       java.lang.String attrValue)
                throws ConnectionException,
                       PolicyException,
                       NoSuchSubjectException,
                       SubjectNotUniqueException,
                       IDBeanException

Throws:: ConnectionException; PolicyException; NoSuchSubjectException; SubjectNotUniqueException; IDBeanException

modifyRole
```
public void modifyRole(IPrincipalIdentifier principal,
                       java.util.List<ModPropertyValue> attrVals,
                       java.util.Map<java.lang.String,java.lang.Object> appCtxMap)
                throws IDBeanException,
                       ConnectionException,
                       PolicyException,
                       NoSuchSubjectException,
                       SubjectNotUniqueException
```
Updates a Role Modifies Role for given Principal Identifier with given list of attributes. List of attributes being modified should exist in modifyInteraction in CARML document as modifiable attributes.

Parameters:

principal - Principal Identifier in the Digital Subject

attrVals - Array of attributes of the Digital Subject to be modified. Attributes in this Array should exist in modifyInteraction in CARML document

appCtxMap - The application context as a hash map will contain Language constraint if any and the Principal user.

Throws:

NoSuchSubjectException - The attribute service could not find a subject within the mapped context to authenticate

ConnectionException - Occurs when there was a connection error trying to connect to the appropriate attribute authority.

PolicyException - Occurs when the modify is refused due to policy restrictions

SubjectNotUniqueException - subject or user cannot be uniquely mapped to a single context or is not unique within a context

IDBeanException - General IdentityManagement Exception

modifyRole

public void modifyRole(IPrincipalIdentifier principal,
                       java.util.List<ModPropertyValue> attrVals)
                throws IDBeanException,
                       ConnectionException,
                       PolicyException,
                       NoSuchSubjectException,
                       SubjectNotUniqueException

Throws:: IDBeanException; ConnectionException; PolicyException; NoSuchSubjectException; SubjectNotUniqueException

searchRoles
```
public java.util.List<Role> searchRoles(java.util.List<PropertyFilterValue> attrFiltersList,
                                        java.util.Map<java.lang.String,java.lang.Object> appCtxMap)
                                 throws IDBeanException,
                                        ConnectionException,
                                        PolicyException,
                                        NoSuchSubjectException,
                                        SubjectNotUniqueException,
                                        InvalidFilterException
```
Returns all Roles matching given filter condition Searches the Attribute Authority and returns list of Digital Entities matching the given filter condition. Attributes given in the List should exist in searchInteraction in CARML document as filter attributes.

Parameters:

attrFiltersList - List of attributes to be used as filter for searching the matching digital subjects. Attributes in the List should exist in searchInteraction in CARML document

appCtxMap - The application context as a hash map will contain Language constraint if any and the Principal user.

Returns:

List of Identities matching given filter condition

Throws:

NoSuchSubjectException - The attribute service could not find a subject within the mapped context to authenticate

ConnectionException - Occurs when there was a connection error trying to connect to the appropriate attribute authority.

PolicyException - When the the transaction has failed due to policy or consent failure

SubjectNotUniqueException - When the subject or user cannot be uniquely mapped to a single context or is not unique within a context

InvalidFilterException - If an invalid filter or filter value has been specified

IDBeanException - General IdentityManagement Exception

searchRoles

public java.util.List<Role> searchRoles(java.util.List<PropertyFilterValue> attrFiltersList)
                                 throws IDBeanException,
                                        ConnectionException,
                                        PolicyException,
                                        NoSuchSubjectException,
                                        SubjectNotUniqueException,
                                        InvalidFilterException

Throws:: IDBeanException; ConnectionException; PolicyException; NoSuchSubjectException; SubjectNotUniqueException; InvalidFilterException

searchRoles
```
public java.util.List<Role> searchRoles(SearchFilter filter,
                                        java.util.List<java.lang.String> reqProps,
                                        java.util.Map<java.lang.String,java.lang.Object> appCtxMap)
                                 throws IDBeanException,
                                        ConnectionException,
                                        PolicyException,
                                        NoSuchSubjectException,
                                        SubjectNotUniqueException,
                                        InvalidFilterException
```
Returns all Roles matching given filter condition Searches the Attribute Authority and returns list of Digital Entities matching the given filter condition. Attributes given in the List should exist in searchInteraction in CARML document as filter attributes.

Parameters:

filter - Dynamic Search Filter to be used as filter for finding the matching entity. Attributes used in the SearchFilter should exist in searchInteraction's dynamic filter in CARML document

reqProps - List of properties requested to be fetched

appCtxMap - The application context as a hash map will contain Language constraint if any and the Principal user.

Returns:

List of Identities matching given filter condition

Throws:

NoSuchSubjectException - The attribute service could not find a subject within the mapped context to authenticate

ConnectionException - Occurs when there was a connection error trying to connect to the appropriate attribute authority.

PolicyException - When the the transaction has failed due to policy or consent failure

SubjectNotUniqueException - When the subject or user cannot be uniquely mapped to a single context or is not unique within a context

InvalidFilterException - If an invalid filter or filter value has been specified

IDBeanException - General IdentityManagement Exception

searchRolesbyAllAttr
```
public java.util.List<Role> searchRolesbyAllAttr(java.util.List<PropertyFilterValue> attrFiltersList,
                                                 java.util.Map<java.lang.String,java.lang.Object> appCtxMap)
                                          throws IDBeanException,
                                                 ConnectionException,
                                                 PolicyException,
                                                 NoSuchSubjectException,
                                                 SubjectNotUniqueException,
                                                 InvalidFilterException
```
Returns all Roles matching given 'AND' filter condition Searches the Attribute Authority and returns list of Digital Entities matching the given filter condition. Attributes given in the List should exist in searchInteraction in CARML document as filter attributes.

Parameters:

attrFiltersList - List of attributes to be used as filter for searching the matching digital subjects. Attributes in the List should exist in searchInteraction in CARML document

appCtxMap - The application context as a hash map will contain Language constraint if any and the Principal user.

Returns:

List of Identities matching given filter condition

Throws:

NoSuchSubjectException - The attribute service could not find a subject within the mapped context to authenticate

ConnectionException - Occurs when there was a connection error trying to connect to the appropriate attribute authority.

PolicyException - When the the transaction has failed due to policy or consent failure

SubjectNotUniqueException - When the subject or user cannot be uniquely mapped to a single context or is not unique within a context

InvalidFilterException - If an invalid filter or filter value has been specified

IDBeanException - General IdentityManagement Exception

searchRolesbyAllAttr

public java.util.List<Role> searchRolesbyAllAttr(java.util.List<PropertyFilterValue> attrFiltersList)
                                          throws IDBeanException,
                                                 ConnectionException,
                                                 PolicyException,
                                                 NoSuchSubjectException,
                                                 SubjectNotUniqueException,
                                                 InvalidFilterException

Throws:: IDBeanException; ConnectionException; PolicyException; NoSuchSubjectException; SubjectNotUniqueException; InvalidFilterException

searchRolesbyAllAttr
```
public java.util.List<Role> searchRolesbyAllAttr(SearchFilter filter,
                                                 java.util.List<java.lang.String> reqProps,
                                                 java.util.Map<java.lang.String,java.lang.Object> appCtxMap)
                                          throws IDBeanException,
                                                 ConnectionException,
                                                 PolicyException,
                                                 NoSuchSubjectException,
                                                 SubjectNotUniqueException,
                                                 InvalidFilterException
```
Returns all Roles matching given 'AND' filter condition Searches the Attribute Authority and returns list of Digital Entities matching the given filter condition. Attributes given in the List should exist in searchInteraction in CARML document as filter attributes.

Parameters:

filter - Dynamic Search Filter to be used as filter for finding the matching entity. Attributes used in the SearchFilter should exist in searchInteraction's dynamic filter in CARML document

reqProps - List of properties requested to be fetched

appCtxMap - The application context as a hash map will contain Language constraint if any and the Principal user.

Returns:

List of Identities matching given filter condition

Throws:

NoSuchSubjectException - The attribute service could not find a subject within the mapped context to authenticate

ConnectionException - Occurs when there was a connection error trying to connect to the appropriate attribute authority.

PolicyException - When the the transaction has failed due to policy or consent failure

SubjectNotUniqueException - When the subject or user cannot be uniquely mapped to a single context or is not unique within a context

InvalidFilterException - If an invalid filter or filter value has been specified

IDBeanException - General IdentityManagement Exception

searchRolesbyAllAttrbyPage
```
public SearchResults<Role> searchRolesbyAllAttrbyPage(java.util.List<PropertyFilterValue> attrFiltersList,
                                                      java.util.Map<java.lang.String,java.lang.Object> appCtxMap)
                                               throws IDBeanException,
                                                      ConnectionException,
                                                      PolicyException,
                                                      NoSuchSubjectException,
                                                      SubjectNotUniqueException,
                                                      InvalidFilterException
```
Returns all Roles matching given 'AND' filter condition Searches the Attribute Authority and returns list of Digital Entities matching the given filter condition. Attributes given in the List should exist in searchInteraction in CARML document as filter attributes.

Parameters:

attrFiltersList - List of attributes to be used as filter for searching the matching digital subjects. Attributes in the List should exist in searchInteraction in CARML document

appCtxMap - The application context as a hash map will contain Language constraint if any and the Principal user.

Returns:

SearchResults object containing Identities matching given filter condition

Throws:

NoSuchSubjectException - The attribute service could not find a subject within the mapped context to authenticate

ConnectionException - Occurs when there was a connection error trying to connect to the appropriate attribute authority.

PolicyException - When the the transaction has failed due to policy or consent failure

SubjectNotUniqueException - When the subject or user cannot be uniquely mapped to a single context or is not unique within a context

InvalidFilterException - If an invalid filter or filter value has been specified

IDBeanException - General IdentityManagement Exception

searchRolesbyAllAttrbyPage

public SearchResults<Role> searchRolesbyAllAttrbyPage(java.util.List<PropertyFilterValue> attrFiltersList)
                                               throws IDBeanException,
                                                      ConnectionException,
                                                      PolicyException,
                                                      NoSuchSubjectException,
                                                      SubjectNotUniqueException,
                                                      InvalidFilterException

Throws:: IDBeanException; ConnectionException; PolicyException; NoSuchSubjectException; SubjectNotUniqueException; InvalidFilterException

searchRolesbyAllAttrbyPage
```
public SearchResults<Role> searchRolesbyAllAttrbyPage(SearchFilter filter,
                                                      java.util.List<java.lang.String> reqProps,
                                                      java.util.Map<java.lang.String,java.lang.Object> appCtxMap)
                                               throws IDBeanException,
                                                      ConnectionException,
                                                      PolicyException,
                                                      NoSuchSubjectException,
                                                      SubjectNotUniqueException,
                                                      InvalidFilterException
```
Returns all Roles matching given 'AND' filter condition Searches the Attribute Authority and returns list of Digital Entities matching the given filter condition. Attributes given in the List should exist in searchInteraction in CARML document as filter attributes.

Parameters:

attrFiltersList - List of attributes to be used as filter for searching the matching digital subjects. Attributes in the List should exist in searchInteraction in CARML document

filter - Dynamic Search Filter to be used as filter for finding the matching entity. Attributes used in the SearchFilter should exist in searchInteraction's dynamic filter in CARML document

reqProps - List of properties requested to be fetched

appCtxMap - The application context as a hash map will contain Language constraint if any and the Principal user.

Returns:

SearchResults object containing Identities matching given filter condition

Throws:

NoSuchSubjectException - The attribute service could not find a subject within the mapped context to authenticate

ConnectionException - Occurs when there was a connection error trying to connect to the appropriate attribute authority.

PolicyException - When the the transaction has failed due to policy or consent failure

SubjectNotUniqueException - When the subject or user cannot be uniquely mapped to a single context or is not unique within a context

InvalidFilterException - If an invalid filter or filter value has been specified

IDBeanException - General IdentityManagement Exception

searchRolesbyAnyAttr
```
public java.util.List<Role> searchRolesbyAnyAttr(java.util.List<PropertyFilterValue> attrFiltersList,
                                                 java.util.Map<java.lang.String,java.lang.Object> appCtxMap)
                                          throws IDBeanException,
                                                 ConnectionException,
                                                 PolicyException,
                                                 NoSuchSubjectException,
                                                 SubjectNotUniqueException,
                                                 InvalidFilterException
```
Returns all Roles matching given 'OR' filter condition Searches the Attribute Authority and returns list of Digital Entities matching the given filter condition. Attributes given in the List should exist in searchInteraction in CARML document as filter attributes.

Parameters:

attrFiltersList - List of attributes to be used as filter for searching the matching digital subjects. Attributes in the List should exist in searchInteraction in CARML document

appCtxMap - The application context as a hash map will contain Language constraint if any and the Principal user.

Returns:

List of Identities matching given filter condition

Throws:

NoSuchSubjectException - The attribute service could not find a subject within the mapped context to authenticate

ConnectionException - Occurs when there was a connection error trying to connect to the appropriate attribute authority.

PolicyException - When the the transaction has failed due to policy or consent failure

SubjectNotUniqueException - When the subject or user cannot be uniquely mapped to a single context or is not unique within a context

InvalidFilterException - If an invalid filter or filter value has been specified

IDBeanException - General IdentityManagement Exception

searchRolesbyAnyAttr

public java.util.List<Role> searchRolesbyAnyAttr(java.util.List<PropertyFilterValue> attrFiltersList)
                                          throws IDBeanException,
                                                 ConnectionException,
                                                 PolicyException,
                                                 NoSuchSubjectException,
                                                 SubjectNotUniqueException,
                                                 InvalidFilterException

Throws:: IDBeanException; ConnectionException; PolicyException; NoSuchSubjectException; SubjectNotUniqueException; InvalidFilterException

searchRolesbyAnyAttr
```
public java.util.List<Role> searchRolesbyAnyAttr(SearchFilter filter,
                                                 java.util.List<java.lang.String> reqProps,
                                                 java.util.Map<java.lang.String,java.lang.Object> appCtxMap)
                                          throws IDBeanException,
                                                 ConnectionException,
                                                 PolicyException,
                                                 NoSuchSubjectException,
                                                 SubjectNotUniqueException,
                                                 InvalidFilterException
```
Returns all Roles matching given 'OR' filter condition Searches the Attribute Authority and returns list of Digital Entities matching the given filter condition. Attributes given in the List should exist in searchInteraction in CARML document as filter attributes.

Parameters:

filter - Dynamic Search Filter to be used as filter for finding the matching entity. Attributes used in the SearchFilter should exist in searchInteraction's dynamic filter in CARML document

reqProps - List of properties requested to be fetched

appCtxMap - The application context as a hash map will contain Language constraint if any and the Principal user.

Returns:

List of Identities matching given filter condition

Throws:

NoSuchSubjectException - The attribute service could not find a subject within the mapped context to authenticate

ConnectionException - Occurs when there was a connection error trying to connect to the appropriate attribute authority.

PolicyException - When the the transaction has failed due to policy or consent failure

SubjectNotUniqueException - When the subject or user cannot be uniquely mapped to a single context or is not unique within a context

InvalidFilterException - If an invalid filter or filter value has been specified

IDBeanException - General IdentityManagement Exception

searchRolesbyAnyAttrbyPage
```
public SearchResults<Role> searchRolesbyAnyAttrbyPage(java.util.List<PropertyFilterValue> attrFiltersList,
                                                      java.util.Map<java.lang.String,java.lang.Object> appCtxMap)
                                               throws IDBeanException,
                                                      ConnectionException,
                                                      PolicyException,
                                                      NoSuchSubjectException,
                                                      SubjectNotUniqueException,
                                                      InvalidFilterException
```
Returns all Roles matching given 'OR' filter condition Searches the Attribute Authority and returns list of Digital Entities matching the given filter condition. Attributes given in the List should exist in searchInteraction in CARML document as filter attributes.

Parameters:

attrFiltersList - List of attributes to be used as filter for searching the matching digital subjects. Attributes in the List should exist in searchInteraction in CARML document

appCtxMap - The application context as a hash map will contain Language constraint if any and the Principal user.

Returns:

SearchResults object containing Identities matching given filter condition

Throws:

NoSuchSubjectException - The attribute service could not find a subject within the mapped context to authenticate

ConnectionException - Occurs when there was a connection error trying to connect to the appropriate attribute authority.

PolicyException - When the the transaction has failed due to policy or consent failure

SubjectNotUniqueException - When the subject or user cannot be uniquely mapped to a single context or is not unique within a context

InvalidFilterException - If an invalid filter or filter value has been specified

IDBeanException - General IdentityManagement Exception

searchRolesbyAnyAttrbyPage

public SearchResults<Role> searchRolesbyAnyAttrbyPage(java.util.List<PropertyFilterValue> attrFiltersList)
                                               throws IDBeanException,
                                                      ConnectionException,
                                                      PolicyException,
                                                      NoSuchSubjectException,
                                                      SubjectNotUniqueException,
                                                      InvalidFilterException

Throws:: IDBeanException; ConnectionException; PolicyException; NoSuchSubjectException; SubjectNotUniqueException; InvalidFilterException

searchRolesbyAnyAttrbyPage
```
public SearchResults<Role> searchRolesbyAnyAttrbyPage(SearchFilter filter,
                                                      java.util.List<java.lang.String> reqProps,
                                                      java.util.Map<java.lang.String,java.lang.Object> appCtxMap)
                                               throws IDBeanException,
                                                      ConnectionException,
                                                      PolicyException,
                                                      NoSuchSubjectException,
                                                      SubjectNotUniqueException,
                                                      InvalidFilterException
```
Returns all Roles matching given 'OR' filter condition Searches the Attribute Authority and returns list of Digital Entities matching the given filter condition. Attributes given in the List should exist in searchInteraction in CARML document as filter attributes.

Parameters:

attrFiltersList - List of attributes to be used as filter for searching the matching digital subjects. Attributes in the List should exist in searchInteraction in CARML document

filter - Dynamic Search Filter to be used as filter for finding the matching entity. Attributes used in the SearchFilter should exist in searchInteraction's dynamic filter in CARML document

reqProps - List of properties requested to be fetched

appCtxMap - The application context as a hash map will contain Language constraint if any and the Principal user.

Returns:

SearchResults object containing Identities matching given filter condition

Throws:

NoSuchSubjectException - The attribute service could not find a subject within the mapped context to authenticate

ConnectionException - Occurs when there was a connection error trying to connect to the appropriate attribute authority.

PolicyException - When the the transaction has failed due to policy or consent failure

SubjectNotUniqueException - When the subject or user cannot be uniquely mapped to a single context or is not unique within a context

InvalidFilterException - If an invalid filter or filter value has been specified

IDBeanException - General IdentityManagement Exception

searchRolesbyPage
```
public SearchResults<Role> searchRolesbyPage(java.util.List<PropertyFilterValue> attrFiltersList,
                                             java.util.Map<java.lang.String,java.lang.Object> appCtxMap)
                                      throws IDBeanException,
                                             ConnectionException,
                                             PolicyException,
                                             NoSuchSubjectException,
                                             SubjectNotUniqueException,
                                             InvalidFilterException
```
Returns all Roles matching given filter condition Searches the Attribute Authority and returns list of Digital Entities matching the given filter condition. Attributes given in the List should exist in searchInteraction in CARML document as filter attributes.

Parameters:

attrFiltersList - List of attributes to be used as filter for searching the matching digital subjects. Attributes in the List should exist in searchInteraction in CARML document

appCtxMap - The application context as a hash map will contain Language constraint if any and the Principal user.

Returns:

SearchResults object containing Identities matching given filter condition

Throws:

NoSuchSubjectException - The attribute service could not find a subject within the mapped context to authenticate

ConnectionException - Occurs when there was a connection error trying to connect to the appropriate attribute authority.

PolicyException - When the the transaction has failed due to policy or consent failure

SubjectNotUniqueException - When the subject or user cannot be uniquely mapped to a single context or is not unique within a context

InvalidFilterException - If an invalid filter or filter value has been specified

IDBeanException - General IdentityManagement Exception

searchRolesbyPage

public SearchResults<Role> searchRolesbyPage(java.util.List<PropertyFilterValue> attrFiltersList)
                                      throws IDBeanException,
                                             ConnectionException,
                                             PolicyException,
                                             NoSuchSubjectException,
                                             SubjectNotUniqueException,
                                             InvalidFilterException

Throws:: IDBeanException; ConnectionException; PolicyException; NoSuchSubjectException; SubjectNotUniqueException; InvalidFilterException

searchRolesbyPage
```
public SearchResults<Role> searchRolesbyPage(SearchFilter filter,
                                             java.util.List<java.lang.String> reqProps,
                                             java.util.Map<java.lang.String,java.lang.Object> appCtxMap)
                                      throws IDBeanException,
                                             ConnectionException,
                                             PolicyException,
                                             NoSuchSubjectException,
                                             SubjectNotUniqueException,
                                             InvalidFilterException
```
Returns all Roles matching given filter condition Searches the Attribute Authority and returns list of Digital Entities matching the given filter condition. Attributes given in the List should exist in searchInteraction in CARML document as filter attributes.

Parameters:

attrFiltersList - List of attributes to be used as filter for searching the matching digital subjects. Attributes in the List should exist in searchInteraction in CARML document

filter - Dynamic Search Filter to be used as filter for finding the matching entity. Attributes used in the SearchFilter should exist in searchInteraction's dynamic filter in CARML document

reqProps - List of properties requested to be fetched

appCtxMap - The application context as a hash map will contain Language constraint if any and the Principal user.

Returns:

SearchResults object containing Identities matching given filter condition

Throws:

NoSuchSubjectException - The attribute service could not find a subject within the mapped context to authenticate

ConnectionException - Occurs when there was a connection error trying to connect to the appropriate attribute authority.

PolicyException - When the the transaction has failed due to policy or consent failure

SubjectNotUniqueException - When the subject or user cannot be uniquely mapped to a single context or is not unique within a context

InvalidFilterException - If an invalid filter or filter value has been specified

IDBeanException - General IdentityManagement Exception

exists
```
public boolean exists(Role subj,
                      java.util.Map<java.lang.String,java.lang.Object> appCtxMap)
               throws ConnectionException,
                      PolicyException,
                      IDBeanException
```
Returns true if the Role exists in Attribute Authority

Parameters:

subj - Subject to be verified if exists in Attribute Authority

appCtxMap - The application context as a hash map will contain Language constraint if any and the Principal user.

Returns:

true if Role exists

Throws:

ConnectionException

PolicyException

IDBeanException

exists

public boolean exists(Role subj)
               throws ConnectionException,
                      PolicyException,
                      IDBeanException

Throws:: ConnectionException; PolicyException; IDBeanException

isCreateRoleSupported
```
public boolean isCreateRoleSupported()
```
Check if create Role is supported

Returns:

true if Role creation is supported

isModifyRoleSupported
```
public boolean isModifyRoleSupported()
```
Check if modify Role is supported

Returns:

true if Role modification is supported

isDropRoleSupported
```
public boolean isDropRoleSupported()
```
Check if drop Role is supported

Returns:

true if Role deletion is supported

getGrantedRoles

public java.util.List<Role> getGrantedRoles(User user,
                                            int nLevels,
                                            java.util.Map<java.lang.String,java.lang.Object> appCtxMap)
                                     throws ConnectionException,
                                            PolicyException,
                                            SubjectNotUniqueException,
                                            IDBeanException,
                                            InvalidFilterException

Get granted roles of a member

Parameters:: user - User object; nLevels - Maximum number of nested levels. If set to 0, will fetch the matching entries from all nested levels; appCtxMap - The application context as a hash map will contain Language constraint if any and the Principal user.
Returns:: List of Roles
Throws:: ConnectionException; PolicyException; SubjectNotUniqueException; IDBeanException; InvalidFilterException

getGrantedRoles

public java.util.List<Role> getGrantedRoles(User user,
                                            int nLevels)
                                     throws ConnectionException,
                                            PolicyException,
                                            SubjectNotUniqueException,
                                            IDBeanException,
                                            InvalidFilterException

Throws:: ConnectionException; PolicyException; SubjectNotUniqueException; IDBeanException; InvalidFilterException

getGrantedRoles

public java.util.List<Role> getGrantedRoles(Role role,
                                            int nLevels,
                                            java.util.Map<java.lang.String,java.lang.Object> appCtxMap)
                                     throws ConnectionException,
                                            PolicyException,
                                            SubjectNotUniqueException,
                                            IDBeanException,
                                            InvalidFilterException

Get granted roles of a member

Parameters:: role - Role object; nLevels - Maximum number of nested levels. If set to 0, will fetch the matching entries from all nested levels; appCtxMap - The application context as a hash map will contain Language constraint if any and the Principal user.
Returns:: List of Roles
Throws:: ConnectionException; PolicyException; SubjectNotUniqueException; IDBeanException; InvalidFilterException

getGrantedRoles

public java.util.List<Role> getGrantedRoles(Role role,
                                            int nLevels)
                                     throws ConnectionException,
                                            PolicyException,
                                            SubjectNotUniqueException,
                                            IDBeanException,
                                            InvalidFilterException

Throws:: ConnectionException; PolicyException; SubjectNotUniqueException; IDBeanException; InvalidFilterException

getGranteeNames

public java.util.List<java.lang.String> getGranteeNames(Role role,
                                                        int nLevels,
                                                        java.util.Map<java.lang.String,java.lang.Object> appCtxMap)
                                                 throws ConnectionException,
                                                        PolicyException,
                                                        SubjectNotUniqueException,
                                                        IDBeanException,
                                                        InvalidFilterException

Get member names of a role

Parameters:: role - Role object; nLevels - Maximum number of nested levels. If set to 0, will fetch the matching entries from all nested levels; appCtxMap - The application context as a hash map will contain Language constraint if any and the Principal user.
Returns:: List of Strings
Throws:: ConnectionException; PolicyException; SubjectNotUniqueException; IDBeanException; InvalidFilterException

getGranteeNames

public java.util.List<java.lang.String> getGranteeNames(Role role,
                                                        int nLevels)
                                                 throws ConnectionException,
                                                        PolicyException,
                                                        SubjectNotUniqueException,
                                                        IDBeanException,
                                                        InvalidFilterException

Throws:: ConnectionException; PolicyException; SubjectNotUniqueException; IDBeanException; InvalidFilterException

getGrantees

public java.util.List<User> getGrantees(Role role,
                                        int nLevels,
                                        UserManager usermanager,
                                        java.util.Map<java.lang.String,java.lang.Object> appCtxMap)
                                 throws ConnectionException,
                                        PolicyException,
                                        SubjectNotUniqueException,
                                        IDBeanException,
                                        InvalidFilterException

Get members of a role

Parameters:: role - Role object; nLevels - Maximum number of nested levels. If set to 0, will fetch the matching entries from all nested levels; usermanager - UserManager object; appCtxMap - The application context as a hash map will contain Language constraint if any and the Principal user.
Returns:: List of Users
Throws:: ConnectionException; PolicyException; SubjectNotUniqueException; IDBeanException; InvalidFilterException

getGrantees

public java.util.List<User> getGrantees(Role role,
                                        int nLevels,
                                        UserManager usermanager)
                                 throws ConnectionException,
                                        PolicyException,
                                        SubjectNotUniqueException,
                                        IDBeanException,
                                        InvalidFilterException

Throws:: ConnectionException; PolicyException; SubjectNotUniqueException; IDBeanException; InvalidFilterException

getManagedRoles

public java.util.List<Role> getManagedRoles(User user,
                                            int nLevels,
                                            java.util.Map<java.lang.String,java.lang.Object> appCtxMap)
                                     throws ConnectionException,
                                            PolicyException,
                                            SubjectNotUniqueException,
                                            IDBeanException,
                                            InvalidFilterException

Get owned roles of an user/role

Parameters:: user - User object; nLevels - Maximum number of nested levels. If set to 0, will fetch the matching entries from all nested levels; appCtxMap - The application context as a hash map will contain Language constraint if any and the Principal user.
Returns:: List of Roles
Throws:: ConnectionException; PolicyException; SubjectNotUniqueException; IDBeanException; InvalidFilterException

getManagedRoles

public java.util.List<Role> getManagedRoles(User user,
                                            int nLevels)
                                     throws ConnectionException,
                                            PolicyException,
                                            SubjectNotUniqueException,
                                            IDBeanException,
                                            InvalidFilterException

Throws:: ConnectionException; PolicyException; SubjectNotUniqueException; IDBeanException; InvalidFilterException

getManagedRoles

public java.util.List<Role> getManagedRoles(Role role,
                                            int nLevels,
                                            java.util.Map<java.lang.String,java.lang.Object> appCtxMap)
                                     throws ConnectionException,
                                            PolicyException,
                                            SubjectNotUniqueException,
                                            IDBeanException,
                                            InvalidFilterException

Get owned roles of an user/role

Parameters:: role - Role object; nLevels - Maximum number of nested levels. If set to 0, will fetch the matching entries from all nested levels; appCtxMap - The application context as a hash map will contain Language constraint if any and the Principal user.
Returns:: List of Roles
Throws:: ConnectionException; PolicyException; SubjectNotUniqueException; IDBeanException; InvalidFilterException

getManagedRoles

public java.util.List<Role> getManagedRoles(Role role,
                                            int nLevels)
                                     throws ConnectionException,
                                            PolicyException,
                                            SubjectNotUniqueException,
                                            IDBeanException,
                                            InvalidFilterException

Throws:: ConnectionException; PolicyException; SubjectNotUniqueException; IDBeanException; InvalidFilterException

getManagers

public java.util.List<User> getManagers(Role role,
                                        int nLevels,
                                        UserManager usermanager,
                                        java.util.Map<java.lang.String,java.lang.Object> appCtxMap)
                                 throws ConnectionException,
                                        PolicyException,
                                        SubjectNotUniqueException,
                                        IDBeanException,
                                        InvalidFilterException

Get managers of a role

Parameters:: role - Role object; nLevels - Maximum number of nested levels. If set to 0, will fetch the matching entries from all nested levels; usermanager - UserManager object; appCtxMap - The application context as a hash map will contain Language constraint if any and the Principal user.
Returns:: List of Users
Throws:: ConnectionException; PolicyException; SubjectNotUniqueException; IDBeanException; InvalidFilterException

getManagers

public java.util.List<User> getManagers(Role role,
                                        int nLevels,
                                        UserManager usermanager)
                                 throws ConnectionException,
                                        PolicyException,
                                        SubjectNotUniqueException,
                                        IDBeanException,
                                        InvalidFilterException

Throws:: ConnectionException; PolicyException; SubjectNotUniqueException; IDBeanException; InvalidFilterException

getMembersandRoles

public java.util.List<java.lang.Object> getMembersandRoles(Role role,
                                                           int nLevels,
                                                           UserManager usermanager,
                                                           java.util.Map<java.lang.String,java.lang.Object> appCtxMap)
                                                    throws ConnectionException,
                                                           PolicyException,
                                                           SubjectNotUniqueException,
                                                           IDBeanException,
                                                           InvalidFilterException

Get members and subroles of a role

Parameters:: role - Role object; nLevels - Maximum number of nested levels. If set to 0, will fetch the matching entries from all nested levels; usermanager - UserManager object; appCtxMap - The application context as a hash map will contain Language constraint if any and the Principal user.
Returns:: List of Objects
Throws:: ConnectionException; PolicyException; SubjectNotUniqueException; IDBeanException; InvalidFilterException

getMembersandRoles

public java.util.List<java.lang.Object> getMembersandRoles(Role role,
                                                           int nLevels,
                                                           UserManager usermanager)
                                                    throws ConnectionException,
                                                           PolicyException,
                                                           SubjectNotUniqueException,
                                                           IDBeanException,
                                                           InvalidFilterException

Throws:: ConnectionException; PolicyException; SubjectNotUniqueException; IDBeanException; InvalidFilterException

getOwnedRoles

public java.util.List<Role> getOwnedRoles(User user,
                                          int nLevels,
                                          java.util.Map<java.lang.String,java.lang.Object> appCtxMap)
                                   throws ConnectionException,
                                          PolicyException,
                                          SubjectNotUniqueException,
                                          IDBeanException,
                                          InvalidFilterException

Get owned roles of an user/role

Parameters:: user - User object; nLevels - Maximum number of nested levels. If set to 0, will fetch the matching entries from all nested levels; appCtxMap - The application context as a hash map will contain Language constraint if any and the Principal user.
Returns:: List of Roles
Throws:: ConnectionException; PolicyException; SubjectNotUniqueException; IDBeanException; InvalidFilterException

getOwnedRoles

public java.util.List<Role> getOwnedRoles(User user,
                                          int nLevels)
                                   throws ConnectionException,
                                          PolicyException,
                                          SubjectNotUniqueException,
                                          IDBeanException,
                                          InvalidFilterException

Throws:: ConnectionException; PolicyException; SubjectNotUniqueException; IDBeanException; InvalidFilterException

getOwnedRoles

public java.util.List<Role> getOwnedRoles(Role role,
                                          int nLevels,
                                          java.util.Map<java.lang.String,java.lang.Object> appCtxMap)
                                   throws ConnectionException,
                                          PolicyException,
                                          SubjectNotUniqueException,
                                          IDBeanException,
                                          InvalidFilterException

Get owned roles of an user/role

Parameters:: role - Role object; nLevels - Maximum number of nested levels. If set to 0, will fetch the matching entries from all nested levels; appCtxMap - The application context as a hash map will contain Language constraint if any and the Principal user.
Returns:: List of Roles
Throws:: ConnectionException; PolicyException; SubjectNotUniqueException; IDBeanException; InvalidFilterException

getOwnedRoles

public java.util.List<Role> getOwnedRoles(Role role,
                                          int nLevels)
                                   throws ConnectionException,
                                          PolicyException,
                                          SubjectNotUniqueException,
                                          IDBeanException,
                                          InvalidFilterException

Throws:: ConnectionException; PolicyException; SubjectNotUniqueException; IDBeanException; InvalidFilterException

getOwners

public java.util.List<User> getOwners(Role role,
                                      int nLevels,
                                      UserManager usermanager,
                                      java.util.Map<java.lang.String,java.lang.Object> appCtxMap)
                               throws ConnectionException,
                                      PolicyException,
                                      SubjectNotUniqueException,
                                      IDBeanException,
                                      InvalidFilterException

Get owners of a role

Parameters:: role - Role object; nLevels - Maximum number of nested levels. If set to 0, will fetch the matching entries from all nested levels; usermanager - UserManager object; appCtxMap - The application context as a hash map will contain Language constraint if any and the Principal user.
Returns:: List of Users
Throws:: ConnectionException; PolicyException; SubjectNotUniqueException; IDBeanException; InvalidFilterException

getOwners

public java.util.List<User> getOwners(Role role,
                                      int nLevels,
                                      UserManager usermanager)
                               throws ConnectionException,
                                      PolicyException,
                                      SubjectNotUniqueException,
                                      IDBeanException,
                                      InvalidFilterException

Throws:: ConnectionException; PolicyException; SubjectNotUniqueException; IDBeanException; InvalidFilterException

isManager

public boolean isManager(Role role,
                         User rolemanager,
                         boolean direct,
                         java.util.Map<java.lang.String,java.lang.Object> appCtxMap)
                  throws ConnectionException,
                         PolicyException,
                         SubjectNotUniqueException,
                         IDBeanException,
                         java.io.FileNotFoundException,
                         java.net.URISyntaxException,
                         java.lang.IllegalAccessException,
                         InvalidFilterException

Return TRUE if inputOwner is owner of a role

Parameters:: role - Role object; rolemanager - User object; direct - true - to check only one level objects false - to check all nested levels; appCtxMap - The application context as a hash map will contain Language constraint if any and the Principal user.
Returns:: true if '$attrName' is $attrName of 'role'
Throws:: ConnectionException; PolicyException; SubjectNotUniqueException; IDBeanException; java.io.FileNotFoundException; java.net.URISyntaxException; java.lang.IllegalAccessException; InvalidFilterException

isManager

public boolean isManager(Role role,
                         User rolemanager,
                         boolean direct)
                  throws ConnectionException,
                         PolicyException,
                         SubjectNotUniqueException,
                         IDBeanException,
                         java.io.FileNotFoundException,
                         java.net.URISyntaxException,
                         java.lang.IllegalAccessException,
                         InvalidFilterException

Throws:: ConnectionException; PolicyException; SubjectNotUniqueException; IDBeanException; java.io.FileNotFoundException; java.net.URISyntaxException; java.lang.IllegalAccessException; InvalidFilterException

isManager

public boolean isManager(Role role,
                         Role rolemanager,
                         boolean direct,
                         java.util.Map<java.lang.String,java.lang.Object> appCtxMap)
                  throws ConnectionException,
                         PolicyException,
                         SubjectNotUniqueException,
                         IDBeanException,
                         java.io.FileNotFoundException,
                         java.net.URISyntaxException,
                         java.lang.IllegalAccessException,
                         InvalidFilterException

Return TRUE if inputOwner is owner of a role

Parameters:: role - Role object; rolemanager - Role object; direct - true - to check only one level objects false - to check all nested levels; appCtxMap - The application context as a hash map will contain Language constraint if any and the Principal user.
Returns:: true if '$attrName' is $attrName of 'role'
Throws:: ConnectionException; PolicyException; SubjectNotUniqueException; IDBeanException; java.io.FileNotFoundException; java.net.URISyntaxException; java.lang.IllegalAccessException; InvalidFilterException

isManager

public boolean isManager(Role role,
                         Role rolemanager,
                         boolean direct)
                  throws ConnectionException,
                         PolicyException,
                         SubjectNotUniqueException,
                         IDBeanException,
                         java.io.FileNotFoundException,
                         java.net.URISyntaxException,
                         java.lang.IllegalAccessException,
                         InvalidFilterException

Throws:: ConnectionException; PolicyException; SubjectNotUniqueException; IDBeanException; java.io.FileNotFoundException; java.net.URISyntaxException; java.lang.IllegalAccessException; InvalidFilterException

isMember

public boolean isMember(Role role,
                        User member,
                        boolean direct,
                        java.util.Map<java.lang.String,java.lang.Object> appCtxMap)
                 throws ConnectionException,
                        PolicyException,
                        SubjectNotUniqueException,
                        IDBeanException,
                        java.io.FileNotFoundException,
                        java.net.URISyntaxException,
                        java.lang.IllegalAccessException,
                        InvalidFilterException

Return TRUE if inputMember is a member of a role

Parameters:: role - Role object; member - User object; direct - true - to check only one level objects false - to check all nested levels; appCtxMap - The application context as a hash map will contain Language constraint if any and the Principal user.
Returns:: true if '$attrName' is $attrName of 'role'
Throws:: ConnectionException; PolicyException; SubjectNotUniqueException; IDBeanException; java.io.FileNotFoundException; java.net.URISyntaxException; java.lang.IllegalAccessException; InvalidFilterException

isMember

public boolean isMember(Role role,
                        User member,
                        boolean direct)
                 throws ConnectionException,
                        PolicyException,
                        SubjectNotUniqueException,
                        IDBeanException,
                        java.io.FileNotFoundException,
                        java.net.URISyntaxException,
                        java.lang.IllegalAccessException,
                        InvalidFilterException

Throws:: ConnectionException; PolicyException; SubjectNotUniqueException; IDBeanException; java.io.FileNotFoundException; java.net.URISyntaxException; java.lang.IllegalAccessException; InvalidFilterException

isMember

public boolean isMember(Role role,
                        Role member,
                        boolean direct,
                        java.util.Map<java.lang.String,java.lang.Object> appCtxMap)
                 throws ConnectionException,
                        PolicyException,
                        SubjectNotUniqueException,
                        IDBeanException,
                        java.io.FileNotFoundException,
                        java.net.URISyntaxException,
                        java.lang.IllegalAccessException,
                        InvalidFilterException

Return TRUE if inputMember is a member of a role

Parameters:: role - Role object; member - Role object; direct - true - to check only one level objects false - to check all nested levels; appCtxMap - The application context as a hash map will contain Language constraint if any and the Principal user.
Returns:: true if '$attrName' is $attrName of 'role'
Throws:: ConnectionException; PolicyException; SubjectNotUniqueException; IDBeanException; java.io.FileNotFoundException; java.net.URISyntaxException; java.lang.IllegalAccessException; InvalidFilterException

isMember

public boolean isMember(Role role,
                        Role member,
                        boolean direct)
                 throws ConnectionException,
                        PolicyException,
                        SubjectNotUniqueException,
                        IDBeanException,
                        java.io.FileNotFoundException,
                        java.net.URISyntaxException,
                        java.lang.IllegalAccessException,
                        InvalidFilterException

Throws:: ConnectionException; PolicyException; SubjectNotUniqueException; IDBeanException; java.io.FileNotFoundException; java.net.URISyntaxException; java.lang.IllegalAccessException; InvalidFilterException

isOwner

public boolean isOwner(Role role,
                       User owner,
                       boolean direct,
                       java.util.Map<java.lang.String,java.lang.Object> appCtxMap)
                throws ConnectionException,
                       PolicyException,
                       SubjectNotUniqueException,
                       IDBeanException,
                       java.io.FileNotFoundException,
                       java.net.URISyntaxException,
                       java.lang.IllegalAccessException,
                       InvalidFilterException

Return TRUE if inputOwner is owner of a role

Parameters:: role - Role object; owner - User object; direct - true - to check only one level objects false - to check all nested levels; appCtxMap - The application context as a hash map will contain Language constraint if any and the Principal user.
Returns:: true if '$attrName' is $attrName of 'role'
Throws:: ConnectionException; PolicyException; SubjectNotUniqueException; IDBeanException; java.io.FileNotFoundException; java.net.URISyntaxException; java.lang.IllegalAccessException; InvalidFilterException

isOwner

public boolean isOwner(Role role,
                       User owner,
                       boolean direct)
                throws ConnectionException,
                       PolicyException,
                       SubjectNotUniqueException,
                       IDBeanException,
                       java.io.FileNotFoundException,
                       java.net.URISyntaxException,
                       java.lang.IllegalAccessException,
                       InvalidFilterException

Throws:: ConnectionException; PolicyException; SubjectNotUniqueException; IDBeanException; java.io.FileNotFoundException; java.net.URISyntaxException; java.lang.IllegalAccessException; InvalidFilterException

isOwner

public boolean isOwner(Role role,
                       Role owner,
                       boolean direct,
                       java.util.Map<java.lang.String,java.lang.Object> appCtxMap)
                throws ConnectionException,
                       PolicyException,
                       SubjectNotUniqueException,
                       IDBeanException,
                       java.io.FileNotFoundException,
                       java.net.URISyntaxException,
                       java.lang.IllegalAccessException,
                       InvalidFilterException

Return TRUE if inputOwner is owner of a role

Parameters:: role - Role object; owner - Role object; direct - true - to check only one level objects false - to check all nested levels; appCtxMap - The application context as a hash map will contain Language constraint if any and the Principal user.
Returns:: true if '$attrName' is $attrName of 'role'
Throws:: ConnectionException; PolicyException; SubjectNotUniqueException; IDBeanException; java.io.FileNotFoundException; java.net.URISyntaxException; java.lang.IllegalAccessException; InvalidFilterException

isOwner

public boolean isOwner(Role role,
                       Role owner,
                       boolean direct)
                throws ConnectionException,
                       PolicyException,
                       SubjectNotUniqueException,
                       IDBeanException,
                       java.io.FileNotFoundException,
                       java.net.URISyntaxException,
                       java.lang.IllegalAccessException,
                       InvalidFilterException

Throws:: ConnectionException; PolicyException; SubjectNotUniqueException; IDBeanException; java.io.FileNotFoundException; java.net.URISyntaxException; java.lang.IllegalAccessException; InvalidFilterException

Class RoleManager

Constructor Summary

Method Summary

Methods inherited from class org.openliberty.arisidbeans.IGFObjectManager

Methods inherited from class java.lang.Object

Constructor Detail

RoleManager

RoleManager

RoleManager

RoleManager

Method Detail

getDefaultCarmlFile

createRole

createRole

getRole

getRole

getRole

getRole

getRole

dropRole

dropRole

dropRole

dropRole

getRoleMembers

getRoleMembers

getRoleMembers

getRoleMembers

getRoleMembers

modifyRole

modifyRole

modifyRole

modifyRole

searchRoles

searchRoles

searchRoles

searchRolesbyAllAttr

searchRolesbyAllAttr

searchRolesbyAllAttr

searchRolesbyAllAttrbyPage

searchRolesbyAllAttrbyPage

searchRolesbyAllAttrbyPage

searchRolesbyAnyAttr

searchRolesbyAnyAttr

searchRolesbyAnyAttr

searchRolesbyAnyAttrbyPage

searchRolesbyAnyAttrbyPage

searchRolesbyAnyAttrbyPage

searchRolesbyPage

searchRolesbyPage

searchRolesbyPage

exists

exists

isCreateRoleSupported

isModifyRoleSupported

isDropRoleSupported

getGrantedRoles

getGrantedRoles

getGrantedRoles

getGrantedRoles

getGranteeNames

getGranteeNames

getGrantees

getGrantees

getManagedRoles

getManagedRoles

getManagedRoles

getManagedRoles

getManagers

getManagers

getMembersandRoles

getMembersandRoles

getOwnedRoles

getOwnedRoles

getOwnedRoles

getOwnedRoles

getOwners

getOwners

isManager

isManager

isManager