|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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 |
---|
void init(String componentName) throws DataStoreProviderException
componentName
- Component name, such as saml, saml2, id-ff, disco,
authnsvc, and idpp.
DataStoreProviderException
- if an error occurred during
initialization.Set getAttribute(String userID, String attrName) throws DataStoreProviderException
userID
- ID value for the user.attrName
- Name of the attribute whose value to be retrieved.
DataStoreProviderException
- if an error occurred.Map getAttributes(String userID, Set attrNames) throws DataStoreProviderException
userID
- ID value for the user.attrNames
- The Set of attribute names.
DataStoreProviderException
- if an error occurred.void setAttributes(String userID, Map attrMap) throws DataStoreProviderException
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.
DataStoreProviderException
- if an error occurred.String getUserID(String orgDN, Map avPairs) throws DataStoreProviderException
orgDN
- The organization to search the user.avPairs
- Attribute value pairs that will be used for searching
the user.
DataStoreProviderException
- if an error occurred.boolean isUserExists(String userID) throws DataStoreProviderException
userID
- ID of an user
true
if the user exists; false
otherwise.
DataStoreProviderException
- if an error occurred.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |