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 Details

    • 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.

    • getAdvertisedListenAddress

      SortedSet<com.forgerock.opendj.util.Host> getAdvertisedListenAddress()
      Gets the "advertised-listen-address" property.

      The advertised address(es) which clients should use for connecting to this Administration Connector.

      Multiple addresses may be provided as separate values for this attribute. The meta-address 0.0.0.0 is not permitted.

      Default value is inherited from another property

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

    • getAllowedClient

      SortedSet<AddressMask> getAllowedClient()
      Gets the "allowed-client" property.

      A set of clients who will be allowed to establish connections to this Administration Connector.

      Valid values include a host name, a fully qualified domain name, a domain name, an IP address, or a subnetwork with subnetwork mask. Specifying a value for this property in a connection handler will override any value set in the global configuration.

      Returns:
      Returns an unmodifiable set containing the values of the "allowed-client" property.

    • getDeniedClient

      SortedSet<AddressMask> getDeniedClient()
      Gets the "denied-client" property.

      A set of clients who are not allowed to establish connections to this Administration Connector.

      Valid values include a host name, a fully qualified domain name, a domain name, an IP address, or a subnetwork with subnetwork mask. If both allowed and denied client masks are defined and a client connection matches one or more masks in both lists, then the connection is denied. If only a denied list is specified, then any client not matching a mask in that list is allowed. Specifying a value for this property in a connection handler will override any value set in the global configuration.

      Returns:
      Returns an unmodifiable set containing the values of the "denied-client" property.

    • 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

      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<com.forgerock.opendj.util.Host> getListenAddress()
      Gets the "listen-address" property.

      The network interface(s) on which this Administration Connector should listen for incoming client connections.

      Multiple addresses may be provided as separate values for this attribute. If no values are provided, then the directory server will listen on all interfaces.

      Default value is inherited from another property

      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.

    • getProxyProtocolAllowedClient

      SortedSet<AddressMask> getProxyProtocolAllowedClient()
      Gets the "proxy-protocol-allowed-client" property.

      When the proxy protocol is enabled, this property represents the set of clients who will be allowed to establish connections to this Administration Connector and will be required to use proxy protocol.

      Valid values include a host name, a fully qualified domain name, a domain name, an IP address, or a subnetwork with subnetwork mask. Specifying a value for this property in a connection handler will override any value set in the global configuration.

      Default value is inherited from another property

      Returns:
      Returns an unmodifiable set containing the values of the "proxy-protocol-allowed-client" property.

    • isProxyProtocolEnabled

      Boolean isProxyProtocolEnabled()
      Gets the "proxy-protocol-enabled" property.

      Indicates whether the proxy protocol is enabled.

      If enabled, the Administration Connector makes the server use proxy protocol for connections with a source IP address matching an address in the proxy-protocol-allowed-client list.

      Default value is inherited from another property

      Returns:
      Returns the value of the "proxy-protocol-enabled" property.

    • getRestrictedClient

      SortedSet<AddressMask> getRestrictedClient()
      Gets the "restricted-client" property.

      A set of clients who will be limited to the maximum number of connections specified by the "restricted-client-connection-limit" property.

      Valid values include a host name, a fully qualified domain name, a domain name, an IP address, or a subnetwork with subnetwork mask. Specifying a value for this property in a connection handler will override any value set in the global configuration.

      Returns:
      Returns an unmodifiable set containing the values of the "restricted-client" property.

    • getRestrictedClientConnectionLimit

      int getRestrictedClientConnectionLimit()
      Gets the "restricted-client-connection-limit" property.

      Specifies the maximum number of connections a restricted client can open at the same time to this Administration Connector.

      Once Directory Server accepts the specified number of connections from a client specified in restricted-client, any additional connection will be rejected. The number of connections is maintained by IP address. Specifying a value for this property in a connection handler will override any value set in the global configuration.

      Default value: 100

      Returns:
      Returns the value of the "restricted-client-connection-limit" 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. This is only applicable when the Administration Connector is configured to use SSL.

      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

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

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

      Default value is undefined

      Returns:
      Returns an unmodifiable set containing the values of the "trust-manager-provider" property.

    • getTrustManagerProviderDns

      SortedSet<Dn> getTrustManagerProviderDns()
      Gets the "trust-manager-provider" property as a set of DNs.

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

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