org.granite.client.messaging.channel.amf

Class BaseAMFMessagingChannel

java.lang.Object

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

org.granite.client.messaging.channel.AbstractHTTPChannel

org.granite.client.messaging.channel.amf.AbstractAMFChannel

org.granite.client.messaging.channel.amf.BaseAMFMessagingChannel

All Implemented Interfaces:

java.lang.Runnable, Channel, ChannelStatusNotifier, MessagingChannel, SessionAwareChannel, TransportStopListener

public class BaseAMFMessagingChannel
extends AbstractAMFChannel
implements MessagingChannel

Author:

Franck WOLFF

Nested Class Summary

Nested classes/interfaces inherited from interface org.granite.client.messaging.channel.MessagingChannel

MessagingChannel.ChannelResponseListener

Field Summary

Fields

Modifier and Type	Field and Description
protected MessagingCodec<Message[]>	codec
protected java.util.concurrent.atomic.AtomicReference<java.lang.String>	connectMessageId
protected java.util.concurrent.ConcurrentMap<java.lang.String,Consumer>	consumersMap
protected java.util.concurrent.atomic.AtomicReference<java.lang.String>	loginMessageId
protected long	reconnectAttempts
protected long	reconnectIntervalMillis
protected long	reconnectMaxAttempts
protected java.util.concurrent.atomic.AtomicReference<org.granite.client.messaging.channel.amf.BaseAMFMessagingChannel.ReconnectTimerTask>	reconnectTimerTask
protected java.util.List<MessagingChannel.ChannelResponseListener>	responseListeners
protected java.lang.String	sessionId

Fields inherited from class org.granite.client.messaging.channel.AbstractHTTPChannel

defaultTimeToLive, maxConcurrentRequests

Fields inherited from class org.granite.client.messaging.channel.AbstractChannel

clientId, credentials, id, transport, transportData, 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
BaseAMFMessagingChannel(MessagingCodec<Message[]> codec, Transport transport, java.lang.String id, java.net.URI uri)

Method Summary

Methods

Modifier and Type	Method and Description
void	addConsumer(Consumer consumer) Register a consumer for this channel
void	addListener(MessagingChannel.ChannelResponseListener listener) Register a listener which will be notified of messages occuring on the channel
protected void	cancelReconnectTimerTask()
protected boolean	connect()
protected TransportMessage	createTransportMessage(AsyncToken token)
protected ResponseMessage	decodeResponse(java.io.InputStream is)
ResponseMessageFuture	disconnect(ResponseListener... listeners) Disconnect the channel
protected void	internalStop()
ResponseMessageFuture	logout(boolean sendLogout, ResponseListener... listeners) Logout from the server application.
void	onError(TransportMessage message, java.lang.Exception e) Callback method called by the transport when an exception occurs during communication
boolean	removeConsumer(Consumer consumer) Unregister a consumer for this channel
void	removeListener(MessagingChannel.ChannelResponseListener listener) Unregister a listener which will be notified of messages occuring on the channel
protected void	scheduleReconnectTimerTask()
void	setSessionId(java.lang.String sessionId) Set the current session id Necessary to synchronize session ids between remoting and messaging channels, usually the remoting channel acts as the master channel which handles authentication and session management and propagated it to other messaging channels

Methods inherited from class org.granite.client.messaging.channel.amf.AbstractAMFChannel

convertFromAmf, convertFromAmf, convertToAmf

Methods inherited from class org.granite.client.messaging.channel.AbstractHTTPChannel

addListener, authenticate, bindStatus, dispatchFault, getDefaultTimeToLive, getMaxConcurrentRequests, getRequest, isAuthenticated, isStarted, logout, onCancelled, onDisconnect, onMessage, onStop, removeListener, run, schedule, send, setAuthenticated, setDefaultTimeToLive, setPinged, start, stop, unbindStatus

Methods inherited from class org.granite.client.messaging.channel.AbstractChannel

getClientId, getCredentials, getId, getTransport, getTransportData, getUri, setCredentials, setTransportData

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, getClientId, getCredentials, getDefaultTimeToLive, getId, getTransport, getTransportData, getUri, isAuthenticated, isStarted, logout, onCancelled, onDisconnect, onMessage, removeListener, send, setCredentials, setDefaultTimeToLive, setTransportData, start, stop, unbindStatus

