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

Interface PemKeyManagerProviderCfg

All Superinterfaces:
Configuration, KeyManagerProviderCfg
public interface PemKeyManagerProviderCfg extends KeyManagerProviderCfg
A server-side interface for querying 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

    • configurationClass

      Class<? extends PemKeyManagerProviderCfg> configurationClass()
      Gets the configuration class associated with this Pem Key Manager Provider.
      Specified by:
      configurationClass in interface Configuration
      Specified by:
      configurationClass in interface KeyManagerProviderCfg
      Returns:
      Returns the configuration class associated with this Pem Key Manager Provider.

    • addPemChangeListener

      void addPemChangeListener(ConfigurationChangeListener<PemKeyManagerProviderCfg> listener)
      Register to be notified when this Pem Key Manager Provider is changed.
      Parameters:
      listener - The Pem Key Manager Provider configuration change listener.

    • removePemChangeListener

      void removePemChangeListener(ConfigurationChangeListener<PemKeyManagerProviderCfg> listener)
      Deregister an existing Pem Key Manager Provider configuration change listener.
      Parameters:
      listener - The Pem Key Manager Provider configuration change listener.

    • getExcludedFilenamePattern

      SortedSet<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 an unmodifiable set containing the values of the "excluded-filename-pattern" property.

    • getJavaClass

      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 KeyManagerProviderCfg
      Returns:
      Returns the value of the "java-class" property.

    • getPemDirectory

      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.