T
- The type of configuration handled by this certificate mapper.@PublicAPI(stability=VOLATILE, mayInstantiate=false, mayExtend=true, mayInvoke=false) public abstract class CertificateMapper<T extends org.forgerock.opendj.server.config.server.CertificateMapperCfg> extends Object
Constructor and Description |
---|
CertificateMapper() |
Modifier and Type | Method and Description |
---|---|
void |
finalizeCertificateMapper()
Performs any finalization that may be necessary for this certificate mapper.
|
abstract void |
initializeCertificateMapper(T configuration)
Initializes this certificate 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 certificate mapper.
|
abstract Entry |
mapCertificateToUser(Certificate[] certificateChain)
Establishes a mapping between the information in the provided certificate chain and a single user entry in the
Directory Server.
|
public abstract void initializeCertificateMapper(T configuration) throws org.forgerock.opendj.config.server.ConfigException, InitializationException
configuration
- The configuration that should be used to intialize this certificate mapper.org.forgerock.opendj.config.server.ConfigException
- If the provided entry does not contain a valid certificate mapper configuration.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 certificate 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 certificate mapper, or false
if
not.public void finalizeCertificateMapper()
public abstract Entry mapCertificateToUser(Certificate[] certificateChain) throws DirectoryException
certificateChain
- The certificate chain presented by the client during SSL negotiation. The peer certificate will be
listed first, followed by the ordered issuer chain as appropriate.null
if no mapping was established
and no special message is required to send back to the client.DirectoryException
- If a problem occurred while attempting to establish the mapping. This may include internal failures,
a mapping which matches multiple users, or any other case in which an error message should be
returned to the client.Copyright © 2010–2017 ForgeRock AS. All rights reserved.