org.granite.client.messaging.channel

Interface Channel

All Superinterfaces:

ChannelStatusNotifier

All Known Subinterfaces:

MessagingChannel, RemotingChannel

All Known Implementing Classes:

AbstractAMFChannel, AbstractChannel, AbstractHTTPChannel, AMFRemotingChannel, BaseAMFMessagingChannel, JMFRemotingChannel

public interface Channel
extends ChannelStatusNotifier

Interface for communication channels A channel handles the protocol (ping, reconnections, ...) between the client and the server A Channel should be created using a ChannelFactory

Author:

Franck WOLFF

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	BYTEARRAY_BODY_HEADER
static long	DEFAULT_TIME_TO_LIVE
static java.lang.String	RECONNECT_INTERVAL_MS_KEY
static java.lang.String	RECONNECT_MAX_ATTEMPTS_KEY

Method Summary

Methods

Modifier and Type	Method and Description
void	addListener(ChannelStatusListener listener)
void	bindStatus(ChannelStatusNotifier notifier)
java.lang.String	getClientId() Internal client id received from the server on the first ping
Credentials	getCredentials() Current security credentials for this channel
long	getDefaultTimeToLive() Default time to live for messages sent from this channel
java.lang.String	getId() Channel identifier
Transport	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
boolean	isAuthenticated() True if the channel has been authenticated (exchange of a login message)
boolean	isStarted()
ResponseMessageFuture	logout(boolean sendLogout, ResponseListener... listeners) Logout from the server application.
ResponseMessageFuture	logout(ResponseListener... listeners) Logout from the server application Equivalent to logout(boolean,org.granite.client.messaging.ResponseListener...) with sendLogout true
void	onCancelled(TransportMessage message) Callback method called by the transport when a message send is cancelled
void	onDisconnect() Callback method called by the transport when it is disconnecting
void	onError(TransportMessage message, java.lang.Exception e) Callback method called by the transport when an exception occurs during communication
void	onMessage(TransportMessage message, java.io.InputStream is) Callback method called by the transport when a message is received
void	removeListener(ChannelStatusListener listener)
ResponseMessageFuture	send(RequestMessage request, ResponseListener... listeners) Send a message on this channel
void	setCredentials(Credentials credentials) Set the security credentials for this channel Once the credentials are set, the next send(org.granite.client.messaging.messages.RequestMessage, org.granite.client.messaging.ResponseListener...) will trigger the authentication with the server
void	setDefaultTimeToLive(long defaultTimeToLive) Set the default time to live for messages sent from this channel
void	setTransportData(java.lang.Object data) Set the channel-specific state object for the transport
boolean	start() Start the channel.
boolean	stop() Stop the channel
void	unbindStatus(ChannelStatusNotifier notifier)

Field Detail

RECONNECT_INTERVAL_MS_KEY

static final java.lang.String RECONNECT_INTERVAL_MS_KEY

See Also:

Constant Field Values

RECONNECT_MAX_ATTEMPTS_KEY

static final java.lang.String RECONNECT_MAX_ATTEMPTS_KEY

See Also:

Constant Field Values

DEFAULT_TIME_TO_LIVE

static final long DEFAULT_TIME_TO_LIVE

BYTEARRAY_BODY_HEADER

static final java.lang.String BYTEARRAY_BODY_HEADER

See Also:

Constant Field Values

Method Detail

getTransport

Transport getTransport()

Transport used by this channel

Returns:

transport

getId

java.lang.String getId()

Channel identifier

Returns:

id

getUri

java.net.URI getUri()

Server application uri

Returns:

uri

getClientId

java.lang.String getClientId()

Internal client id received from the server on the first ping

Returns:

client id

getDefaultTimeToLive

long getDefaultTimeToLive()

Default time to live for messages sent from this channel

Returns:

default time to live in milliseconds

setDefaultTimeToLive

void setDefaultTimeToLive(long defaultTimeToLive)

Set the default time to live for messages sent from this channel

Parameters:

defaultTimeToLive - default time to live

start

boolean start()

Start the channel. This is where the channel can initialize its internal resources, thread pools...

Returns:

true if the channel has correctly started

isStarted

boolean isStarted()

Returns:

true if the channel is started

stop

boolean stop()

Stop the channel

Returns:

true if the channel has been stopped, false if it was not started before the method was called

setCredentials

void setCredentials(Credentials credentials)

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

Parameters:

credentials - credentials

getCredentials

Credentials getCredentials()

Current security credentials for this channel

Returns:

credentials

isAuthenticated

boolean isAuthenticated()

True if the channel has been authenticated (exchange of a login message)

Returns:

true if authenticated

send

ResponseMessageFuture send(RequestMessage request,
                         ResponseListener... listeners)

Send a message on this channel

Parameters:

request - message to send

listeners - array of listeners to notify asynchronously when the response is received

Returns:

future that will be triggered when the response is received

logout

ResponseMessageFuture logout(ResponseListener... listeners)

Logout from the server application Equivalent to logout(boolean,org.granite.client.messaging.ResponseListener...) with sendLogout true

Parameters:

listeners - array of listeners to notify asynchronously when the response is received

Returns:

future that will be triggered when the response is received

logout

ResponseMessageFuture logout(boolean sendLogout,
                           ResponseListener... listeners)

Logout from the server application. If sendLogout is false, the logout message will not be sent to the server so this method can also be used when you know that the session is lost (expired session, lost connection, ...)

Parameters:

sendLogout - if true a logout message will be sent

listeners - array of listeners to notify asynchronously when the response is received

Returns:

future that will be triggered when the response is received

getTransportData

<D> D getTransportData()

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

Type Parameters:

D - type of transport data

Returns:

transport state object

setTransportData

void setTransportData(java.lang.Object data)

Set the channel-specific state object for the transport

Parameters:

data - transport state object

onMessage

void onMessage(TransportMessage message,
             java.io.InputStream is)

Callback method called by the transport when a message is received

Parameters:

is - data input stream of the incoming message

onDisconnect

void onDisconnect()

Callback method called by the transport when it is disconnecting

onError

void onError(TransportMessage message,
           java.lang.Exception e)

Callback method called by the transport when an exception occurs during communication

Parameters:

message - message triggering the error

e - exception throws during send of message

onCancelled

void onCancelled(TransportMessage message)

Callback method called by the transport when a message send is cancelled

Parameters:

message - message cancelled

bindStatus

void bindStatus(ChannelStatusNotifier notifier)

unbindStatus

void unbindStatus(ChannelStatusNotifier notifier)

addListener

void addListener(ChannelStatusListener listener)

Specified by:

addListener in interface ChannelStatusNotifier

removeListener

void removeListener(ChannelStatusListener listener)

Specified by:

removeListener in interface ChannelStatusNotifier