Skip navigation links

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

public interface AMIdentiyStoreHandle

Handle to an Identity store.

Since:

OAM 11.1.1.2.0

Method Summary

void	assignUserToGroup(java.lang.String userName, java.lang.String groupName) This method assigns a user to a group
boolean	authenticateUser(java.lang.String userName, java.lang.String password) Method to authenticate a user with user name and password.
IdmUser	authenticateUserByName(java.lang.String userName, java.lang.String password) Method to authenticate a user with user name and password.
void	createGroup(java.lang.String groupName) This method creates a group with the specified name and attributes.
IdmUser	createUser(java.lang.String username, java.lang.String password) This method creates a user
java.util.List<java.lang.String>	getGroups(int startIndex) Retrieves groups from a start index.
java.util.List<java.lang.String>	getGroups(int startIndex, int batchSize) Retrieves groups from a start index and a batch size.
java.util.List<java.lang.String>	getGroupsForUser(java.lang.String username) Retrieves groups for a user.
java.util.Map<java.lang.String,java.lang.Object>	getRoleMappings() Retrieves all role mappings.
java.util.List<java.lang.String>	getRoles(java.lang.String roleSearchString) get roles with a search string.
java.util.Map<java.lang.String,java.lang.String>	getUserAttributes(IdmUser user, java.util.List<java.lang.String> attributeNames) gets user attributes.
java.util.List<UserInfo>	getUserList(int startIndex) gets user list.
java.util.List<UserInfo>	getUserList(int startIndex, int batchSize) gets user list.
java.util.List<java.lang.String>	getUsers(int startIndex) gets users.
java.util.List<java.lang.String>	getUsers(int startIndex, int batchSize) Retrieves users.
java.util.List<java.lang.String>	getUsers(java.lang.String searchString) Retrieves users.
java.util.List<IdmUser>	getUsersByAttribute(java.lang.String attrName, java.lang.String attrValue) Retrieves user by an attribute value.
boolean	isUserAssignedToGroup(java.lang.String group, java.lang.String username) Checks if the user is assigned a group.
UserInfo	locateUser(java.lang.String userId) Returns the user denoted by the userId
java.util.Collection<UserInfo>	locateUser(java.lang.String attribute, java.lang.String value) Returns a collection of users which match the attribute, value specified.
java.util.Collection<UserInfo>	locateUser(java.lang.String searchFilter, java.lang.String[] args) Returns a collection of user entries returned by running the search filter with the specified arguments.
java.util.Collection<UserInfo>	locateUser(java.lang.String searchBase, java.lang.String searchFilter, java.lang.String[] args) Returns a collection of user entries under the specified search base by running the search filter with arguments specified.
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 .
void	modifyUserMultiAttribute(UserInfo userInfo, java.lang.String attributeName, java.util.List<java.lang.String> deleteVals, java.util.List<java.lang.String> addVals) Update user multi-valued attribute .
void	removeGroup(java.lang.String group) This method removes a group
void	removeUser(java.lang.String username) This method removes a user

Method Detail

authenticateUser

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

Method to authenticate a user with user name and password.

Parameters:

userName -

password -

Returns:

a boolean value.

Throws:

IdentityProviderException

authenticateUserByName

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

Method to authenticate a user with user name and password.

Parameters:

userName -

password -

Returns:

a IdmUser object.

Throws:

IdentityProviderException

getGroups

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

Retrieves groups from a start index.

Parameters:

startIndex -

Returns:

a List<String> object.

Throws:

IdentityProviderException

getGroups

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

Retrieves groups from a start index and a batch size.

Parameters:

startIndex -

batchSize -

Returns:

a List<String> object.

Throws:

IdentityProviderException

getGroupsForUser

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

Retrieves groups for a user.

Parameters:

username -

Returns:

a List<String> object.

Throws:

IdentityProviderException

getRoleMappings

java.util.Map<java.lang.String,java.lang.Object> getRoleMappings()
                                                                 throws IdentityProviderException

Retrieves all role mappings.

Returns:

a Map<String, Object> object.

Throws:

IdentityProviderException

getRoles

java.util.List<java.lang.String> getRoles(java.lang.String roleSearchString)
                                          throws IdentityProviderException

get roles with a search string.

Parameters:

roleSearchString -

Returns:

a List<String> object.

Throws:

IdentityProviderException

getUserAttributes

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

gets user attributes.

Parameters:

user -

attributeNames -

Returns:

