IdentityStoreContext (Oracle Access Manager Extensibility Java API Reference)

Class

Use

Tree

Help

Oracle Fusion Middleware Extensibility Java API Reference for Oracle Access Management Access Manager
11g Release 2 (11.1.2)
E27137-01

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

oracle.security.am.engines.common.identity.api
Interface IdentityStoreContext

public interface IdentityStoreContext

IdentityStoreContext will expose the OAM Identitystore operation that are essential for the plug-ins. Only read operations and authentication operations will be exposed.

Since:: OAM 11.1.1.2.0

Method Summary
`boolean`	`authenticateUser(java.lang.String userName, java.lang.String password)`
`IdmUser`	`authenticateUserByName(java.lang.String userName, java.lang.String password)`
`java.util.List<java.lang.String>`	`getGroups(int startIndex)`
`java.util.List<java.lang.String>`	`getGroupsForUser(java.lang.String username)`
`AMIdentiyStoreHandle`	`getIdentityStoreHandle()`
`AMIdentiyStoreHandle`	`getIdentityStoreHandle(java.lang.String id)`
`java.util.Map<java.lang.String,java.lang.String>`	`getUserAttributes(IdmUser user, java.util.List<java.lang.String> attributeNames)`
`java.util.List<IdmUser>`	`getUsersByAttribute(java.lang.String attrName, java.lang.String attrValue)`
`UserInfo`	`locateUser(java.lang.String userId)`
`java.util.Collection<UserInfo>`	`locateUser(java.lang.String attribute, java.lang.String value)`
`void`	`modifyUserAttribute(java.lang.String userName, java.lang.String attributeName, java.lang.String attributeValue)` Modify user attribute.
`void`	`modifyUserMultiAttribute(java.lang.String userName, java.lang.String attributeName, java.util.List<java.lang.String> deleteVals, java.util.List<java.lang.String> addVals)` Update user multi-valued attribute .

Method Detail

getIdentityStoreHandle

AMIdentiyStoreHandle getIdentityStoreHandle()

getIdentityStoreHandle

AMIdentiyStoreHandle getIdentityStoreHandle(java.lang.String id)

authenticateUser

boolean authenticateUser(java.lang.String userName,
                         java.lang.String password)
                         throws IdentityProviderException

Throws:: IdentityProviderException

authenticateUserByName

IdmUser authenticateUserByName(java.lang.String userName,
                               java.lang.String password)
                               throws IdentityProviderException

Throws:: IdentityProviderException

modifyUserAttribute

void modifyUserAttribute(java.lang.String userName,
                         java.lang.String attributeName,
                         java.lang.String attributeValue)
                         throws IdentityProviderException

Modify user attribute.

Parameters:: userName - the user name; attributeName - the attribute name; attributeValue - the attribute value
Throws:: IdentityProviderException

modifyUserMultiAttribute

void modifyUserMultiAttribute(java.lang.String userName,
                              java.lang.String attributeName,
                              java.util.List<java.lang.String> deleteVals,
                              java.util.List<java.lang.String> addVals)
                              throws IdentityProviderException

Update user multi-valued attribute . This means adding some attributes and removing some.

Parameters:: userName - the user name; attributeName - the attribute name; attributeValue - the attribute value
Throws:: IdentityProviderException

locateUser

UserInfo locateUser(java.lang.String userId)
                    throws IdentityProviderException

Throws:: IdentityProviderException

locateUser

java.util.Collection<UserInfo> locateUser(java.lang.String attribute,
                                          java.lang.String value)
                                          throws IdentityProviderException

Throws:: IdentityProviderException

getUserAttributes

java.util.Map<java.lang.String,java.lang.String> getUserAttributes(IdmUser user,
                                                                   java.util.List<java.lang.String> attributeNames)
                                                                   throws IdentityProviderException

Throws:: IdentityProviderException

getGroups

java.util.List<java.lang.String> getGroups(int startIndex)
                                           throws IdentityProviderException

Throws:: IdentityProviderException

getGroupsForUser

java.util.List<java.lang.String> getGroupsForUser(java.lang.String username)
                                                  throws IdentityProviderException

Throws:: IdentityProviderException

getUsersByAttribute

java.util.List<IdmUser> getUsersByAttribute(java.lang.String attrName,
                                            java.lang.String attrValue)
                                            throws IdentityProviderException