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

Interface FileBasedTrustManagerProviderCfgClient

  • All Superinterfaces:
    ConfigurationClient, TrustManagerProviderCfgClient
    public interface FileBasedTrustManagerProviderCfgClient
extends TrustManagerProviderCfgClient
    A client-side interface for reading and modifying File Based Trust Manager Provider settings.

    The file-based trust manager provider determines whether to trust a presented certificate based on whether that certificate exists in a server trust store file.

    • Method Detail

      • getJavaClass

        String getJavaClass()
        Gets the "java-class" property.

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

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

      • setJavaClass

        void setJavaClass​(String value)
           throws PropertyException
        Sets the "java-class" property.

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

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

      • getTrustStoreFile

        String getTrustStoreFile()
        Gets the "trust-store-file" property.

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

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

        Returns:
        Returns the value of the "trust-store-file" property.

      • setTrustStoreFile

        void setTrustStoreFile​(String value)
                throws PropertyException
        Sets the "trust-store-file" property.

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

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

        Parameters:
        value - The value of the "trust-store-file" property.
        Throws:
        PropertyException - If the new value is invalid.

      • getTrustStorePin

        String getTrustStorePin()
        Gets the "trust-store-pin" property.

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

        Returns:
        Returns the value of the "trust-store-pin" property.

      • setTrustStorePin

        void setTrustStorePin​(String value)
               throws PropertyException
        Sets the "trust-store-pin" property.

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

        Parameters:
        value - The value of the "trust-store-pin" property.
        Throws:
        PropertyException - If the new value is invalid.

      • getTrustStorePinEnvironmentVariable

        String getTrustStorePinEnvironmentVariable()
        Gets the "trust-store-pin-environment-variable" property.

        Specifies the name of the environment variable that contains the clear-text PIN needed to access the File Based Trust Manager Provider .

        Returns:
        Returns the value of the "trust-store-pin-environment-variable" property.

      • setTrustStorePinEnvironmentVariable

        void setTrustStorePinEnvironmentVariable​(String value)
                                  throws PropertyException
        Sets the "trust-store-pin-environment-variable" property.

        Specifies the name of the environment variable that contains the clear-text PIN needed to access the File Based Trust Manager Provider .

        Parameters:
        value - The value of the "trust-store-pin-environment-variable" property.
        Throws:
        PropertyException - If the new value is invalid.

      • getTrustStorePinFile

        String getTrustStorePinFile()
        Gets the "trust-store-pin-file" property.

        Specifies the path to the text file whose only contents should be a single line containing the clear-text PIN needed to access the File Based Trust Manager Provider .

        Returns:
        Returns the value of the "trust-store-pin-file" property.

      • setTrustStorePinFile

        void setTrustStorePinFile​(String value)
                   throws PropertyException
        Sets the "trust-store-pin-file" property.

        Specifies the path to the text file whose only contents should be a single line containing the clear-text PIN needed to access the File Based Trust Manager Provider .

        Parameters:
        value - The value of the "trust-store-pin-file" property.
        Throws:
        PropertyException - If the new value is invalid.

      • getTrustStorePinProperty

        String getTrustStorePinProperty()
        Gets the "trust-store-pin-property" property.

        Specifies the name of the Java property that contains the clear-text PIN needed to access the File Based Trust Manager Provider .

        Returns:
        Returns the value of the "trust-store-pin-property" property.

      • setTrustStorePinProperty

        void setTrustStorePinProperty​(String value)
                       throws PropertyException
        Sets the "trust-store-pin-property" property.

        Specifies the name of the Java property that contains the clear-text PIN needed to access the File Based Trust Manager Provider .

        Parameters:
        value - The value of the "trust-store-pin-property" property.
        Throws:
        PropertyException - If the new value is invalid.

      • getTrustStoreType

        String getTrustStoreType()
        Gets the "trust-store-type" property.

        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 value of the "trust-store-type" property.

      • setTrustStoreType

        void setTrustStoreType​(String value)
                throws PropertyException
        Sets the "trust-store-type" property.

        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.

        Parameters:
        value - The value of the "trust-store-type" property.
        Throws:
        PropertyException - If the new value is invalid.