|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.opends.server.api.CertificateMapper<T>
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 CertificateMapperCfg>
This class defines the set of methods and structures that must be implemented by a Directory Server module that implements the functionality required to uniquely map an SSL client certificate to a Directory Server user entry.
Constructor Summary | |
---|---|
CertificateMapper()
|
Method Summary | |
---|---|
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(CertificateMapperCfg configuration,
java.util.List<Message> unacceptableReasons)
Indicates whether the provided configuration is acceptable for this certificate mapper. |
abstract Entry |
mapCertificateToUser(java.security.cert.Certificate[] certificateChain)
Establishes a mapping between the information in the provided certificate chain and a single user entry in the Directory Server. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public CertificateMapper()
Method Detail |
---|
public abstract void initializeCertificateMapper(T configuration) throws ConfigException, InitializationException
configuration
- The configuration that should be used to
intialize this certificate mapper.
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(CertificateMapperCfg configuration, java.util.List<Message> 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(java.security.cert.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.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |