Package org.forgerock.opendj.server.config.client

Interface PemKeyManagerProviderCfgClient

All Superinterfaces:
ConfigurationClient, KeyManagerProviderCfgClient
public interface PemKeyManagerProviderCfgClient extends KeyManagerProviderCfgClient
A client-side interface for reading and modifying Pem Key Manager Provider settings.

The Pem Key Manager Provider obtains TLS and master keys from PEM files in a file system directory.

  • Method Details

    • definition

      ManagedObjectDefinition<? extends PemKeyManagerProviderCfgClient,? extends PemKeyManagerProviderCfg> definition()
      Get the configuration definition associated with this Pem Key Manager Provider.
      Specified by:
      definition in interface ConfigurationClient
      Specified by:
      definition in interface KeyManagerProviderCfgClient
      Returns:
      Returns the configuration definition associated with this Pem Key Manager Provider.

    • getExcludedFilenamePattern

      SortedSet<ValueOrExpression<String>> getExcludedFilenamePattern()
      Gets the "excluded-filename-pattern" property.

      The set of file name patterns identifying files to be excluded from the Pem Key Manager Provider.

      Hidden files will always be excluded. File name patterns use the "glob" syntax defined by the Java "java.nio.file.FileSystem.getPathMatcher" method.

      Default values: .*, *.bak, *.tmp, *.md

      Returns:
      Returns the values of the "excluded-filename-pattern" property.

    • setExcludedFilenamePattern

      void setExcludedFilenamePattern(Collection<ValueOrExpression<String>> values) throws PropertyException
      Sets the "excluded-filename-pattern" property.

      The set of file name patterns identifying files to be excluded from the Pem Key Manager Provider.

      Hidden files will always be excluded. File name patterns use the "glob" syntax defined by the Java "java.nio.file.FileSystem.getPathMatcher" method.

      Parameters:
      values - The values of the "excluded-filename-pattern" property.
      Throws:
      PropertyException - If one or more of the new values are invalid.

    • getJavaClass

      @MandatoryProperty ValueOrExpression<String> getJavaClass()
      Gets the "java-class" property.

      The fully-qualified name of the Java class that provides the Pem Key Manager Provider implementation.

      Default value: org.opends.server.extensions.PemKeyManagerProvider

      Specified by:
      getJavaClass in interface KeyManagerProviderCfgClient
      Returns:
      Returns the value of the "java-class" property.

    • setJavaClass

      @MandatoryProperty void setJavaClass(ValueOrExpression<String> value) throws PropertyException
      Sets the "java-class" property.

      The fully-qualified name of the Java class that provides the Pem Key Manager Provider implementation.

      Specified by:
      setJavaClass in interface KeyManagerProviderCfgClient
      Parameters:
      value - The value of the "java-class" property.
      Throws:
      PropertyException - If the new value is invalid.

    • getPemDirectory

      @MandatoryProperty ValueOrExpression<String> getPemDirectory()
      Gets the "pem-directory" property.

      Specifies the path to a directory containing PEM files. It can be an absolute path or a path that is relative to the OpenDJ instance root. The same directory may also be used for a PEM trust manager provider.

      Returns:
      Returns the value of the "pem-directory" property.

    • setPemDirectory

      @MandatoryProperty void setPemDirectory(ValueOrExpression<String> value) throws PropertyException
      Sets the "pem-directory" property.

      Specifies the path to a directory containing PEM files. It can be an absolute path or a path that is relative to the OpenDJ instance root. The same directory may also be used for a PEM trust manager provider.

      Parameters:
      value - The value of the "pem-directory" property.
      Throws:
      PropertyException - If the new value is invalid.