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> extends Object
Constructor and Description |
---|
IdentityMapper() |
Modifier and Type | Method and Description |
---|---|
void |
finalizeIdentityMapper()
Performs any finalization that may be necessary for this identity mapper.
|
abstract Entry |
getEntryForID(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(T configuration,
List<LocalizableMessage> unacceptableReasons)
Indicates whether the provided configuration is acceptable for this identity mapper.
|
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(T configuration, List<LocalizableMessage> 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(String id) throws LdapException
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.LdapException
- 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.Copyright 2010-2022 ForgeRock AS.