org.kaaproject.kaa.client

Class AbstractKaaClient

java.lang.Object

org.kaaproject.kaa.client.AbstractKaaClient

All Implemented Interfaces:

KaaClient

public abstract class AbstractKaaClient
extends Object
implements KaaClient

Abstract class that holds general elements of Kaa library.

This class creates and binds Kaa library modules. Public access to each module is performed using KaaClient interface.

Class contains abstract methods createHttpClient(String, PrivateKey, PublicKey, PublicKey) and createPersistentStorage() which are used to reference the platform-specific implementation of http client and Kaa's state persistent storage.

Http client (AbstractHttpClient) is used to provide basic communication with Bootstrap and Operation servers using HTTP protocol.

Author:

Yaroslav Zeygerman

See Also:

KaaClient, AbstractHttpClient, PersistentStorage

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract ConnectivityChecker	createConnectivityChecker()
abstract AbstractHttpClient	createHttpClient(String url, PrivateKey privateKey, PublicKey publicKey, PublicKey remotePublicKey)
protected abstract PersistentStorage	createPersistentStorage()
KaaDataDemultiplexer	getBootstrapDemultiplexer() Retrieves data demultiplexer for communication with Bootstrap server.
KaaDataMultiplexer	getBootstrapMultiplexer() Retrieves data multiplexer for communication with Bootstrap server.
KaaChannelManager	getChannelMananager() Retrieves Kaa channel manager
PrivateKey	getClientPrivateKey() Retrieves the client's private key.
PublicKey	getClientPublicKey() Retrieves the client's public key.
ConfigurationManager	getConfigurationManager() Retrieves Kaa configuration manager.
ConfigurationPersistenceManager	getConfigurationPersistenceManager() Retrieves Kaa configuration persistence manager.
KaaDataChannel	getDefaultChannel(org.kaaproject.kaa.common.bootstrap.gen.ChannelType type) Retrieves the default channel implementation for the specified ChannelType.
DeltaManager	getDeltaManager() Retrieves Kaa delta manager.
String	getEndpointKeyHash() Retrieves endpoint public key hash.
EndpointRegistrationManager	getEndpointRegistrationManager() Retrieves Kaa endpoint registration manager
EventFamilyFactory	getEventFamilyFactory() Retrieves Kaa event family factory.
EventListenersResolver	getEventListenerResolver() Retrieves Kaa event listeners resolver
LogCollector	getLogCollector() Retrieves Kaa log collector.
NotificationManager	getNotificationManager() Retrieves Kaa notification manager.
KaaDataDemultiplexer	getOperationDemultiplexer() Retrieves data demultiplexer for communication with Operation server.
KaaDataMultiplexer	getOperationMultiplexer() Retrieves data multiplexer for communication with Operation server.
ProfileManager	getProfileManager() Retrieves Kaa profile manager.
SchemaPersistenceManager	getSchemaPersistenceManager() Retrieves Kaa schema persistence manager.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

createHttpClient

public abstract AbstractHttpClient createHttpClient(String url,
                                  PrivateKey privateKey,
                                  PublicKey publicKey,
                                  PublicKey remotePublicKey)

createPersistentStorage

protected abstract PersistentStorage createPersistentStorage()

createConnectivityChecker

protected abstract ConnectivityChecker createConnectivityChecker()

getProfileManager

public ProfileManager getProfileManager()

Description copied from interface: KaaClient

Retrieves Kaa profile manager.

Specified by:

getProfileManager in interface KaaClient

Returns:

ProfileManager object.

getConfigurationManager

public ConfigurationManager getConfigurationManager()

Description copied from interface: KaaClient

Retrieves Kaa configuration manager.

Specified by:

getConfigurationManager in interface KaaClient

Returns:

ConfigurationManager object.

getDeltaManager

public DeltaManager getDeltaManager()

Description copied from interface: KaaClient

Retrieves Kaa delta manager.

Specified by:

getDeltaManager in interface KaaClient

Returns:

DeltaManager object.

getConfigurationPersistenceManager

public ConfigurationPersistenceManager getConfigurationPersistenceManager()

Description copied from interface: KaaClient

Retrieves Kaa configuration persistence manager.

Specified by:

getConfigurationPersistenceManager in interface KaaClient

Returns:

ConfigurationPersistenceManager object.

getSchemaPersistenceManager

public SchemaPersistenceManager getSchemaPersistenceManager()

Description copied from interface: KaaClient

