public class ExactMatchIdentityMapper extends IdentityMapper<ExactMatchIdentityMapperCfg> implements ConfigurationChangeListener<ExactMatchIdentityMapperCfg>
Constructor and Description |
---|
ExactMatchIdentityMapper()
Creates a new instance of this exact match identity mapper.
|
Modifier and Type | Method and Description |
---|---|
ConfigChangeResult |
applyConfigurationChange(ExactMatchIdentityMapperCfg configuration)
Applies the configuration changes to this change listener.
|
void |
finalizeIdentityMapper()
Performs any finalization that may be necessary for this identity mapper.
|
Entry |
getEntryForID(String id)
Retrieves the user entry that was mapped to the provided identification string.
|
void |
initializeIdentityMapper(ExactMatchIdentityMapperCfg configuration)
Initializes this identity mapper based on the information in the provided configuration entry.
|
boolean |
isConfigurationAcceptable(ExactMatchIdentityMapperCfg configuration,
List<LocalizableMessage> unacceptableReasons)
Indicates whether the provided configuration is acceptable for this identity mapper.
|
boolean |
isConfigurationChangeAcceptable(ExactMatchIdentityMapperCfg configuration,
List<LocalizableMessage> unacceptableReasons)
Indicates whether the proposed change to the configuration is acceptable
to this change listener.
|
public ExactMatchIdentityMapper()
initializeIdentityMapper
method.public void initializeIdentityMapper(ExactMatchIdentityMapperCfg configuration) throws ConfigException, InitializationException
IdentityMapper
initializeIdentityMapper
in class IdentityMapper<ExactMatchIdentityMapperCfg>
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 void finalizeIdentityMapper()
IdentityMapper
finalizeIdentityMapper
in class IdentityMapper<ExactMatchIdentityMapperCfg>
public Entry getEntryForID(String id) throws LdapException
getEntryForID
in class IdentityMapper<ExactMatchIdentityMapperCfg>
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.public boolean isConfigurationAcceptable(ExactMatchIdentityMapperCfg configuration, List<LocalizableMessage> unacceptableReasons)
IdentityMapper
isConfigurationAcceptable
in class IdentityMapper<ExactMatchIdentityMapperCfg>
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 boolean isConfigurationChangeAcceptable(ExactMatchIdentityMapperCfg configuration, List<LocalizableMessage> unacceptableReasons)
ConfigurationChangeListener
isConfigurationChangeAcceptable
in interface ConfigurationChangeListener<ExactMatchIdentityMapperCfg>
configuration
- The new configuration containing the changes.unacceptableReasons
- A list that can be used to hold messages about why the
provided configuration is not acceptable.true
if the proposed change is acceptable,
or false
if it is not.public ConfigChangeResult applyConfigurationChange(ExactMatchIdentityMapperCfg configuration)
ConfigurationChangeListener
applyConfigurationChange
in interface ConfigurationChangeListener<ExactMatchIdentityMapperCfg>
configuration
- The new configuration containing the changes.Copyright 2010-2022 ForgeRock AS.