org.cometd.common

Class AbstractClientSession

java.lang.Object

org.cometd.common.AbstractClientSession

All Implemented Interfaces:

ClientSession, Session, org.eclipse.jetty.util.component.Dumpable

public abstract class AbstractClientSession
extends Object
implements ClientSession, org.eclipse.jetty.util.component.Dumpable

Partial implementation of ClientSession.

It handles extensions and batching, and provides utility methods to be used by subclasses.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	AbstractClientSession.AbstractSessionChannel A channel scoped to a ClientSession.

Nested classes/interfaces inherited from interface org.cometd.bayeux.client.ClientSession

ClientSession.Extension, ClientSession.MessageListener

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractClientSession()

Method Summary

Modifier and Type	Method and Description
void	addExtension(ClientSession.Extension extension)
void	batch(Runnable batch)
String	dump()
void	dump(Appendable out, String indent)
boolean	endBatch()
protected boolean	extendRcv(Message.Mutable message)
protected boolean	extendSend(Message.Mutable message)
Object	getAttribute(String name)
Set<String>	getAttributeNames()
ClientSessionChannel	getChannel(ChannelId channelId)
ClientSessionChannel	getChannel(String channelName)
protected ConcurrentMap<String,AbstractClientSession.AbstractSessionChannel>	getChannels()
List<ClientSession.Extension>	getExtensions()
protected boolean	isBatching()
protected abstract AbstractClientSession.AbstractSessionChannel	newChannel(ChannelId channelId)
protected abstract ChannelId	newChannelId(String channelId)
protected Message.Mutable	newMessage()
protected String	newMessageId()
protected void	notifyListener(ClientSessionChannel.MessageListener listener, Message.Mutable message)
protected void	notifyListeners(Message.Mutable message)
void	receive(Message.Mutable message) Receives a message (from the server) and process it.
protected void	registerCallback(String messageId, ClientSessionChannel.MessageListener callback)
protected void	registerSubscriber(String messageId, ClientSessionChannel.MessageListener subscriber)
void	remoteCall(String target, Object data, ClientSession.MessageListener callback)
Object	removeAttribute(String name)
void	removeExtension(ClientSession.Extension extension)
protected void	resetSubscriptions()
protected abstract void	send(Message.Mutable message)
protected abstract void	sendBatch()
void	setAttribute(String name, Object value)
void	startBatch()
protected ClientSessionChannel.MessageListener	unregisterCallback(String messageId)
protected ClientSessionChannel.MessageListener	unregisterSubscriber(String messageId)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.cometd.bayeux.client.ClientSession

disconnect, handshake, handshake, handshake

Methods inherited from interface org.cometd.bayeux.Session

disconnect, getId, isConnected, isHandshook

Constructor Detail

AbstractClientSession

protected AbstractClientSession()

Method Detail

newMessageId

protected String newMessageId()

addExtension

public void addExtension(ClientSession.Extension extension)

Specified by:

addExtension in interface ClientSession

removeExtension

public void removeExtension(ClientSession.Extension extension)

Specified by:

removeExtension in interface ClientSession

getExtensions

public List<ClientSession.Extension> getExtensions()

Specified by:

getExtensions in interface ClientSession

extendSend

protected boolean extendSend(Message.Mutable message)

extendRcv

protected boolean extendRcv(Message.Mutable message)

newChannelId

protected abstract ChannelId newChannelId(String channelId)

newChannel

protected abstract AbstractClientSession.AbstractSessionChannel newChannel(ChannelId channelId)

getChannel

public ClientSessionChannel getChannel(String channelName)

Specified by:

getChannel in interface ClientSession

getChannel

public ClientSessionChannel getChannel(ChannelId channelId)

getChannels

protected ConcurrentMap<String,AbstractClientSession.AbstractSessionChannel> getChannels()

startBatch

public void startBatch()

Specified by:

startBatch in interface Session

sendBatch

protected abstract void sendBatch()

endBatch

public boolean endBatch()

Specified by:

endBatch in interface Session

batch

public void batch(Runnable batch)

Specified by:

batch in interface Session

isBatching

protected boolean isBatching()

getAttribute

public Object getAttribute(String name)

Specified by:

getAttribute in interface Session

getAttributeNames

public Set<String> getAttributeNames()

Specified by:

getAttributeNames in interface Session

removeAttribute

public Object removeAttribute(String name)

Specified by:

removeAttribute in interface Session

setAttribute

public void setAttribute(String name,
                         Object value)

Specified by:

setAttribute in interface Session

remoteCall

public void remoteCall(String target,
                       Object data,
                       ClientSession.MessageListener callback)

Specified by:

remoteCall in interface ClientSession

send

protected abstract void send(Message.Mutable message)

newMessage

protected Message.Mutable newMessage()

resetSubscriptions

protected void resetSubscriptions()

receive

public void receive(Message.Mutable message)

Receives a message (from the server) and process it.

Processing the message involves calling the receive extensions and the channel listeners.

Parameters:

message - the message received.

notifyListeners

protected void notifyListeners(Message.Mutable message)

notifyListener

protected void notifyListener(ClientSessionChannel.MessageListener listener,
                              Message.Mutable message)

registerCallback

protected void registerCallback(String messageId,
                                ClientSessionChannel.MessageListener callback)

unregisterCallback

protected ClientSessionChannel.MessageListener unregisterCallback(String messageId)

registerSubscriber

protected void registerSubscriber(String messageId,
                                  ClientSessionChannel.MessageListener subscriber)

unregisterSubscriber

protected ClientSessionChannel.MessageListener unregisterSubscriber(String messageId)

dump

public String dump()

Specified by:

dump in interface org.eclipse.jetty.util.component.Dumpable

dump

public void dump(Appendable out,
                 String indent)
          throws IOException

Specified by:

dump in interface org.eclipse.jetty.util.component.Dumpable

Throws:

IOException