Package org.opends.server.api

Class TrustManagerProvider<T extends TrustManagerProviderCfg>

java.lang.Object

org.opends.server.api.TrustManagerProvider<T>

Type Parameters:

T - The type of trust manager provider configuration handled by this trust manager provider implementation.

Direct Known Subclasses:

AdminDataTrustManagerProvider, BlindTrustManagerProvider, FileBasedTrustManagerProvider, JvmTrustManagerProvider, LDAPTrustManagerProvider, PemTrustManagerProvider, Pkcs11TrustManagerProvider

@PublicAPI(stability=VOLATILE,
           mayInstantiate=false,
           mayExtend=true,
           mayInvoke=true)
public abstract class TrustManagerProvider<T extends TrustManagerProviderCfg>
extends Object

This class defines an API that may be used to obtain a set of javax.net.ssl.TrustManager objects for use when performing SSL/StartTLS negotiation.

Constructor Summary

Constructors

Constructor	Description
TrustManagerProvider()

Method Summary

Modifier and Type	Method	Description
abstract void	finalizeTrustManagerProvider()	Performs any finalization that may be necessary for this trust manager provider.
protected ServerContext	getServerContext()	Returns the server context.
abstract TrustManager[]	getTrustManagers()	Retrieves a set of TrustManager objects that may be used for interactions requiring access to a trust manager.
protected abstract void	initializeTrustManagerProvider(T configuration)	Initializes this trust manager provider based on the information in the provided configuration entry.
void	initializeTrustManagerProvider(T configuration, ServerContext serverContext)	Initializes this trust manager provider based on the information in the provided trust manager provider configuration.
boolean	isConfigurationAcceptable(T configuration, List<LocalizableMessage> unacceptableReasons)	Indicates whether the provided configuration is acceptable for this trust manager provider.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TrustManagerProvider

public TrustManagerProvider()

Method Detail

initializeTrustManagerProvider

public final void initializeTrustManagerProvider(T configuration,
                                                 ServerContext serverContext)
                                          throws ConfigException,
                                                 InitializationException

Initializes this trust manager provider based on the information in the provided trust manager provider configuration.

Parameters:

configuration - The trust manager provider configuration that contains the information to use to initialize this trust manager provider.

serverContext - The server context.

Throws:

ConfigException - If an unrecoverable problem arises in the process of performing the initialization as a result of the server configuration.

InitializationException - If a problem occurs during initialization that is not related to the server configuration.

initializeTrustManagerProvider

protected abstract void initializeTrustManagerProvider(T configuration)
                                                throws ConfigException,
                                                       InitializationException

Initializes this trust manager provider based on the information in the provided configuration entry.

Parameters:

configuration - The configuration to use for this trust manager provider.

Throws:

ConfigException - If an unrecoverable problem arises in the process of performing the initialization as a result of the server configuration.

InitializationException - If a problem occurs during initialization that is not related to the server configuration.

isConfigurationAcceptable

public boolean isConfigurationAcceptable(T configuration,
                                         List<LocalizableMessage> unacceptableReasons)

Indicates whether the provided configuration is acceptable for this trust manager provider. It should be possible to call this method on an uninitialized trust manager provider instance in order to determine whether the trust manager provider would be able to use the provided configuration.

Parameters:

configuration - The trust manager provider 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.

Returns:

true if the provided configuration is acceptable for this trust manager provider, or false if not.

finalizeTrustManagerProvider

public abstract void finalizeTrustManagerProvider()

Performs any finalization that may be necessary for this trust manager provider.

getTrustManagers

public abstract TrustManager[] getTrustManagers()
                                         throws LdapException

Retrieves a set of TrustManager objects that may be used for interactions requiring access to a trust manager.

Returns:

A set of TrustManager objects that may be used for interactions requiring access to a trust manager.

Throws:

LdapException - If a problem occurs while attempting to obtain the set of trust managers.

getServerContext

protected final ServerContext getServerContext()

Returns the server context.

Returns:

the server context.