Package org.apache.qpid.protonj2.client

Class ClientOptions

java.lang.Object
org.apache.qpid.protonj2.client.ClientOptions
All Implemented Interfaces:
Cloneable
public class ClientOptions extends Object implements Cloneable
Container Options for customizing the behavior of the Container

  • Constructor Details

    • ClientOptions

      public ClientOptions()
      Create a new ClientOptions instance with defaults set for all options.

    • ClientOptions

      public ClientOptions(ClientOptions options)
      Create a new ClientOptions instance that copies the configuration from the specified source options.
      Parameters:
      options - The ClientOptions instance whose settings are to be copied into this one.

  • Method Details

    • id

      public String id()
      Returns:
      the ID configured the Container

    • id

      public ClientOptions id(String id)
      Sets the container ID that should be used when creating Connections
      Parameters:
      id - The container Id that should be assigned to container connections.
      Returns:
      this options class for chaining.

    • futureType

      public String futureType()
      Returns:
      the configure future type to use for this client connection

    • futureType

      public ClientOptions futureType(String futureType)
      Sets the desired future type that the client connection should use when creating the futures used by the API. By default the client will select a Future implementation by itself however the user can override this selection here if desired.
      Parameters:
      futureType - The name of the future type to use.
      Returns:
      this options object for chaining.

    • clone

      public ClientOptions clone()
      Overrides:
      clone in class Object

    • copyInto

      protected ClientOptions copyInto(ClientOptions other)
      Copy all options from this ClientOptions instance into the instance provided.
      Parameters:
      other - the target of this copy operation.
      Returns:
      the ClientOptions instance that was given.