Package org.apache.qpid.protonj2.client

Interface Client

  • All Superinterfaces:
    AutoCloseable
    All Known Implementing Classes:
    ClientInstance
    public interface Client
extends AutoCloseable
    The Container that hosts AMQP Connections. From this container new connections can be created and an API exists to close all open connections hosted in this container instance.

    • Method Detail

      • create

        static Client create()
        Returns:
        a new Client instance configured with defaults.

      • create

        static Client create​(ClientOptions options)
        Create a new Client instance using provided configuration options.
        Parameters:
        options - The configuration options to use when creating the client.
        Returns:
        a new Client instance configured using the provided options.

      • containerId

        String containerId()
        Returns:
        the container id assigned to this Client instance.

      • close

        void close()
        Closes all currently open Connection instances created by this client.

        This method blocks and waits for each connection to close in turn using the configured close timeout of the ConnectionOptions that the connection was created with.

        Specified by:
        close in interface AutoCloseable

      • closeAsync

        Future<Client> closeAsync()
        Closes all currently open Connection instances created by this client.

        This method does not block and wait for each connection to be closed in turn, instead it returns a future which will be completed once the close of all connections has been completed.

        Returns:
        a Future that will be completed when all open connections have closed.

      • connect

        Connection connect​(String host,
                   int port)
            throws ClientException
        Connect to the specified host and port, without credentials and with all connection options set to their defaults.

        The connection returned may still fail afterwards as the majority of connection setup is done asynchronously so the application should be prepared for errors to arise of the connection methods if the open future is not waited on.

        Parameters:
        host - the host to connect to
        port - the port to connect to
        Returns:
        connection, establishment not yet completed
        Throws:
        ClientException - if the Client is closed or an error occurs during connect.

      • connect

        Connection connect​(String host,
                   int port,
                   ConnectionOptions options)
            throws ClientException
        Connect to the specified host and port, with given connection options.

        The connection returned may still fail afterwards as the majority of connection setup is done asynchronously so the application should be prepared for errors to arise of the connection methods if the open future is not waited on.

        Parameters:
        host - the host to connect to
        port - the port to connect to
        options - options to use when creating the connection.
        Returns:
        connection, establishment not yet completed
        Throws:
        ClientException - if the Client is closed or an error occurs during connect.

      • connect

        Connection connect​(String host)
            throws ClientException
        Connect to the specified host, using the default port, without credentials and with all connection options set to their defaults.

        The connection returned may still fail afterwards as the majority of connection setup is done asynchronously so the application should be prepared for errors to arise of the connection methods if the open future is not waited on.

        Parameters:
        host - the host to connect to
        Returns:
        connection, establishment not yet completed
        Throws:
        ClientException - if the Client is closed or an error occurs during connect.

      • connect

        Connection connect​(String host,
                   ConnectionOptions options)
            throws ClientException
        Connect to the specified host, using the default port, without credentials and with all connection options set to their defaults.

        The connection returned may still fail afterwards as the majority of connection setup is done asynchronously so the application should be prepared for errors to arise of the connection methods if the open future is not waited on.

        Parameters:
        host - the host to connect to
        options - options to use when creating the connection.
        Returns:
        connection, establishment not yet completed
        Throws:
        ClientException - if the Client is closed or an error occurs during connect.