org.kaaproject.kaa.client

Interface KaaClient

All Known Implementing Classes:

AbstractKaaClient

public interface KaaClient

Interface for the Kaa client.

Base interface to operate with Kaa library.

Author:

Yaroslav Zeygerman

See Also:

ProfileManager, ConfigurationManager, DeltaManager, ConfigurationPersistenceManager, SchemaPersistenceManager, NotificationManager, EventFamilyFactory, EndpointRegistrationManager, EventListenersResolver, KaaChannelManager, KaaDataMultiplexer, KaaDataDemultiplexer, PublicKey, PrivateKey, LogCollector, KaaDataChannel

Method Summary

Methods

Modifier and Type	Method and Description
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.

Method Detail

getProfileManager

ProfileManager getProfileManager()

Retrieves Kaa profile manager.

Returns:

ProfileManager object.

getConfigurationManager

ConfigurationManager getConfigurationManager()

Retrieves Kaa configuration manager.

Returns:

ConfigurationManager object.

getDeltaManager

DeltaManager getDeltaManager()

Retrieves Kaa delta manager.

Returns:

DeltaManager object.

getConfigurationPersistenceManager

ConfigurationPersistenceManager getConfigurationPersistenceManager()

Retrieves Kaa configuration persistence manager.

Returns:

ConfigurationPersistenceManager object.

getSchemaPersistenceManager

SchemaPersistenceManager getSchemaPersistenceManager()

Retrieves Kaa schema persistence manager.

Returns:

SchemaPersistenceManager object.

getNotificationManager

NotificationManager getNotificationManager()

Retrieves Kaa notification manager.

Returns:

NotificationManager object.

getEventFamilyFactory

EventFamilyFactory getEventFamilyFactory()

Retrieves Kaa event family factory.

Returns:

EventFamilyFactory object.

getEndpointRegistrationManager

EndpointRegistrationManager getEndpointRegistrationManager()

Retrieves Kaa endpoint registration manager

Returns:

EndpointRegistrationManager object

getEventListenerResolver

EventListenersResolver getEventListenerResolver()

Retrieves Kaa event listeners resolver

Returns:

EventListenersResolver object

getChannelMananager

KaaChannelManager getChannelMananager()

Retrieves Kaa channel manager

Returns:

KaaChannelManager object

getOperationMultiplexer

KaaDataMultiplexer getOperationMultiplexer()

Retrieves data multiplexer for communication with Operation server.

Required in user implementation of an operation data channel.

Returns:

KaaDataMultiplexer object

getOperationDemultiplexer

KaaDataDemultiplexer getOperationDemultiplexer()

Retrieves data demultiplexer for communication with Operation server.

Required in user implementation of an operation data channel.

Returns:

KaaDataDemultiplexer object

getBootstrapMultiplexer

KaaDataMultiplexer getBootstrapMultiplexer()

Retrieves data multiplexer for communication with Bootstrap server.

Required in user implementation of a bootstrap data channel.

Returns:

KaaDataMultiplexer object

getBootstrapDemultiplexer

KaaDataDemultiplexer getBootstrapDemultiplexer()

Retrieves data demultiplexer for communication with Bootstrap server.

Required in user implementation of a bootstrap data channel.

Returns:

KaaDataDemultiplexer object

getClientPublicKey

PublicKey getClientPublicKey()

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.

Returns:

client's public key

getEndpointKeyHash

String getEndpointKeyHash()

Retrieves endpoint public key hash.

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

Returns:

String containing current endpoint's public key hash.

getClientPrivateKey

PrivateKey getClientPrivateKey()

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.

Returns:

client's private key

getLogCollector

LogCollector getLogCollector()

Retrieves Kaa log collector.

Returns:

LogCollector object

getDefaultChannel

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

Retrieves the default channel implementation for the specified ChannelType.

Parameters:

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

Returns:

KaaDataChannel default implementation for the specified ChannelType