KaaChannelManager (Kaa Client (Java Core) 0.6.1 API)

All Known Implementing Classes:

DefaultChannelManager
```
public interface KaaChannelManager
```
Channel manager establishes/removes channels' links between client and server.

Use this manager to add or remove specific network channel implementation for client-server communication.
```
 class SpecificDataChannel implements KaaDataChannel {...}
 ...
 SpecificDataChannel dataChannel1 = new SpecificDataChannel();
 kaaClient.getChannelManager().addChannel(dataChannel1);
 
 
```
The code above registers new data channel in the KaaChannelManager instance. This channel will be used by each transport abstraction which is supported by this channel (See KaaDataChannel.getSupportedTransportTypes()).

Channel manager will use the latest added channel for each TransportType for data transferring. For example, if there are two KaaDataChannel implementations ChannelA and ChannelB such as:
ChannelA is data transceiver (ChannelDirection.BIDIRECTIONAL) for transport types [TransportType.EVENT, TransportType.LOGGING];
ChannelB is data transmitter (ChannelDirection.UP) for [TransportType.EVENT].

and they are added to addChannel(KaaDataChannel) in the following order:

 ChannelA channelA = new ChannelA();
 ChannelB channelB = new ChannelB();
 kaaClient.getChannelManager().addChannel(channelA);
 kaaClient.getChannelManager().addChannel(channelB);

then ChannelA instance will be used to receive TransportType.EVENT and TransportType.LOGGING data, but to transmit only TransportType.LOGGING data. For TransportType.EVENT data transmission will be used ChannelB instance.
NOTE: If mentioned above channels will be added in reverse order, ChannelB instance will not be used until channelA will not be removed using removeChannel(KaaDataChannel)

On Kaa initialization KaaChannelManager instance is populated with DefaultBootstrapChannel, DefaultOperationsChannel and DefaultOperationHttpChannel (in given order).

Calling removeChannel(KaaDataChannel) forces KaaChannelManager to remove given channel and reset TransportType-to-Channel internal mapping with applicable channel if such exists.

Call to clearChannelList() removes all existing channels.

If physical connection to remote server failed, call onServerFailed(ServerInfo) to switch to another available server.

Author:: Yaroslav Zeygerman
See Also:: KaaDataChannel

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addChannel(KaaDataChannel channel)` Updates the manager by adding the channel.
`void`	`clearChannelList()` Clears the list of channels.
`KaaDataChannel`	`getChannel(String id)` Retrieves channel by the unique channel id.
`KaaDataChannel`	`getChannelByTransportType(org.kaaproject.kaa.common.TransportType type)` Retrieves a list of channels by the specific transport type.
`List<KaaDataChannel>`	`getChannels()` Retrieves the list of current channels.
`List<KaaDataChannel>`	`getChannelsByType(org.kaaproject.kaa.common.bootstrap.gen.ChannelType type)` Retrieves a list of channels by the specific type (HTTP, HTTP_LP etc.).
`void`	`onServerFailed(ServerInfo server)` Reports to Channel Manager in case link with server was not established.
`void`	`onServerUpdated(ServerInfo newServer)` Reports to Channel Manager about the new server.
`void`	`pause()` Pauses all active channels.
`void`	`removeChannel(KaaDataChannel channel)` Updates the manager by removing the channel from the manager.
`void`	`removeChannel(String id)` Updates the manager by removing the channel from the manager.
`void`	`resume()` Restores channels' activity.
`void`	`setChannel(org.kaaproject.kaa.common.TransportType transport, KaaDataChannel channel)` Updates the manager by setting the channel to the specified `TransportType`.
`void`	`setConnectivityChecker(ConnectivityChecker checker)` Sets connectivity checker to the existing channels.
`void`	`shutdown()` Shuts down the manager and all registered channels.

- Method Detail
  - setChannel
```
void setChannel(org.kaaproject.kaa.common.TransportType transport,
              KaaDataChannel channel)
                throws KaaInvalidChannelException
```
    Updates the manager by setting the channel to the specified TransportType.
    
    Parameters:
    transport - the type of the transport which is going to receive updates using the specified channel.
    channel - the channel to be added.
    
    Throws:
    
    KaaInvalidChannelException
    See Also:
    KaaDataChannel
  - addChannel
```
void addChannel(KaaDataChannel channel)
```
    Updates the manager by adding the channel.
    
    Parameters:
    channel - the channel to be added.
    See Also:
    KaaDataChannel
  - removeChannel
```
void removeChannel(KaaDataChannel channel)
```
    Updates the manager by removing the channel from the manager.
    
    Parameters:
    channel - the channel to be removed.
    See Also:
    KaaDataChannel
  - removeChannel
```
void removeChannel(String id)
```
    Updates the manager by removing the channel from the manager.
    
    Parameters:
    id - the channel's id.
    See Also:
    KaaDataChannel
  - getChannels
```
List<KaaDataChannel> getChannels()
```
    Retrieves the list of current channels.
    
    Returns:
    the channels' list.
    See Also:
    KaaDataChannel
  - getChannelsByType
```
List<KaaDataChannel> getChannelsByType(org.kaaproject.kaa.common.bootstrap.gen.ChannelType type)
```
    Retrieves a list of channels by the specific type (HTTP, HTTP_LP etc.).
    
    Parameters:
    type - type of the channel.
    
    Returns:
    a list of channels.
    See Also:
    ChannelType, KaaDataChannel
  - getChannelByTransportType
```
KaaDataChannel getChannelByTransportType(org.kaaproject.kaa.common.TransportType type)
```
    Retrieves a list of channels by the specific transport type.
    
    Parameters:
    type - the transport's type.
    
    Returns:
    a list of channels.
    See Also:
    TransportType, KaaDataChannel
  - getChannel
```
KaaDataChannel getChannel(String id)
```
    Retrieves channel by the unique channel id.
    
    Parameters:
    id - the channel's id.
    
    Returns:
    channel object.
    See Also:
    KaaDataChannel
  - onServerFailed
```
void onServerFailed(ServerInfo server)
```
    Reports to Channel Manager in case link with server was not established.
    
    Parameters:
    server - the parameters of server that was not connected.
    See Also:
    ServerInfo
  - onServerUpdated
```
void onServerUpdated(ServerInfo newServer)
```
    Reports to Channel Manager about the new server.
    
    Parameters:
    newServer - the parameters of the new server.
    See Also:
    ServerInfo
  - clearChannelList
```
void clearChannelList()
```
    Clears the list of channels.
  - setConnectivityChecker
```
void setConnectivityChecker(ConnectivityChecker checker)
```
    Sets connectivity checker to the existing channels.
    
    Parameters:
    checker - platform-dependent connectivity checker.
    See Also:
    ConnectivityChecker
  - shutdown
```
void shutdown()
```
    Shuts down the manager and all registered channels. The instance can no longer be used.
  - pause
```
void pause()
```
    Pauses all active channels.
  - resume
```
void resume()
```
    Restores channels' activity.

Interface KaaChannelManager

Method Summary

Method Detail

setChannel

addChannel

removeChannel

removeChannel

getChannels

getChannelsByType

getChannelByTransportType

getChannel

onServerFailed

onServerUpdated

clearChannelList

setConnectivityChecker

shutdown

pause

resume