org.eclipse.kapua.gateway.client

Interface Client

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

AbstractClient, FuseClient, MqttClient, PahoClient

public interface Client
extends AutoCloseable

A client connection

An instance of a client can be obtained by building and instance via different protocol stacks. e.g. see the KuraMqttProfile.

In order to free resources the instance has to be closed when it is no longer needed.

Data is exchanged by the use of Applications.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	Client.Builder

Method Summary

Modifier and Type	Method and Description
Application.Builder	buildApplication(String applicationId) Create a new application instance
Transport	transport() Get control over the transport

Methods inherited from interface java.lang.AutoCloseable

close

Method Detail

transport

Transport transport()

Get control over the transport

Returns:

The transport control instance

buildApplication

Application.Builder buildApplication(String applicationId)

Create a new application instance

This method only returns a new builder which will create a new instance once Application.Builder.build() is called. Before that the application is not built and no resources are claimed.

Application IDs are unique. If an application ID is already allocated it cannot be allocated a second time. The second call to Application.Builder.build() will fail. However this application ID only allocated once the call to Application.Builder.build() succeeded.

Parameters:

applicationId - The ID of the application to create

Returns:

the new Application.Builder instance