a Map<String, Object> object.

Throws:

IdentityProviderException

getUserList

java.util.List<UserInfo> getUserList(int startIndex)
                                     throws IdentityProviderException

gets user list.

Parameters:

startIndex -

Returns:

a List<UserInfo> object.

Throws:

IdentityProviderException

getUserList

java.util.List<UserInfo> getUserList(int startIndex,
                                     int batchSize)
                                     throws IdentityProviderException

gets user list.

Parameters:

startIndex -

batchSize -

Returns:

a List<UserInfo> object.

Throws:

IdentityProviderException

getUsers

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

gets users.

Parameters:

startIndex -

Returns:

a List<String> object.

Throws:

IdentityProviderException

getUsers

java.util.List<java.lang.String> getUsers(int startIndex,
                                          int batchSize)
                                          throws IdentityProviderException

Retrieves users.

Parameters:

startIndex -

batchSize -

Returns:

a List<String> object.

Throws:

IdentityProviderException

getUsers

java.util.List<java.lang.String> getUsers(java.lang.String searchString)
                                          throws IdentityProviderException

Retrieves users.

Parameters:

searchString -

Returns:

a List<String> object.

Throws:

IdentityProviderException

getUsersByAttribute

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

Retrieves user by an attribute value.

Parameters:

attrName -

attrValue -

Returns:

a List<IdmUser> object.

Throws:

IdentityProviderException

isUserAssignedToGroup

boolean isUserAssignedToGroup(java.lang.String group,
                              java.lang.String username)
                              throws IdentityProviderException

Checks if the user is assigned a group.

Parameters:

group -

username -

Returns:

a boolean object.

Throws:

IdentityProviderException

createGroup

void createGroup(java.lang.String groupName)
                 throws IdentityProviderException

This method creates a group with the specified name and attributes.

Parameters:

groupName - The name of the group.

attributes - The map of attribute names and values.

Throws:

IdentityProviderException

createUser

IdmUser createUser(java.lang.String username,
                   java.lang.String password)
                   throws IdentityProviderException

This method creates a user

Parameters:

username -

password -

Returns:

a IdmUser object.

Throws:

IdentityProviderException

removeUser

void removeUser(java.lang.String username)
                throws IdentityProviderException

This method removes a user

Parameters:

username -

Throws:

IdentityProviderException

removeGroup

void removeGroup(java.lang.String group)
                 throws IdentityProviderException

This method removes a group

Parameters:

group -

Throws:

IdentityProviderException

assignUserToGroup

void assignUserToGroup(java.lang.String userName,
                       java.lang.String groupName)
                       throws IdentityProviderException

This method assigns a user to a group

Parameters:

userName -

groupName -

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

modifyUserMultiAttribute

void modifyUserMultiAttribute(UserInfo userInfo,
                              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:

userInfo - the userinfo object

attributeName - the attribute name

attributeValue - the attribute value

Throws:

IdentityProviderException

locateUser

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

Returns the user denoted by the userId

Parameters:

userId - The id of the user to be located.

Returns:

UserInfo The located user.

Throws:

IdentityProviderException

locateUser

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

Returns a collection of users which match the attribute, value specified. Same as getUsersByAttribute ()

Parameters:

attribute - The attribute that needs to be matched.

value - The value of the attribute specified that needs to be matched.

Returns:

Collection<UserInfo> The collection of users that match the attribute and value specified

Throws:

IdentityProviderException

locateUser

java.util.Collection<UserInfo> locateUser(java.lang.String searchFilter,
                                          java.lang.String[] args)
                                          throws IdentityProviderException

Returns a collection of user entries returned by running the search filter with the specified arguments.

Parameters:

searchFilter - The search filter to be used for locating users.

args - The arguments for the search filter.

Returns:

Collection<UserInfo> The collection of users that where located with the specified search filter and arguments.

Throws:

IdentityProviderException

locateUser

java.util.Collection<UserInfo> locateUser(java.lang.String searchBase,
                                          java.lang.String searchFilter,
                                          java.lang.String[] args)
                                          throws IdentityProviderException

Returns a collection of user entries under the specified search base by running the search filter with arguments specified.

Parameters:

searchBase - The search base for locating the user.

searchFilter - The search filter for locating the user.

args - The arguments to the search filter for locating the user.

Returns:

Collection<UserInfo> The collection of users located with the specified search filter at the specified search base.

Throws:

IdentityProviderException

Skip navigation links