Field Detail

codec

protected final MessagingCodec<Message[]> codec

sessionId

protected java.lang.String sessionId

consumersMap

protected final java.util.concurrent.ConcurrentMap<java.lang.String,Consumer> consumersMap

connectMessageId

protected final java.util.concurrent.atomic.AtomicReference<java.lang.String> connectMessageId

loginMessageId

protected final java.util.concurrent.atomic.AtomicReference<java.lang.String> loginMessageId

reconnectTimerTask

protected final java.util.concurrent.atomic.AtomicReference<org.granite.client.messaging.channel.amf.BaseAMFMessagingChannel.ReconnectTimerTask> reconnectTimerTask

responseListeners

protected final java.util.List<MessagingChannel.ChannelResponseListener> responseListeners

reconnectIntervalMillis

protected volatile long reconnectIntervalMillis

reconnectMaxAttempts

protected volatile long reconnectMaxAttempts

reconnectAttempts

protected volatile long reconnectAttempts

Constructor Detail

BaseAMFMessagingChannel

public BaseAMFMessagingChannel(MessagingCodec<Message[]> codec,
                       Transport transport,
                       java.lang.String id,
                       java.net.URI uri)

Method Detail

setSessionId

public void setSessionId(java.lang.String sessionId)

Description copied from interface: MessagingChannel

Set the current session id Necessary to synchronize session ids between remoting and messaging channels, usually the remoting channel acts as the master channel which handles authentication and session management and propagated it to other messaging channels

Specified by:

setSessionId in interface MessagingChannel

Specified by:

setSessionId in interface SessionAwareChannel

Parameters:

sessionId - session id

connect

protected boolean connect()

addConsumer

public void addConsumer(Consumer consumer)

Description copied from interface: MessagingChannel

Register a consumer for this channel

Specified by:

addConsumer in interface MessagingChannel

Parameters:

consumer - consumer

See Also:

Consumer

removeConsumer

public boolean removeConsumer(Consumer consumer)

Description copied from interface: MessagingChannel

Unregister a consumer for this channel

Specified by:

removeConsumer in interface MessagingChannel

Parameters:

consumer - consumer

Returns:

true if the consumer was registered before the method was called

See Also:

Consumer

addListener

public void addListener(MessagingChannel.ChannelResponseListener listener)

Description copied from interface: MessagingChannel

Register a listener which will be notified of messages occuring on the channel

Specified by:

addListener in interface MessagingChannel

Parameters:

listener - listener

removeListener

public void removeListener(MessagingChannel.ChannelResponseListener listener)

Description copied from interface: MessagingChannel

Unregister a listener which will be notified of messages occuring on the channel

Specified by:

removeListener in interface MessagingChannel

Parameters:

listener - listener

logout

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

Description copied from interface: Channel

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, ...)

Specified by:

logout in interface Channel

Overrides:

logout in class AbstractHTTPChannel

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

disconnect

public ResponseMessageFuture disconnect(ResponseListener... listeners)

Description copied from interface: MessagingChannel

Disconnect the channel

Specified by:

disconnect in interface MessagingChannel

Parameters:

listeners - array of listener to notify when the channel is disconnected

Returns:

future that will be triggered when the channel is disconnected

createTransportMessage

protected TransportMessage createTransportMessage(AsyncToken token)
                                           throws java.io.UnsupportedEncodingException

Specified by:

createTransportMessage in class AbstractHTTPChannel

Throws:

java.io.UnsupportedEncodingException

decodeResponse

protected ResponseMessage decodeResponse(java.io.InputStream is)
                                  throws java.io.IOException

Specified by:

decodeResponse in class AbstractHTTPChannel

Throws:

java.io.IOException

internalStop

protected void internalStop()

Overrides:

internalStop in class AbstractHTTPChannel

onError

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

Description copied from interface: Channel

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

Specified by:

onError in interface Channel

Overrides:

onError in class AbstractHTTPChannel

Parameters:

message - message triggering the error

e - exception throws during send of message

cancelReconnectTimerTask

protected void cancelReconnectTimerTask()

scheduleReconnectTimerTask

protected void scheduleReconnectTimerTask()