|
Oracle Fusion Middleware Identity Governance Framework UserRole API Reference 11g Release 1 (11.1.1) E16591-02 |
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.openliberty.arisidbeans.IGFObjectManager oracle.igf.userrole.UserManager
public class UserManager
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 |
---|
public UserManager() throws java.io.FileNotFoundException, java.net.URISyntaxException, java.lang.IllegalAccessException, IDBeanException
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 Exceptionpublic UserManager(java.util.Map<java.lang.String,java.lang.Object> properties) throws java.io.FileNotFoundException, java.net.URISyntaxException, java.lang.IllegalAccessException, IDBeanException
properties
- Map with IdentityBeans parameter values
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 Exceptionpublic 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
carmlFile
- CARML file with location from which this User bean has
been generatedproperties
- Map with IdentityBeans parameter values
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 Exceptionpublic UserManager(java.net.URI carmlLoc, java.util.Map<java.lang.String,java.lang.Object> properties) throws java.io.FileNotFoundException, IDBeanException, java.lang.IllegalAccessException
carmlLoc
- URI of the CARML file from which this User bean has been
generatedproperties
- Map with IdentityBeans parameter values
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 ExceptionMethod Detail |
---|
public static java.lang.String getDefaultCarmlFile()
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
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 documentappCtxMap
- The application context as a hash map will contain Language constraint
if any and the Principal user.
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 Exceptionpublic java.util.List<User> searchUsersbyAllAttr(java.util.List<PropertyFilterValue> attrFiltersList) throws IDBeanException, ConnectionException, PolicyException, NoSuchSubjectException, SubjectNotUniqueException, InvalidFilterException
IDBeanException
ConnectionException
PolicyException
NoSuchSubjectException
SubjectNotUniqueException
InvalidFilterException
public User searchUser(java.lang.String loginid, java.util.Map<java.lang.String,java.lang.Object> appCtxMap) throws IDBeanException, NoSuchSubjectException, SubjectNotUniqueException, InvalidFilterException, ConnectionException, PolicyException
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.
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 Exceptionpublic User searchUser(java.lang.String loginid) throws IDBeanException, NoSuchSubjectException, SubjectNotUniqueException, InvalidFilterException, ConnectionException, PolicyException
IDBeanException
NoSuchSubjectException
SubjectNotUniqueException
InvalidFilterException
ConnectionException
PolicyException
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
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 documentappCtxMap
- The application context as a hash map will contain Language constraint
if any and the Principal user.
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 Exceptionpublic SearchResults<User> searchUsersbyAllAttrbyPage(java.util.List<PropertyFilterValue> attrFiltersList) throws IDBeanException, ConnectionException, PolicyException, NoSuchSubjectException, SubjectNotUniqueException, InvalidFilterException
IDBeanException
ConnectionException
PolicyException
NoSuchSubjectException
SubjectNotUniqueException
InvalidFilterException
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
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 principalattrValue
- Attribute Value to be set in Attribute Authority for the given
principalappCtxMap
- The application context as a hash map will contain Language constraint
if any and the Principal user.
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 Exceptionpublic void modifyUser(java.lang.String SubjectId, java.lang.String attrName, java.lang.String attrValue) throws ConnectionException, PolicyException, InvalidFilterException, NoSuchSubjectException, SubjectNotUniqueException, IDBeanException
ConnectionException
PolicyException
InvalidFilterException
NoSuchSubjectException
SubjectNotUniqueException
IDBeanException
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
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 documentappCtxMap
- The application context as a hash map will contain Language constraint
if any and the Principal user.
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 Exceptionpublic void modifyUser(java.lang.String SubjectId, java.util.List<ModPropertyValue> attrVals) throws IDBeanException, ConnectionException, PolicyException, NoSuchSubjectException, SubjectNotUniqueException, InvalidFilterException
IDBeanException
ConnectionException
PolicyException
NoSuchSubjectException
SubjectNotUniqueException
InvalidFilterException
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
principal
- Principal Identifier in the Digital SubjectattrName
- Attribute name to be modified for the given principalattrValue
- Attribute Value to be set in Attribute Authority for the given
principalappCtxMap
- The application context as a hash map will contain Language constraint
if any and the Principal user.
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 Exceptionpublic void modifyUser(IPrincipalIdentifier principal, java.lang.String attrName, java.lang.String attrValue) throws ConnectionException, PolicyException, NoSuchSubjectException, SubjectNotUniqueException, IDBeanException
ConnectionException
PolicyException
NoSuchSubjectException
SubjectNotUniqueException
IDBeanException
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
principal
- Principal Identifier in the Digital SubjectattrVals
- Array of attributes of the Digital Subject to be modified.
Attributes in this Array should exist in modifyInteraction in
CARML documentappCtxMap
- The application context as a hash map will contain Language constraint
if any and the Principal user.
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 Exceptionpublic void modifyUser(IPrincipalIdentifier principal, java.util.List<ModPropertyValue> attrVals) throws IDBeanException, ConnectionException, PolicyException, NoSuchSubjectException, SubjectNotUniqueException
IDBeanException
ConnectionException
PolicyException
NoSuchSubjectException
SubjectNotUniqueException
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
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 documentappCtxMap
- The application context as a hash map will contain Language constraint
if any and the Principal user.
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 Exceptionpublic SearchResults<User> searchUsersbyPage(java.util.List<PropertyFilterValue> attrFiltersList) throws IDBeanException, ConnectionException, PolicyException, NoSuchSubjectException, SubjectNotUniqueException, InvalidFilterException
IDBeanException
ConnectionException
PolicyException
NoSuchSubjectException
SubjectNotUniqueException
InvalidFilterException
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
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 documentappCtxMap
- The application context as a hash map will contain Language constraint
if any and the Principal user.
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 Exceptionpublic java.util.List<User> searchUsers(java.util.List<PropertyFilterValue> attrFiltersList) throws IDBeanException, ConnectionException, PolicyException, NoSuchSubjectException, SubjectNotUniqueException, InvalidFilterException
IDBeanException
ConnectionException
PolicyException
NoSuchSubjectException
SubjectNotUniqueException
InvalidFilterException
public IPrincipalIdentifier createUser(java.util.List<PropertyValue> attrVals, java.util.Map<java.lang.String,java.lang.Object> appCtxMap) throws IDBeanException, ConnectionException, PolicyException, SubjectNotUniqueException, NoSuchSubjectException
attrVals
- Array of attributes of the Digital Subject to be created.
Attributes being added should exist in addInteraction in CARML
documentappCtxMap
- The application context as a hash map will contain Language constraint
if any and the Principal user.
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 Exceptionpublic IPrincipalIdentifier createUser(java.util.List<PropertyValue> attrVals) throws IDBeanException, ConnectionException, PolicyException, SubjectNotUniqueException, NoSuchSubjectException
IDBeanException
ConnectionException
PolicyException
SubjectNotUniqueException
NoSuchSubjectException
public User searchUserByGuid(java.lang.String guid, java.util.Map<java.lang.String,java.lang.Object> appCtxMap) throws IDBeanException, NoSuchSubjectException, SubjectNotUniqueException, InvalidFilterException, ConnectionException, PolicyException
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.
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 Exceptionpublic User searchUserByGuid(java.lang.String guid) throws IDBeanException, NoSuchSubjectException, SubjectNotUniqueException, InvalidFilterException, ConnectionException, PolicyException
IDBeanException
NoSuchSubjectException
SubjectNotUniqueException
InvalidFilterException
ConnectionException
PolicyException
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
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 documentappCtxMap
- The application context as a hash map will contain Language constraint
if any and the Principal user.
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 Exceptionpublic SearchResults<User> searchUsersbyAnyAttrbyPage(java.util.List<PropertyFilterValue> attrFiltersList) throws IDBeanException, ConnectionException, PolicyException, NoSuchSubjectException, SubjectNotUniqueException, InvalidFilterException
IDBeanException
ConnectionException
PolicyException
NoSuchSubjectException
SubjectNotUniqueException
InvalidFilterException
public void dropUser(java.lang.String SubjectId, java.util.Map<java.lang.String,java.lang.Object> appCtxMap) throws NoSuchSubjectException, SubjectNotUniqueException, InvalidFilterException, IDBeanException, ConnectionException, PolicyException
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.
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 Exceptionpublic void dropUser(java.lang.String SubjectId) throws NoSuchSubjectException, SubjectNotUniqueException, InvalidFilterException, IDBeanException, ConnectionException, PolicyException
NoSuchSubjectException
SubjectNotUniqueException
InvalidFilterException
IDBeanException
ConnectionException
PolicyException
public void dropUser(IPrincipalIdentifier principal, java.util.Map<java.lang.String,java.lang.Object> appCtxMap) throws IDBeanException, ConnectionException, PolicyException, NoSuchSubjectException, SubjectNotUniqueException
principal
- Principal Identifier in the Digital SubjectappCtxMap
- The application context as a hash map will contain Language constraint
if any and the Principal user.
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 Exceptionpublic void dropUser(IPrincipalIdentifier principal) throws IDBeanException, ConnectionException, PolicyException, NoSuchSubjectException, SubjectNotUniqueException
IDBeanException
ConnectionException
PolicyException
NoSuchSubjectException
SubjectNotUniqueException
public void dropUser(User subj, java.util.Map<java.lang.String,java.lang.Object> appCtxMap) throws IDBeanException, ConnectionException, PolicyException, NoSuchSubjectException, SubjectNotUniqueException
subj
- User object to be deleted from Attribute AuthorityappCtxMap
- The application context as a hash map will contain Language constraint
if any and the Principal user.
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 Exceptionpublic void dropUser(User subj) throws IDBeanException, ConnectionException, PolicyException, NoSuchSubjectException, SubjectNotUniqueException
IDBeanException
ConnectionException
PolicyException
NoSuchSubjectException
SubjectNotUniqueException
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
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 documentappCtxMap
- The application context as a hash map will contain Language constraint
if any and the Principal user.
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 Exceptionpublic java.util.List<User> searchUsersbyAnyAttr(java.util.List<PropertyFilterValue> attrFiltersList) throws IDBeanException, ConnectionException, PolicyException, NoSuchSubjectException, SubjectNotUniqueException, InvalidFilterException
IDBeanException
ConnectionException
PolicyException
NoSuchSubjectException
SubjectNotUniqueException
InvalidFilterException
public User getUser(IPrincipalIdentifier principal, java.util.Map<java.lang.String,java.lang.Object> appCtxMap) throws NoSuchSubjectException, ConnectionException, PolicyException, SubjectNotUniqueException, IDBeanException
principal
- Principal Identifier in the Digital SubjectappCtxMap
- The application context as a hash map will contain Language constraint
if any and the Principal user.
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 Exceptionpublic User getUser(IPrincipalIdentifier principal) throws NoSuchSubjectException, ConnectionException, PolicyException, SubjectNotUniqueException, IDBeanException
NoSuchSubjectException
ConnectionException
PolicyException
SubjectNotUniqueException
IDBeanException
public User getUser(javax.servlet.http.HttpServletRequest request, java.util.Map<java.lang.String,java.lang.Object> appCtxMap) throws NoSuchSubjectException, ConnectionException, PolicyException, SubjectNotUniqueException, IDBeanException
request
- HttpServerletRequest object to be parsed for a Subject contextappCtxMap
- The application context as a hash map will contain Language constraint
if any and the Principal user.
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 Exceptionpublic User getUser(javax.servlet.http.HttpServletRequest request) throws NoSuchSubjectException, ConnectionException, PolicyException, SubjectNotUniqueException, IDBeanException
NoSuchSubjectException
ConnectionException
PolicyException
SubjectNotUniqueException
IDBeanException
public User getUser(java.lang.String subjectID, java.util.Map<java.lang.String,java.lang.Object> appCtxMap) throws IDBeanException, NoSuchSubjectException, SubjectNotUniqueException, InvalidFilterException, ConnectionException, PolicyException
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.
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 Exceptionpublic User getUser(java.lang.String subjectID) throws IDBeanException, NoSuchSubjectException, SubjectNotUniqueException, InvalidFilterException, ConnectionException, PolicyException
IDBeanException
NoSuchSubjectException
SubjectNotUniqueException
InvalidFilterException
ConnectionException
PolicyException
public boolean exists(User subj, java.util.Map<java.lang.String,java.lang.Object> appCtxMap) throws ConnectionException, PolicyException, IDBeanException
subj
- Subject to be verified if exists in Attribute AuthorityappCtxMap
- The application context as a hash map will contain Language constraint
if any and the Principal user.
ConnectionException
PolicyException
IDBeanException
public boolean exists(User subj) throws ConnectionException, PolicyException, IDBeanException
ConnectionException
PolicyException
IDBeanException
public boolean isCreateUserSupported()
public boolean isModifyUserSupported()
public boolean isDropUserSupported()
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
user
- User objectnLevels
- Maximum number of nested levels. If set to 0, will
fetch the matching entries from all nested levelsmanager
- manager filter value. Fetches the nested level
objects until either the manager filter value
matches or reaches the maximum input levelstitle
- title filter value. Fetches the nested level
objects until either the title filter value
matches or reaches the maximum input levelsappCtxMap
- The application context as a hash map will contain Language
constraint if any and the Principal user.
ConnectionException
PolicyException
SubjectNotUniqueException
IDBeanException
InvalidFilterException
public java.util.List<User> getManagementChain(User user, int nLevels, java.lang.String manager, java.lang.String title) throws ConnectionException, PolicyException, SubjectNotUniqueException, IDBeanException, InvalidFilterException
ConnectionException
PolicyException
SubjectNotUniqueException
IDBeanException
InvalidFilterException
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
user
- User objectnLevels
- Maximum number of nested levels. If set to 0, will
fetch the matching entries from all nested levelsappCtxMap
- The application context as a hash map will contain Language
constraint if any and the Principal user.
ConnectionException
PolicyException
SubjectNotUniqueException
IDBeanException
InvalidFilterException
public java.util.List<User> getReportees(User user, int nLevels) throws ConnectionException, PolicyException, SubjectNotUniqueException, IDBeanException, InvalidFilterException
ConnectionException
PolicyException
SubjectNotUniqueException
IDBeanException
InvalidFilterException
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
user
- User objectmanager
- User objectdirect
- true - to check only one level objects
false - to check all nested levelsappCtxMap
- The application context as a hash map will contain Language constraint
if any and the Principal user.
ConnectionException
PolicyException
SubjectNotUniqueException
IDBeanException
java.io.FileNotFoundException
java.net.URISyntaxException
java.lang.IllegalAccessException
InvalidFilterException
public boolean isManager(User user, User manager, boolean direct) throws ConnectionException, PolicyException, SubjectNotUniqueException, IDBeanException, java.io.FileNotFoundException, java.net.URISyntaxException, java.lang.IllegalAccessException, InvalidFilterException
ConnectionException
PolicyException
SubjectNotUniqueException
IDBeanException
java.io.FileNotFoundException
java.net.URISyntaxException
java.lang.IllegalAccessException
InvalidFilterException
|
Oracle Fusion Middleware Identity Governance Framework UserRole API Reference 11g Release 1 (11.1.1) E16591-02 |
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |