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

Interface AdministrationConnectorCfg

  • All Superinterfaces:
    Configuration
    public interface AdministrationConnectorCfg
extends Configuration
    A server-side interface for querying Administration Connector settings.

    The Administration Connector is used to interact with administration tools using LDAP.

    • Method Detail

      • configurationClass

        Class<? extends AdministrationConnectorCfg> configurationClass()
        Gets the configuration class associated with this Administration Connector.
        Specified by:
        configurationClass in interface Configuration
        Returns:
        Returns the configuration class associated with this Administration Connector.

      • addChangeListener

        void addChangeListener​(ConfigurationChangeListener<AdministrationConnectorCfg> listener)
        Register to be notified when this Administration Connector is changed.
        Parameters:
        listener - The Administration Connector configuration change listener.

      • removeChangeListener

        void removeChangeListener​(ConfigurationChangeListener<AdministrationConnectorCfg> listener)
        Deregister an existing Administration Connector configuration change listener.
        Parameters:
        listener - The Administration Connector configuration change listener.

      • getKeyManagerProvider

        String getKeyManagerProvider()
        Gets the "key-manager-provider" property.

        Specifies the name of the key manager that is used with the Administration Connector .

        Returns:
        Returns the value of the "key-manager-provider" property.

      • getKeyManagerProviderDN

        org.forgerock.opendj.ldap.DN getKeyManagerProviderDN()
        Gets the "key-manager-provider" property as a DN.

        Specifies the name of the key manager that is used with the Administration Connector .

        Returns:
        Returns the DN value of the "key-manager-provider" property.

      • getListenAddress

        SortedSet<InetAddress> getListenAddress()
        Gets the "listen-address" property.

        Specifies the address or set of addresses on which this Administration Connector should listen for connections from LDAP clients.

        Multiple addresses may be provided as separate values for this attribute. If no values are provided, then the Administration Connector listens on all interfaces.

        Returns:
        Returns an unmodifiable set containing the values of the "listen-address" property.

      • getListenPort

        int getListenPort()
        Gets the "listen-port" property.

        Specifies the port number on which the Administration Connector will listen for connections from clients.

        Only a single port number may be provided.

        Returns:
        Returns the value of the "listen-port" property.

      • getSSLCertNickname

        SortedSet<String> getSSLCertNickname()
        Gets the "ssl-cert-nickname" property.

        Specifies the nicknames (also called the aliases) of the keys or key pairs that the Administration Connector should use when performing SSL communication. The property can be used multiple times (referencing different nicknames) when server certificates with different public key algorithms are used in parallel (for example, RSA, DSA, and ECC-based algorithms). When a nickname refers to an asymmetric (public/private) key pair, the nickname for the public key certificate and associated private key entry must match exactly. A single nickname is used to retrieve both the public key and the private key.

        Returns:
        Returns an unmodifiable set containing the values of the "ssl-cert-nickname" property.

      • getSSLCipherSuite

        SortedSet<String> getSSLCipherSuite()
        Gets the "ssl-cipher-suite" property.

        Specifies the names of the SSL cipher suites that are allowed for use in SSL communication.

        Returns:
        Returns an unmodifiable set containing the values of the "ssl-cipher-suite" property.

      • getSSLProtocol

        SortedSet<String> getSSLProtocol()
        Gets the "ssl-protocol" property.

        Specifies the names of the SSL protocols that are allowed for use in SSL or StartTLS communication.

        Returns:
        Returns an unmodifiable set containing the values of the "ssl-protocol" property.

      • getTrustManagerProvider

        String getTrustManagerProvider()
        Gets the "trust-manager-provider" property.

        Specifies the name of the trust manager that is used with the Administration Connector .

        Returns:
        Returns the value of the "trust-manager-provider" property.

      • getTrustManagerProviderDN

        org.forgerock.opendj.ldap.DN getTrustManagerProviderDN()
        Gets the "trust-manager-provider" property as a DN.

        Specifies the name of the trust manager that is used with the Administration Connector .

        Returns:
        Returns the DN value of the "trust-manager-provider" property.