Retrieves Kaa schema persistence manager.

Specified by:

getSchemaPersistenceManager in interface KaaClient

Returns:

SchemaPersistenceManager object.

getNotificationManager

public NotificationManager getNotificationManager()

Description copied from interface: KaaClient

Retrieves Kaa notification manager.

Specified by:

getNotificationManager in interface KaaClient

Returns:

NotificationManager object.

getEndpointRegistrationManager

public EndpointRegistrationManager getEndpointRegistrationManager()

Description copied from interface: KaaClient

Retrieves Kaa endpoint registration manager

Specified by:

getEndpointRegistrationManager in interface KaaClient

Returns:

EndpointRegistrationManager object

getEventFamilyFactory

public EventFamilyFactory getEventFamilyFactory()

Description copied from interface: KaaClient

Retrieves Kaa event family factory.

Specified by:

getEventFamilyFactory in interface KaaClient

Returns:

EventFamilyFactory object.

getEventListenerResolver

public EventListenersResolver getEventListenerResolver()

Description copied from interface: KaaClient

Retrieves Kaa event listeners resolver

Specified by:

getEventListenerResolver in interface KaaClient

Returns:

EventListenersResolver object

getChannelMananager

public KaaChannelManager getChannelMananager()

Description copied from interface: KaaClient

Retrieves Kaa channel manager

Specified by:

getChannelMananager in interface KaaClient

Returns:

KaaChannelManager object

getOperationMultiplexer

public KaaDataMultiplexer getOperationMultiplexer()

Description copied from interface: KaaClient

Retrieves data multiplexer for communication with Operation server.

Required in user implementation of an operation data channel.

Specified by:

getOperationMultiplexer in interface KaaClient

Returns:

KaaDataMultiplexer object

getOperationDemultiplexer

public KaaDataDemultiplexer getOperationDemultiplexer()

Description copied from interface: KaaClient

Retrieves data demultiplexer for communication with Operation server.

Required in user implementation of an operation data channel.

Specified by:

getOperationDemultiplexer in interface KaaClient

Returns:

KaaDataDemultiplexer object

getBootstrapMultiplexer

public KaaDataMultiplexer getBootstrapMultiplexer()

Description copied from interface: KaaClient

Retrieves data multiplexer for communication with Bootstrap server.

Required in user implementation of a bootstrap data channel.

Specified by:

getBootstrapMultiplexer in interface KaaClient

Returns:

KaaDataMultiplexer object

getBootstrapDemultiplexer

public KaaDataDemultiplexer getBootstrapDemultiplexer()

Description copied from interface: KaaClient

Retrieves data demultiplexer for communication with Bootstrap server.

Required in user implementation of a bootstrap data channel.

Specified by:

getBootstrapDemultiplexer in interface KaaClient

Returns:

KaaDataDemultiplexer object

getClientPublicKey

public PublicKey getClientPublicKey()

Description copied from interface: KaaClient

Retrieves the client's public key.

Required in user implementation of an operation data channel. Public key hash (SHA-1) is used by servers as identification number to uniquely identify each connected endpoint.

Specified by:

getClientPublicKey in interface KaaClient

Returns:

client's public key

getEndpointKeyHash

public String getEndpointKeyHash()

Description copied from interface: KaaClient

Retrieves endpoint public key hash.

Required in EndpointRegistrationManager implementation to react on detach response from Operations server.

Specified by:

getEndpointKeyHash in interface KaaClient

Returns:

String containing current endpoint's public key hash.

getClientPrivateKey

public PrivateKey getClientPrivateKey()

Description copied from interface: KaaClient

Retrieves the client's private key.

Required in user implementation of an operation data channel. Private key is used by encryption schema between endpoint and servers.

Specified by:

getClientPrivateKey in interface KaaClient

Returns:

client's private key

getLogCollector

public LogCollector getLogCollector()

Description copied from interface: KaaClient

Retrieves Kaa log collector.

Specified by:

getLogCollector in interface KaaClient

Returns:

LogCollector object

getDefaultChannel

public KaaDataChannel getDefaultChannel(org.kaaproject.kaa.common.bootstrap.gen.ChannelType type)

Description copied from interface: KaaClient

Retrieves the default channel implementation for the specified ChannelType.

Specified by:

getDefaultChannel in interface KaaClient

Parameters:

type - the channel's type (HTTP, KAATCP, etc.)

Returns:

KaaDataChannel default implementation for the specified ChannelType