|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.opends.server.api.IdentityMapper<T>
T
- The type of configuration handled by this identity
mapper.@PublicAPI(stability=VOLATILE, mayInstantiate=false, mayExtend=true, mayInvoke=true) public abstract class IdentityMapper<T extends IdentityMapperCfg>
This class defines the set of methods and structures that must be implemented by a Directory Server identity mapper. An identity mapper is used to identify exactly one user associated with a given identification value. This API may be used by a number of SASL mechanisms to identify the user that is authenticating to the server. It may also be used in other areas, like in conjunction with the proxied authorization control.
Constructor Summary | |
---|---|
IdentityMapper()
|
Method Summary | |
---|---|
void |
finalizeIdentityMapper()
Performs any finalization that may be necessary for this identity mapper. |
abstract Entry |
getEntryForID(java.lang.String id)
Retrieves the user entry that was mapped to the provided identification string. |
abstract void |
initializeIdentityMapper(T configuration)
Initializes this identity mapper based on the information in the provided configuration entry. |
boolean |
isConfigurationAcceptable(IdentityMapperCfg configuration,
java.util.List<Message> unacceptableReasons)
Indicates whether the provided configuration is acceptable for this identity mapper. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public IdentityMapper()
Method Detail |
---|
public abstract void initializeIdentityMapper(T configuration) throws ConfigException, InitializationException
configuration
- The configuration for the identity mapper.
ConfigException
- If an unrecoverable problem arises in
the process of performing the
initialization.
InitializationException
- If a problem occurs during
initialization that is not
related to the server
configuration.public boolean isConfigurationAcceptable(IdentityMapperCfg configuration, java.util.List<Message> unacceptableReasons)
configuration
- The identity mapper configuration
for which to make the determination.unacceptableReasons
- A list that may be used to hold the
reasons that the provided
configuration is not acceptable.
true
if the provided configuration is acceptable
for this identity mapper, or false
if not.public void finalizeIdentityMapper()
public abstract Entry getEntryForID(java.lang.String id) throws DirectoryException
id
- The identification string that is to be mapped to a
user.
null
if no users were found
that could be mapped to the provided ID.
DirectoryException
- If a problem occurs while attempting
to map the given ID to a user entry,
or if there are multiple user
entries that could map to the
provided ID.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |