oracle.igf.userrole
Class UserManager

java.lang.Object
  org.openliberty.arisidbeans.IGFObjectManager
      oracle.igf.userrole.UserManager

public class UserManager
extends IGFObjectManager

This UserManager class generated from CARML file userrole.xml has methods corresponding to the interactions defined in the CARML file.

Constructor Summary

UserManager()
UserManager default Constructor.

UserManager(java.util.Map<java.lang.String,java.lang.Object> properties)
UserManager is initialized with the CARML file, userrole.xml

UserManager(java.lang.String carmlFile, java.util.Map<java.lang.String,java.lang.Object> properties)
UserManager constructor initialized with given CARML file

UserManager(java.net.URI carmlLoc, java.util.Map<java.lang.String,java.lang.Object> properties)
UserManager constructor initialized with given CARML URI

Method Summary

IPrincipalIdentifier	createUser(java.util.List<PropertyValue> attrVals)
IPrincipalIdentifier	createUser(java.util.List<PropertyValue> attrVals, java.util.Map<java.lang.String,java.lang.Object> appCtxMap) Adds new User Profile Creates User for given list of attributes.
void	dropUser(IPrincipalIdentifier principal)
void	dropUser(IPrincipalIdentifier principal, java.util.Map<java.lang.String,java.lang.Object> appCtxMap) Delete user Profile Deletes the User from Attribute Authority for a given principal identifier
void	dropUser(java.lang.String SubjectId)
void	dropUser(java.lang.String SubjectId, java.util.Map<java.lang.String,java.lang.Object> appCtxMap) Delete user Profile Deletes the User from Attribute Authority for a given Subject ID.
void	dropUser(User subj)
void	dropUser(User subj, java.util.Map<java.lang.String,java.lang.Object> appCtxMap) Delete user Profile Deletes the User from Attribute Authority
boolean	exists(User subj)
boolean	exists(User subj, java.util.Map<java.lang.String,java.lang.Object> appCtxMap) Returns true if the User exists in Attribute Authority
static java.lang.String	getDefaultCarmlFile() Get Default CARML declaration file
java.util.List<User>	getManagementChain(User user, int nLevels, java.lang.String manager, java.lang.String title)
java.util.List<User>	getManagementChain(User user, int nLevels, java.lang.String manager, java.lang.String title, java.util.Map<java.lang.String,java.lang.Object> appCtxMap) Get Management Chain
java.util.List<User>	getReportees(User user, int nLevels)
java.util.List<User>	getReportees(User user, int nLevels, java.util.Map<java.lang.String,java.lang.Object> appCtxMap) Get Reportees
User	getUser(javax.servlet.http.HttpServletRequest request)
User	getUser(javax.servlet.http.HttpServletRequest request, java.util.Map<java.lang.String,java.lang.Object> appCtxMap) Get user profile Retrieves User from Attribute Authority for a given HTTPServletRequest
User	getUser(IPrincipalIdentifier principal)
User	getUser(IPrincipalIdentifier principal, java.util.Map<java.lang.String,java.lang.Object> appCtxMap) Get user profile Retrieves User from Attribute Authority for a given Principal Identifier
User	getUser(java.lang.String subjectID)
User	getUser(java.lang.String subjectID, java.util.Map<java.lang.String,java.lang.Object> appCtxMap) Get user profile Retrieves User from Attribute Authority for given SubjectID.
boolean	isCreateUserSupported() Check if create User is supported
boolean	isDropUserSupported() Check if drop User is supported
boolean	isManager(User user, User manager, boolean direct)
boolean	isManager(User user, User manager, boolean direct, java.util.Map<java.lang.String,java.lang.Object> appCtxMap) Return true if user2 is manager of user1
boolean	isModifyUserSupported() Check if modify User is supported
void	modifyUser(IPrincipalIdentifier principal, java.util.List<ModPropertyValue> attrVals)
void	modifyUser(IPrincipalIdentifier principal, java.util.List<ModPropertyValue> attrVals, java.util.Map<java.lang.String,java.lang.Object> appCtxMap) Updates User Profile Modifies User for given Principal Identifier with given list of attributes.
void	modifyUser(IPrincipalIdentifier principal, java.lang.String attrName, java.lang.String attrValue)
void	modifyUser(IPrincipalIdentifier principal, java.lang.String attrName, java.lang.String attrValue, java.util.Map<java.lang.String,java.lang.Object> appCtxMap) Updates User Profile Modifies User for given Principal Identifier with single attribute name/value pair.
void	modifyUser(java.lang.String SubjectId, java.util.List<ModPropertyValue> attrVals)
void	modifyUser(java.lang.String SubjectId, java.util.List<ModPropertyValue> attrVals, java.util.Map<java.lang.String,java.lang.Object> appCtxMap) Updates User Profile Modifies User for given SubjectID with given list of attributes.
void	modifyUser(java.lang.String SubjectId, java.lang.String attrName, java.lang.String attrValue)
void	modifyUser(java.lang.String SubjectId, java.lang.String attrName, java.lang.String attrValue, java.util.Map<java.lang.String,java.lang.Object> appCtxMap) Updates User Profile Modifies User for given SubjectID with single attribute name/value pair.
User	searchUser(java.lang.String loginid)
User	searchUser(java.lang.String loginid, java.util.Map<java.lang.String,java.lang.Object> appCtxMap) Locate user Profile Finds User from Attribute Authority for given SubjectID.
User	searchUserByGuid(java.lang.String guid)
User	searchUserByGuid(java.lang.String guid, java.util.Map<java.lang.String,java.lang.Object> appCtxMap) Locate user Profile Finds User from Attribute Authority for given SubjectID.
java.util.List<User>	searchUsers(java.util.List<PropertyFilterValue> attrFiltersList)
java.util.List<User>	searchUsers(java.util.List<PropertyFilterValue> attrFiltersList, java.util.Map<java.lang.String,java.lang.Object> appCtxMap) Returns all Users matching given filter condition Searches the Attribute Authority and returns list of Digital Entities matching the given filter condition.
java.util.List<User>	searchUsersbyAllAttr(java.util.List<PropertyFilterValue> attrFiltersList)
java.util.List<User>	searchUsersbyAllAttr(java.util.List<PropertyFilterValue> attrFiltersList, java.util.Map<java.lang.String,java.lang.Object> appCtxMap) Returns all Users matching given 'AND' filter condition Searches the Attribute Authority and returns list of Digital Entities matching the given filter condition.
SearchResults<User>	searchUsersbyAllAttrbyPage(java.util.List<PropertyFilterValue> attrFiltersList)
SearchResults<User>	searchUsersbyAllAttrbyPage(java.util.List<PropertyFilterValue> attrFiltersList, java.util.Map<java.lang.String,java.lang.Object> appCtxMap) Returns all Users matching given 'AND' filter condition Searches the Attribute Authority and returns list of Digital Entities matching the given filter condition.
java.util.List<User>	searchUsersbyAnyAttr(java.util.List<PropertyFilterValue> attrFiltersList)
java.util.List<User>	searchUsersbyAnyAttr(java.util.List<PropertyFilterValue> attrFiltersList, java.util.Map<java.lang.String,java.lang.Object> appCtxMap) Returns all Users matching given 'OR' filter condition Searches the Attribute Authority and returns list of Digital Entities matching the given filter condition.
SearchResults<User>	searchUsersbyAnyAttrbyPage(java.util.List<PropertyFilterValue> attrFiltersList)
SearchResults<User>	searchUsersbyAnyAttrbyPage(java.util.List<PropertyFilterValue> attrFiltersList, java.util.Map<java.lang.String,java.lang.Object> appCtxMap) Returns all Users matching given 'OR' filter condition Searches the Attribute Authority and returns list of Digital Entities matching the given filter condition.
SearchResults<User>	searchUsersbyPage(java.util.List<PropertyFilterValue> attrFiltersList)
SearchResults<User>	searchUsersbyPage(java.util.List<PropertyFilterValue> attrFiltersList, java.util.Map<java.lang.String,java.lang.Object> appCtxMap) Returns all Users 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

UserManager

public UserManager()
            throws java.io.FileNotFoundException,
                   java.net.URISyntaxException,
                   java.lang.IllegalAccessException,
                   IDBeanException

UserManager default Constructor. UserManager 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

UserManager

public UserManager(java.util.Map<java.lang.String,java.lang.Object> properties)
            throws java.io.FileNotFoundException,
                   java.net.URISyntaxException,
                   java.lang.IllegalAccessException,
                   IDBeanException

UserManager 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

UserManager

public UserManager(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

UserManager constructor initialized with given CARML file

Parameters:

carmlFile - CARML file with location from which this User 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

UserManager

public UserManager(java.net.URI carmlLoc,
                   java.util.Map<java.lang.String,java.lang.Object> properties)
            throws java.io.FileNotFoundException,
                   IDBeanException,
                   java.lang.IllegalAccessException

UserManager constructor initialized with given CARML URI

Parameters:

carmlLoc - URI of the CARML file from which this User 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

searchUsersbyAllAttr

public java.util.List<User> searchUsersbyAllAttr(java.util.List<PropertyFilterValue> attrFiltersList,
                                                 java.util.Map<java.lang.String,java.lang.Object> appCtxMap)
                                          throws IDBeanException,
                                                 ConnectionException,
                                                 PolicyException,
                                                 NoSuchSubjectException,
                                                 SubjectNotUniqueException,
                                                 InvalidFilterException

Returns all Users 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

searchUsersbyAllAttr

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

Throws:

IDBeanException

ConnectionException

PolicyException

NoSuchSubjectException

SubjectNotUniqueException

InvalidFilterException

searchUser

public User searchUser(java.lang.String loginid,
                       java.util.Map<java.lang.String,java.lang.Object> appCtxMap)
                throws IDBeanException,
                       NoSuchSubjectException,
                       SubjectNotUniqueException,
                       InvalidFilterException,
                       ConnectionException,
                       PolicyException

Locate user Profile Finds User from Attribute Authority for given SubjectID. SubjectID is the value for the PrimaryKey filter attribute in FindInteraction as defined in CARML document.

Parameters:

loginid - Unique ID of the User. This attribute is defined as PrimaryKey filter in findInteraction in CARML document.

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

Returns:

User for given loginid

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 - 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.

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

IDBeanException - General IdentityManagement Exception

searchUser

public User searchUser(java.lang.String loginid)
                throws IDBeanException,
                       NoSuchSubjectException,
                       SubjectNotUniqueException,
                       InvalidFilterException,
                       ConnectionException,
                       PolicyException

Throws:

IDBeanException

NoSuchSubjectException

SubjectNotUniqueException

InvalidFilterException

ConnectionException

PolicyException

searchUsersbyAllAttrbyPage

public SearchResults<User> searchUsersbyAllAttrbyPage(java.util.List<PropertyFilterValue> attrFiltersList,
                                                      java.util.Map<java.lang.String,java.lang.Object> appCtxMap)
                                               throws IDBeanException,
                                                      ConnectionException,
                                                      PolicyException,
                                                      NoSuchSubjectException,
                                                      SubjectNotUniqueException,
                                                      InvalidFilterException

Returns all Users 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

searchUsersbyAllAttrbyPage

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

Throws:

IDBeanException

ConnectionException

PolicyException

NoSuchSubjectException

SubjectNotUniqueException

InvalidFilterException

modifyUser

public void modifyUser(java.lang.String SubjectId,
                       java.lang.String attrName,
                       java.lang.String attrValue,
                       java.util.Map<java.lang.String,java.lang.Object> appCtxMap)
                throws ConnectionException,
                       PolicyException,
                       InvalidFilterException,
                       NoSuchSubjectException,
                       SubjectNotUniqueException,
                       IDBeanException

Updates User Profile Modifies User for given SubjectID with single attribute name/value pair. List of attributes being modified should exist in modifyInteraction in CARML document as modifiable attributes.

Parameters:

SubjectId - UID of the subject that uniquely identifies User from Attribute Authority. This attribute is defined as PrimaryKey filter in findInteraction in CARML document.

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

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

IDBeanException - General IdentityManagement Exception

modifyUser

public void modifyUser(java.lang.String SubjectId,
                       java.lang.String attrName,
                       java.lang.String attrValue)
                throws ConnectionException,
                       PolicyException,
                       InvalidFilterException,
                       NoSuchSubjectException,
                       SubjectNotUniqueException,
                       IDBeanException

Throws:

ConnectionException

PolicyException

InvalidFilterException

NoSuchSubjectException

SubjectNotUniqueException

IDBeanException

modifyUser

public void modifyUser(java.lang.String SubjectId,
                       java.util.List<ModPropertyValue> attrVals,
                       java.util.Map<java.lang.String,java.lang.Object> appCtxMap)
                throws IDBeanException,
                       ConnectionException,
                       PolicyException,
                       NoSuchSubjectException,
                       SubjectNotUniqueException,
                       InvalidFilterException

Updates User Profile Modifies User for given SubjectID with given list of attributes. List of attributes being modified should exist in modifyInteraction in CARML document as modifiable attributes.

Parameters:

SubjectId - UID of the subject that uniquely identifies User from Attribute Authority. This attribute is defined as PrimaryKey filter in findInteraction in CARML document.

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

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

IDBeanException - General IdentityManagement Exception

modifyUser

public void modifyUser(java.lang.String SubjectId,
                       java.util.List<ModPropertyValue> attrVals)
                throws IDBeanException,
                       ConnectionException,
                       PolicyException,
                       NoSuchSubjectException,
                       SubjectNotUniqueException,
                       InvalidFilterException

Throws:

IDBeanException

ConnectionException

PolicyException

NoSuchSubjectException

SubjectNotUniqueException

InvalidFilterException

modifyUser

public void modifyUser(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 User Profile Modifies User 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

modifyUser

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

Throws:

ConnectionException

PolicyException

NoSuchSubjectException

SubjectNotUniqueException

IDBeanException

modifyUser

public void modifyUser(IPrincipalIdentifier principal,
                       java.util.List<ModPropertyValue> attrVals,
                       java.util.Map<java.lang.String,java.lang.Object> appCtxMap)
                throws IDBeanException,
                       ConnectionException,
                       PolicyException,
                       NoSuchSubjectException,
                       SubjectNotUniqueException

Updates User Profile Modifies User 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

modifyUser

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

Throws:

IDBeanException

ConnectionException

PolicyException

NoSuchSubjectException

SubjectNotUniqueException

searchUsersbyPage

public SearchResults<User> searchUsersbyPage(java.util.List<PropertyFilterValue> attrFiltersList,
                                             java.util.Map<java.lang.String,java.lang.Object> appCtxMap)
                                      throws IDBeanException,
                                             ConnectionException,
                                             PolicyException,
                                             NoSuchSubjectException,
                                             SubjectNotUniqueException,
                                             InvalidFilterException

Returns all Users 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

searchUsersbyPage

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

Throws:

IDBeanException

ConnectionException

PolicyException

NoSuchSubjectException

SubjectNotUniqueException

InvalidFilterException

searchUsers

public java.util.List<User> searchUsers(java.util.List<PropertyFilterValue> attrFiltersList,
                                        java.util.Map<java.lang.String,java.lang.Object> appCtxMap)
                                 throws IDBeanException,
                                        ConnectionException,
                                        PolicyException,
                                        NoSuchSubjectException,
                                        SubjectNotUniqueException,
                                        InvalidFilterException

Returns all Users 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

searchUsers

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

Throws:

IDBeanException

ConnectionException

PolicyException

NoSuchSubjectException

SubjectNotUniqueException

InvalidFilterException

createUser

public IPrincipalIdentifier createUser(java.util.List<PropertyValue> attrVals,
                                       java.util.Map<java.lang.String,java.lang.Object> appCtxMap)
                                throws IDBeanException,
                                       ConnectionException,
                                       PolicyException,
                                       SubjectNotUniqueException,
                                       NoSuchSubjectException

Adds new User Profile Creates User 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

createUser

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

Throws:

IDBeanException

ConnectionException

PolicyException

SubjectNotUniqueException

NoSuchSubjectException

searchUserByGuid

public User searchUserByGuid(java.lang.String guid,
                             java.util.Map<java.lang.String,java.lang.Object> appCtxMap)
                      throws IDBeanException,
                             NoSuchSubjectException,
                             SubjectNotUniqueException,
                             InvalidFilterException,
                             ConnectionException,
                             PolicyException

Locate user Profile Finds User from Attribute Authority for given SubjectID. SubjectID is the value for the PrimaryKey filter attribute in FindInteraction as defined in CARML document.

Parameters:

guid - Unique ID of the User. This attribute is defined as PrimaryKey filter in findInteraction in CARML document.

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

Returns:

User for given guid

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 - 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.

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

IDBeanException - General IdentityManagement Exception

searchUserByGuid

public User searchUserByGuid(java.lang.String guid)
                      throws IDBeanException,
                             NoSuchSubjectException,
                             SubjectNotUniqueException,
                             InvalidFilterException,
                             ConnectionException,
                             PolicyException

Throws:

IDBeanException

NoSuchSubjectException

SubjectNotUniqueException

InvalidFilterException

ConnectionException

PolicyException

searchUsersbyAnyAttrbyPage

public SearchResults<User> searchUsersbyAnyAttrbyPage(java.util.List<PropertyFilterValue> attrFiltersList,
                                                      java.util.Map<java.lang.String,java.lang.Object> appCtxMap)
                                               throws IDBeanException,
                                                      ConnectionException,
                                                      PolicyException,
                                                      NoSuchSubjectException,
                                                      SubjectNotUniqueException,
                                                      InvalidFilterException

Returns all Users 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

searchUsersbyAnyAttrbyPage

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

Throws:

IDBeanException

ConnectionException

PolicyException

NoSuchSubjectException

SubjectNotUniqueException

InvalidFilterException

dropUser

public void dropUser(java.lang.String SubjectId,
                     java.util.Map<java.lang.String,java.lang.Object> appCtxMap)
              throws NoSuchSubjectException,
                     SubjectNotUniqueException,
                     InvalidFilterException,
                     IDBeanException,
                     ConnectionException,
                     PolicyException

Delete user Profile Deletes the User from Attribute Authority for a given Subject ID.

Parameters:

SubjectId - UID of the subject that uniquely identifies User from Attribute Authority. This attribute is defined as PrimaryKey filter in findInteraction 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 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

dropUser

public void dropUser(java.lang.String SubjectId)
              throws NoSuchSubjectException,
                     SubjectNotUniqueException,
                     InvalidFilterException,
                     IDBeanException,
                     ConnectionException,
                     PolicyException

Throws:

NoSuchSubjectException

SubjectNotUniqueException

InvalidFilterException

IDBeanException

ConnectionException

PolicyException

dropUser

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

Delete user Profile Deletes the User 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

dropUser

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

Throws:

IDBeanException

ConnectionException

PolicyException

NoSuchSubjectException

SubjectNotUniqueException

dropUser

public void dropUser(User subj,
                     java.util.Map<java.lang.String,java.lang.Object> appCtxMap)
              throws IDBeanException,
                     ConnectionException,
                     PolicyException,
                     NoSuchSubjectException,
                     SubjectNotUniqueException

Delete user Profile Deletes the User from Attribute Authority

Parameters:

subj - User 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

dropUser

public void dropUser(User subj)
              throws IDBeanException,
                     ConnectionException,
                     PolicyException,
                     NoSuchSubjectException,
                     SubjectNotUniqueException

Throws:

IDBeanException

ConnectionException

PolicyException

NoSuchSubjectException

SubjectNotUniqueException

searchUsersbyAnyAttr

public java.util.List<User> searchUsersbyAnyAttr(java.util.List<PropertyFilterValue> attrFiltersList,
                                                 java.util.Map<java.lang.String,java.lang.Object> appCtxMap)
                                          throws IDBeanException,
                                                 ConnectionException,
                                                 PolicyException,
                                                 NoSuchSubjectException,
                                                 SubjectNotUniqueException,
                                                 InvalidFilterException

Returns all Users 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

searchUsersbyAnyAttr

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

Throws:

IDBeanException

ConnectionException

PolicyException

NoSuchSubjectException

SubjectNotUniqueException

InvalidFilterException

getUser

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

Get user profile Retrieves User 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.

Returns:

User 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

getUser

public User getUser(IPrincipalIdentifier principal)
             throws NoSuchSubjectException,
                    ConnectionException,
                    PolicyException,
                    SubjectNotUniqueException,
                    IDBeanException

Throws:

NoSuchSubjectException

ConnectionException

PolicyException

SubjectNotUniqueException

IDBeanException

getUser

public User getUser(javax.servlet.http.HttpServletRequest request,
                    java.util.Map<java.lang.String,java.lang.Object> appCtxMap)
             throws NoSuchSubjectException,
                    ConnectionException,
                    PolicyException,
                    SubjectNotUniqueException,
                    IDBeanException

Get user profile Retrieves User 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:

User 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

getUser

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

Throws:

NoSuchSubjectException

ConnectionException

PolicyException

SubjectNotUniqueException

IDBeanException

getUser

public User getUser(java.lang.String subjectID,
                    java.util.Map<java.lang.String,java.lang.Object> appCtxMap)
             throws IDBeanException,
                    NoSuchSubjectException,
                    SubjectNotUniqueException,
                    InvalidFilterException,
                    ConnectionException,
                    PolicyException

Get user profile Retrieves User from Attribute Authority for given SubjectID. SubjectID is the value for the PrimaryKey filter attribute in FindInteraction as defined in CARML document.

Parameters:

subjectID - ID of the subject that uniquely identifies User from Attribute Authority. This attribute is defined as PrimaryKey filter in findInteraction in CARML document.

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

Returns:

User for a given SubjectID

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 - 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.

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

IDBeanException - General IdentityManagement Exception

getUser

public User getUser(java.lang.String subjectID)
             throws IDBeanException,
                    NoSuchSubjectException,
                    SubjectNotUniqueException,
                    InvalidFilterException,
                    ConnectionException,
                    PolicyException

Throws:

IDBeanException

NoSuchSubjectException

SubjectNotUniqueException

InvalidFilterException

ConnectionException

PolicyException

exists

public boolean exists(User subj,
                      java.util.Map<java.lang.String,java.lang.Object> appCtxMap)
               throws ConnectionException,
                      PolicyException,
                      IDBeanException

Returns true if the User 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 User exists

Throws:

ConnectionException

PolicyException

IDBeanException

exists

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

Throws:

ConnectionException

PolicyException

IDBeanException

isCreateUserSupported

public boolean isCreateUserSupported()

Check if create User is supported

Returns:

true if User creation is supported

isModifyUserSupported

public boolean isModifyUserSupported()

Check if modify User is supported

Returns:

true if User modification is supported

isDropUserSupported

public boolean isDropUserSupported()

Check if drop User is supported

Returns:

true if User deletion is supported

getManagementChain

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

Get Management Chain

Parameters:

user - User object

nLevels - Maximum number of nested levels. If set to 0, will fetch the matching entries from all nested levels

manager - manager filter value. Fetches the nested level objects until either the manager filter value matches or reaches the maximum input levels

title - title filter value. Fetches the nested level objects until either the title filter value matches or reaches the maximum input levels

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

getManagementChain

public java.util.List<User> getManagementChain(User user,
                                               int nLevels,
                                               java.lang.String manager,
                                               java.lang.String title)
                                        throws ConnectionException,
                                               PolicyException,
                                               SubjectNotUniqueException,
                                               IDBeanException,
                                               InvalidFilterException

Throws:

ConnectionException

PolicyException

SubjectNotUniqueException

IDBeanException

InvalidFilterException

getReportees

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

Get Reportees

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 Users

Throws:

ConnectionException

PolicyException

SubjectNotUniqueException

IDBeanException

InvalidFilterException

getReportees

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

Throws:

ConnectionException

PolicyException

SubjectNotUniqueException

IDBeanException

InvalidFilterException

isManager

public boolean isManager(User user,
                         User manager,
                         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 user2 is manager of user1

Parameters:

user - User object

manager - 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 'user'

Throws:

ConnectionException

PolicyException

SubjectNotUniqueException

IDBeanException

java.io.FileNotFoundException

java.net.URISyntaxException

java.lang.IllegalAccessException

InvalidFilterException

isManager

public boolean isManager(User user,
                         User manager,
                         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