org.granite.client.messaging.channel

Class AbstractHTTPChannel

java.lang.Object

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

org.granite.client.messaging.channel.AbstractHTTPChannel

All Implemented Interfaces:

java.lang.Runnable, Channel, ChannelStatusNotifier, TransportStopListener

Direct Known Subclasses:

AbstractAMFChannel

public abstract class AbstractHTTPChannel
extends AbstractChannel<Transport>
implements TransportStopListener, java.lang.Runnable

Author:

Franck WOLFF

Field Summary

Fields

Modifier and Type	Field and Description
protected long	defaultTimeToLive
protected int	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
AbstractHTTPChannel(Transport transport, java.lang.String id, java.net.URI uri, int maxConcurrentRequests)

Method Summary

Methods

Modifier and Type	Method and Description
void	addListener(ChannelStatusListener listener)
protected LoginMessage	authenticate(AsyncToken dependentToken)
void	bindStatus(ChannelStatusNotifier notifier)
protected abstract TransportMessage	createTransportMessage(AsyncToken token)
protected abstract ResponseMessage	decodeResponse(java.io.InputStream is)
protected void	dispatchFault(FaultMessage faultMessage)
long	getDefaultTimeToLive() Default time to live for messages sent from this channel
int	getMaxConcurrentRequests()
protected RequestMessage	getRequest(java.lang.String id)
protected void	internalStop()
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 Channel.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	onStop(Transport transport)
void	removeListener(ChannelStatusListener listener)
void	run()
protected boolean	schedule(java.util.TimerTask timerTask, long delay)
ResponseMessageFuture	send(RequestMessage request, ResponseListener... listeners) Send a message on this channel
protected void	setAuthenticated(boolean authenticated)
void	setDefaultTimeToLive(long defaultTimeToLive) Set the default time to live for messages sent from this channel
protected void	setPinged(boolean pinged)
boolean	start() Start the channel.
boolean	stop() Stop the channel
void	unbindStatus(ChannelStatusNotifier notifier)

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

Field Detail

maxConcurrentRequests

protected volatile int maxConcurrentRequests

defaultTimeToLive

protected volatile long defaultTimeToLive

Constructor Detail

AbstractHTTPChannel

public AbstractHTTPChannel(Transport transport,
                   java.lang.String id,
                   java.net.URI uri,
                   int maxConcurrentRequests)

Method Detail

createTransportMessage

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

Throws:

java.io.UnsupportedEncodingException

decodeResponse

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

Throws:

java.io.IOException

schedule

protected boolean schedule(java.util.TimerTask timerTask,
               long delay)

getDefaultTimeToLive

public long getDefaultTimeToLive()

Description copied from interface: Channel

Default time to live for messages sent from this channel

Specified by:

getDefaultTimeToLive in interface Channel

Returns:

default time to live in milliseconds

setDefaultTimeToLive

public void setDefaultTimeToLive(long defaultTimeToLive)

Description copied from interface: Channel

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

Specified by:

setDefaultTimeToLive in interface Channel

Parameters:

defaultTimeToLive - default time to live

isAuthenticated

public boolean isAuthenticated()

Description copied from interface: Channel

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

Specified by:

isAuthenticated in interface Channel

Returns:

true if authenticated

getMaxConcurrentRequests

public int getMaxConcurrentRequests()

onStop

public void onStop(Transport transport)

Specified by:

onStop in interface TransportStopListener

start

public boolean start()

Description copied from interface: Channel

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

Specified by:

start in interface Channel

Returns:

true if the channel has correctly started

isStarted

public boolean isStarted()

Specified by:

isStarted in interface Channel

Returns:

true if the channel is started

stop

public boolean stop()

Description copied from interface: Channel

Stop the channel

Specified by:

stop in interface Channel

Returns:

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

internalStop

protected void internalStop()

authenticate

protected LoginMessage authenticate(AsyncToken dependentToken)

run

public void run()

Specified by:

run in interface java.lang.Runnable

getRequest

protected RequestMessage getRequest(java.lang.String id)

send

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

Description copied from interface: Channel

Send a message on this channel

Specified by:

send in interface 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

public ResponseMessageFuture logout(ResponseListener... listeners)

Description copied from interface: Channel

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

Specified by:

logout in interface Channel

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

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

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

onMessage

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

Description copied from interface: Channel

Callback method called by the transport when a message is received

Specified by:

onMessage in interface Channel

is - data input stream of the incoming message

onDisconnect

public void onDisconnect()

Description copied from interface: Channel

Callback method called by the transport when it is disconnecting

Specified by:

onDisconnect in interface Channel

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

Parameters:

message - message triggering the error

e - exception throws during send of message

onCancelled

public void onCancelled(TransportMessage message)

Description copied from interface: Channel

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

Specified by:

onCancelled in interface Channel

Parameters:

message - message cancelled

addListener

public void addListener(ChannelStatusListener listener)

Specified by:

addListener in interface Channel

Specified by:

addListener in interface ChannelStatusNotifier

removeListener

public void removeListener(ChannelStatusListener listener)

Specified by:

removeListener in interface Channel

Specified by:

removeListener in interface ChannelStatusNotifier

setPinged

protected void setPinged(boolean pinged)

setAuthenticated

protected void setAuthenticated(boolean authenticated)

dispatchFault

protected void dispatchFault(FaultMessage faultMessage)

bindStatus

public void bindStatus(ChannelStatusNotifier notifier)

Specified by:

bindStatus in interface Channel

unbindStatus

public void unbindStatus(ChannelStatusNotifier notifier)

Specified by:

unbindStatus in interface Channel