org.granite.client.messaging.channel

Class AbstractChannel<T extends Transport>

java.lang.Object

org.granite.client.messaging.channel.AbstractChannel<T>

All Implemented Interfaces:

Channel, ChannelStatusNotifier

Direct Known Subclasses:

AbstractHTTPChannel

public abstract class AbstractChannel<T extends Transport>
extends java.lang.Object
implements Channel

Author:

Franck WOLFF

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	clientId
protected Credentials	credentials
protected java.lang.String	id
protected T	transport
protected java.lang.Object	transportData
protected java.net.URI	uri

Fields inherited from interface org.granite.client.messaging.channel.Channel

BYTEARRAY_BODY_HEADER, DEFAULT_TIME_TO_LIVE, RECONNECT_INTERVAL_MS_KEY, RECONNECT_MAX_ATTEMPTS_KEY

Constructor Summary

Constructors

Constructor and Description
AbstractChannel(T transport, java.lang.String id, java.net.URI uri)

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getClientId() Internal client id received from the server on the first ping
Credentials	getCredentials() Current security credentials for this channel
java.lang.String	getId() Channel identifier
T	getTransport() Transport used by this channel
<D> D	getTransportData() Internal data object that can be used by a transport to store channel-specific state
java.net.URI	getUri() Server application uri
void	setCredentials(Credentials credentials) Set the security credentials for this channel Once the credentials are set, the next Channel.send(org.granite.client.messaging.messages.RequestMessage, org.granite.client.messaging.ResponseListener...) will trigger the authentication with the server
void	setTransportData(java.lang.Object data) Set the channel-specific state object for the transport

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.granite.client.messaging.channel.Channel

addListener, bindStatus, getDefaultTimeToLive, isAuthenticated, isStarted, logout, logout, onCancelled, onDisconnect, onError, onMessage, removeListener, send, setDefaultTimeToLive, start, stop, unbindStatus

Field Detail

transport

protected final T extends Transport transport

id

protected final java.lang.String id

uri

protected final java.net.URI uri

clientId

protected volatile java.lang.String clientId

credentials

protected volatile Credentials credentials

transportData

protected volatile java.lang.Object transportData

Constructor Detail

AbstractChannel

public AbstractChannel(T transport,
               java.lang.String id,
               java.net.URI uri)

Method Detail

getTransport

public T getTransport()

Description copied from interface: Channel

Transport used by this channel

Specified by:

getTransport in interface Channel

Returns:

transport

getId

public java.lang.String getId()

Description copied from interface: Channel

Channel identifier

Specified by:

getId in interface Channel

Returns:

id

getUri

public java.net.URI getUri()

Description copied from interface: Channel

Server application uri

Specified by:

getUri in interface Channel

Returns:

uri

getClientId

public java.lang.String getClientId()

Description copied from interface: Channel

Internal client id received from the server on the first ping

Specified by:

getClientId in interface Channel

Returns:

client id

setCredentials

public void setCredentials(Credentials credentials)

Description copied from interface: Channel

Set the security credentials for this channel Once the credentials are set, the next Channel.send(org.granite.client.messaging.messages.RequestMessage, org.granite.client.messaging.ResponseListener...) will trigger the authentication with the server

Specified by:

setCredentials in interface Channel

Parameters:

credentials - credentials

getCredentials

public Credentials getCredentials()

Description copied from interface: Channel

Current security credentials for this channel

Specified by:

getCredentials in interface Channel

Returns:

credentials

getTransportData

public <D> D getTransportData()

Description copied from interface: Channel

Internal data object that can be used by a transport to store channel-specific state

Specified by:

getTransportData in interface Channel

Type Parameters:

D - type of transport data

Returns:

transport state object

setTransportData

public void setTransportData(java.lang.Object data)

Description copied from interface: Channel

Set the channel-specific state object for the transport

Specified by:

setTransportData in interface Channel

Parameters:

data - transport state object