com.sun.identity.plugin.datastore
Interface DataStoreProvider

public interface DataStoreProvider

Interface used for storing & retrieving information. Also used to search user.

Method Summary

Set	getAttribute(String userID, String attrName) Gets user attribute.
Map	getAttributes(String userID, Set attrNames) Gets user attributes.
String	getUserID(String orgDN, Map avPairs) Searches user.
void	init(String componentName) Initializes the provider.
boolean	isUserExists(String userID) Checks if the user exists with a given userid.
void	setAttributes(String userID, Map attrMap) Sets user attrbiutes.

Method Detail

init

void init(String componentName)
          throws DataStoreProviderException

Initializes the provider.

Parameters:

componentName - Component name, such as saml, saml2, id-ff, disco, authnsvc, and idpp.

Throws:

DataStoreProviderException - if an error occurred during initialization.

getAttribute

Set getAttribute(String userID,
                 String attrName)
                 throws DataStoreProviderException

Gets user attribute.

Parameters:

userID - ID value for the user.

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

Returns:

Set of the values for the attribute.

Throws:

DataStoreProviderException - if an error occurred.

getAttributes

Map getAttributes(String userID,
                  Set attrNames)
                  throws DataStoreProviderException

Gets user attributes.

Parameters:

userID - ID value for the user.

attrNames - The Set of attribute names.

Returns:

Map of specified attributes. Map key is the attribute name and value is the attribute value Set.

Throws:

DataStoreProviderException - if an error occurred.

setAttributes

void setAttributes(String userID,
                   Map attrMap)
                   throws DataStoreProviderException

Sets user attrbiutes.

Parameters:

userID - ID value for the user.

attrMap - Map of specified attrbibutes to be set. Map key is the attribute name and value is the attribute value Set.

Throws:

DataStoreProviderException - if an error occurred.

getUserID

String getUserID(String orgDN,
                 Map avPairs)
                 throws DataStoreProviderException

Searches user.

Parameters:

orgDN - The organization to search the user.

avPairs - Attribute value pairs that will be used for searching the user.

Throws:

DataStoreProviderException - if an error occurred.

isUserExists

boolean isUserExists(String userID)
                     throws DataStoreProviderException

Checks if the user exists with a given userid.

Parameters:

userID - ID of an user

Returns:

true if the user exists; false otherwise.

Throws:

DataStoreProviderException - if an error occurred.