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

Interface ConnectionHandlerCfgClient

All Superinterfaces:
ConfigurationClient
All Known Subinterfaces:
HttpConnectionHandlerCfgClient, JmxConnectionHandlerCfgClient, LdapConnectionHandlerCfgClient, LdifConnectionHandlerCfgClient
public interface ConnectionHandlerCfgClient extends ConfigurationClient
A client-side interface for reading and modifying Connection Handler settings.

Connection Handlers are responsible for handling all interaction with the clients, including accepting the connections, reading requests, and sending responses.

  • Method Details

    • definition

      ManagedObjectDefinition<? extends ConnectionHandlerCfgClient,? extends ConnectionHandlerCfg> definition()
      Get the configuration definition associated with this Connection Handler.
      Specified by:
      definition in interface ConfigurationClient
      Returns:
      Returns the configuration definition associated with this Connection Handler.

    • getAllowedClient

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

      A set of clients who will be allowed to establish connections to this Connection Handler.

      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 the values of the "allowed-client" property.

    • setAllowedClient

      void setAllowedClient(Collection<ValueOrExpression<AddressMask>> values) throws PropertyException
      Sets the "allowed-client" property.

      A set of clients who will be allowed to establish connections to this Connection Handler.

      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.

      Parameters:
      values - The values of the "allowed-client" property.
      Throws:
      PropertyException - If one or more of the new values are invalid.

    • getDeniedClient

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

      A set of clients who are not allowed to establish connections to this Connection Handler.

      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.

      Default value is inherited from another property

      Returns:
      Returns the values of the "denied-client" property.

    • setDeniedClient

      void setDeniedClient(Collection<ValueOrExpression<AddressMask>> values) throws PropertyException
      Sets the "denied-client" property.

      A set of clients who are not allowed to establish connections to this Connection Handler.

      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.

      Parameters:
      values - The values of the "denied-client" property.
      Throws:
      PropertyException - If one or more of the new values are invalid.

    • isEnabled

      @MandatoryProperty ValueOrExpression<Boolean> isEnabled()
      Gets the "enabled" property.

      Indicates whether the Connection Handler is enabled.

      Returns:
      Returns the value of the "enabled" property.

    • setEnabled

      @MandatoryProperty void setEnabled(ValueOrExpression<Boolean> value) throws PropertyException
      Sets the "enabled" property.

      Indicates whether the Connection Handler is enabled.

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

    • getJavaClass

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

      Specifies the fully-qualified name of the Java class that provides the Connection Handler implementation.

      Returns:
      Returns the value of the "java-class" property.

    • setJavaClass

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

      Specifies the fully-qualified name of the Java class that provides the Connection Handler implementation.

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

    • getRestrictedClient

      SortedSet<ValueOrExpression<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.

      Default value is inherited from another property

      Returns:
      Returns the values of the "restricted-client" property.

    • setRestrictedClient

      void setRestrictedClient(Collection<ValueOrExpression<AddressMask>> values) throws PropertyException
      Sets 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.

      Parameters:
      values - The values of the "restricted-client" property.
      Throws:
      PropertyException - If one or more of the new values are invalid.

    • getRestrictedClientConnectionLimit

      ValueOrExpression<Integer> 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 Connection Handler.

      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 is inherited from another property

      Returns:
      Returns the value of the "restricted-client-connection-limit" property.

    • setRestrictedClientConnectionLimit

      void setRestrictedClientConnectionLimit(ValueOrExpression<Integer> value) throws PropertyException
      Sets the "restricted-client-connection-limit" property.

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

      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.

      Parameters:
      value - The value of the "restricted-client-connection-limit" property.
      Throws:
      PropertyException - If the new value is invalid.