Class FileBasedTrustManagerProviderCfgDefn

java.lang.Object
org.forgerock.opendj.config.AbstractManagedObjectDefinition<FileBasedTrustManagerProviderCfgClient, FileBasedTrustManagerProviderCfg>
org.forgerock.opendj.config.ManagedObjectDefinition<FileBasedTrustManagerProviderCfgClient, FileBasedTrustManagerProviderCfg>
org.forgerock.opendj.server.config.meta.FileBasedTrustManagerProviderCfgDefn
public final class FileBasedTrustManagerProviderCfgDefn extends ManagedObjectDefinition<FileBasedTrustManagerProviderCfgClient, FileBasedTrustManagerProviderCfg>
An interface for querying the File Based Trust Manager Provider managed object definition meta information.

The file-based trust manager provider obtains the trusted certificates from a trust store file.

  • Method Details

    • getInstance

      public static FileBasedTrustManagerProviderCfgDefn getInstance()
      Get the File Based Trust Manager Provider configuration definition singleton.
      Returns:
      Returns the File Based Trust Manager Provider configuration definition singleton.

    • createClientConfiguration

      public FileBasedTrustManagerProviderCfgClient createClientConfiguration(ManagedObject<? extends FileBasedTrustManagerProviderCfgClient> impl)
      Description copied from class: ManagedObjectDefinition
      Creates a client configuration view of the provided managed object. Modifications made to the underlying managed object will be reflected in the client configuration view and vice versa.
      Specified by:
      createClientConfiguration in class ManagedObjectDefinition<FileBasedTrustManagerProviderCfgClient, FileBasedTrustManagerProviderCfg>
      Parameters:
      impl - The managed object.
      Returns:
      Returns a client configuration view of the provided managed object.

    • createServerConfiguration

      public FileBasedTrustManagerProviderCfg createServerConfiguration(ServerManagedObject<? extends FileBasedTrustManagerProviderCfg> impl)
      Description copied from class: ManagedObjectDefinition
      Creates a server configuration view of the provided server managed object.
      Specified by:
      createServerConfiguration in class ManagedObjectDefinition<FileBasedTrustManagerProviderCfgClient, FileBasedTrustManagerProviderCfg>
      Parameters:
      impl - The server managed object.
      Returns:
      Returns a server configuration view of the provided server managed object.

    • getServerConfigurationClass

      public Class<FileBasedTrustManagerProviderCfg> getServerConfigurationClass()
      Description copied from class: ManagedObjectDefinition
      Gets the server configuration class instance associated with this managed object definition.
      Specified by:
      getServerConfigurationClass in class ManagedObjectDefinition<FileBasedTrustManagerProviderCfgClient, FileBasedTrustManagerProviderCfg>
      Returns:
      Returns the server configuration class instance associated with this managed object definition.

    • getEnabledPropertyDefinition

      public BooleanPropertyDefinition getEnabledPropertyDefinition()
      Get the "enabled" property definition.

      Indicate whether the File Based Trust Manager Provider is enabled for use.

      Returns:
      Returns the "enabled" property definition.

    • getJavaClassPropertyDefinition

      public ClassPropertyDefinition getJavaClassPropertyDefinition()
      Get the "java-class" property definition.

      The fully-qualified name of the Java class that provides the File Based Trust Manager Provider implementation.

      Returns:
      Returns the "java-class" property definition.

    • getProviderArgPropertyDefinition

      public StringPropertyDefinition getProviderArgPropertyDefinition()
      Get the "provider-arg" property definition.

      The argument passed to configure the trust store security provider.

      The security provider argument is often a path to a properties file which contains the detailed configuration of the provider.

      Returns:
      Returns the "provider-arg" property definition.

    • getProviderClassPropertyDefinition

      public StringPropertyDefinition getProviderClassPropertyDefinition()
      Get the "provider-class" property definition.

      The class of the trust store security provider.

      The Java class that implements the trust store security provider, such as "sun.security.pkcs11.SunPKCS11".

      Returns:
      Returns the "provider-class" property definition.

    • getProviderNamePropertyDefinition

      public StringPropertyDefinition getProviderNamePropertyDefinition()
      Get the "provider-name" property definition.

      The name of the trust store security provider.

      The provider name is usually the name used in the java.security file's "security.provider" list, such as "SunPKCS11".

      Returns:
      Returns the "provider-name" property definition.

    • getTrustStoreFilePropertyDefinition

      public PathPropertyDefinition getTrustStoreFilePropertyDefinition()
      Get the "trust-store-file" property definition.

      Specifies the path to the file containing the trust information. It can be an absolute path or a path that is relative to the PingDS instance path.

      Changes to this configuration attribute take effect the next time that the trust manager is accessed.

      Returns:
      Returns the "trust-store-file" property definition.

    • getTrustStorePinPropertyDefinition

      public StringPropertyDefinition getTrustStorePinPropertyDefinition()
      Get the "trust-store-pin" property definition.

      Specifies the clear-text PIN needed to access the File Based Trust Manager Provider .

      Returns:
      Returns the "trust-store-pin" property definition.

    • getTrustStoreTypePropertyDefinition

      public StringPropertyDefinition getTrustStoreTypePropertyDefinition()
      Get the "trust-store-type" property definition.

      Specifies the format for the data in the trust store file.

      Valid values always include 'JKS' and 'PKCS12', but different implementations can allow other values as well. If no value is provided, then the JVM default value is used. Changes to this configuration attribute take effect the next time that the trust manager is accessed.

      Returns:
      Returns the "trust-store-type" property definition.