Package com.sun.identity.plugin.datastore.impl

Class IdRepoDataStoreProvider

java.lang.Object

com.sun.identity.plugin.datastore.impl.IdRepoDataStoreProvider

All Implemented Interfaces:

DataStoreProvider

public class IdRepoDataStoreProvider
extends Object
implements DataStoreProvider

The IdRepoDataStoreProvider is an implementation of DataStoreProvider using IdRepo APIs. It can be used for getting/setting user attributes, as well as searching user.

See Also:

DataStoreProvider

Constructor Summary

Constructors

Constructor	Description
IdRepoDataStoreProvider()	Default Constructor.

Method Summary

Modifier and Type	Method	Description
Set<String>	getAttribute(String userID, String attrName)	Returns values for a given attribute.
Map<String,Set<String>>	getAttributes(String userID, Set<String> attrNames)	Returns attribute values for a user.
byte[][]	getBinaryAttribute(String userID, String attrName)	Returns binary values for a given attribute.
Map<String,byte[][]>	getBinaryAttributes(String userID, Set<String> attrNames)	Returns binary attribute values for a user.
String	getUserID(String orgDN, Map<String,Set<String>> avPairs)	Returns user matching the search criteria.
void	init(String componentName)	Initializes the provider.
boolean	isUserExists(String userID)	Checks if a given user exists.
void	setAttributes(String userID, Map<String,Set<String>> attrMap)	Sets attributes for a user.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

IdRepoDataStoreProvider

public IdRepoDataStoreProvider()

Default Constructor.

Method Detail

init

public void init(String componentName)
          throws DataStoreProviderException

Initializes the provider.

Specified by:

init in interface DataStoreProvider

Parameters:

componentName - name of the component.

Throws:

DataStoreProviderException - if an error occurred during initialization.

getAttribute

public Set<String> getAttribute(String userID,
                                String attrName)
                         throws DataStoreProviderException

Returns values for a given attribute.

Specified by:

getAttribute in interface DataStoreProvider

Parameters:

userID - Universal identifier of the user.

attrName - Name of the attribute whose value to be retrieved.

Returns:

Set of the values for the attribute.

Throws:

DataStoreProviderException - if unable to retrieve the attribute.

getAttributes

public Map<String,Set<String>> getAttributes(String userID,
                                                   Set<String> attrNames)
                                            throws DataStoreProviderException

Returns attribute values for a user.

Specified by:

getAttributes in interface DataStoreProvider

Parameters:

userID - Universal identifier of the user.

attrNames - Set of attributes whose values are to be retrieved.

Returns:

Map containing attribute key/value pair, key is the attribute name, value is a Set of values.

Throws:

DataStoreProviderException - if unable to retrieve the values.

getBinaryAttribute

public byte[][] getBinaryAttribute(String userID,
                                   String attrName)
                            throws DataStoreProviderException

Returns binary values for a given attribute.

Specified by:

getBinaryAttribute in interface DataStoreProvider

Parameters:

userID - Universal identifier of the user.

attrName - Name of the attribute whose value to be retrieved.

Returns:

A byte array of the byte values for the attribute.

Throws:

DataStoreProviderException - if unable to retrieve the attribute.

getBinaryAttributes

public Map<String,byte[][]> getBinaryAttributes(String userID,
                                                      Set<String> attrNames)
                                               throws DataStoreProviderException

Returns binary attribute values for a user.

Specified by:

getBinaryAttributes in interface DataStoreProvider

Parameters:

userID - Universal identifier of the user.

attrNames - Set of attributes whose values are to be retrieved.

Returns:

Map containing attribute key/value pair, key is the attribute name, value is a Set of byte[][] values.

Throws:

DataStoreProviderException - if unable to retrieve the values.

setAttributes

public void setAttributes(String userID,
                          Map<String,Set<String>> attrMap)
                   throws DataStoreProviderException

Sets attributes for a user.

Specified by:

setAttributes in interface DataStoreProvider

Parameters:

userID - Universal identifier of the user.

attrMap - Map of attributes to be set, key is the attribute name and value is a Set containing the attribute values.

Throws:

DataStoreProviderException - if unable to set values.

getUserID

public String getUserID(String orgDN,
                        Map<String,Set<String>> avPairs)
                 throws DataStoreProviderException

Returns user matching the search criteria.

Specified by:

getUserID in interface DataStoreProvider

Parameters:

orgDN - The realm to search the user. If null, searches the root realm.

avPairs - Attribute key/value pairs that will be used for searching the user. Key is the attribute name, value is a Set containing attribute value(s).

Returns:

Universal identifier of the matching user, null if the matching user could not be found.

Throws:

DataStoreProviderException - if error occurs during search or multiple matching users found.

isUserExists

public boolean isUserExists(String userID)
                     throws DataStoreProviderException

Checks if a given user exists.

Specified by:

isUserExists in interface DataStoreProvider

Parameters:

userID - Universal identifier of the user to be checked.

Returns:

true if the user exists.

Throws:

DataStoreProviderException - if an error occurred.