Package org.cometd.common

Class AbstractClientSession.AbstractSessionChannel

java.lang.Object

org.cometd.common.AbstractClientSession.AbstractSessionChannel

All Implemented Interfaces:

Channel, ClientSessionChannel, org.eclipse.jetty.util.component.Dumpable

Direct Known Subclasses:

BayeuxClient.BayeuxClientChannel, LocalSessionImpl.LocalChannel

Enclosing class:

AbstractClientSession

protected abstract class AbstractClientSession.AbstractSessionChannel
extends Object
implements ClientSessionChannel, org.eclipse.jetty.util.component.Dumpable

A channel scoped to a ClientSession.

Nested Class Summary

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

ClientSessionChannel.ClientSessionChannelListener, ClientSessionChannel.MessageListener

Field Summary

Fields inherited from interface org.cometd.bayeux.Channel

META, META_CONNECT, META_DISCONNECT, META_HANDSHAKE, META_SUBSCRIBE, META_UNSUBSCRIBE, SERVICE

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractSessionChannel(ChannelId id)

Method Summary

Modifier and Type	Method	Description
void	addListener(ClientSessionChannel.ClientSessionChannelListener listener)	Adds a listener to this channel.
String	dump()
void	dump(Appendable out, String indent)
Object	getAttribute(String name)	Retrieves the value of named channel attribute.
Set<String>	getAttributeNames()
ChannelId	getChannelId()
String	getId()
List<ClientSessionChannel.ClientSessionChannelListener>	getListeners()
List<ClientSessionChannel.MessageListener>	getSubscribers()
boolean	isBroadcast()	A broadcasting channel is a channel that is neither a meta channel nor a service channel.
boolean	isDeepWild()	Tells whether a channel contains the deep wild characters '**', for example /foo/**
boolean	isMeta()	Tells whether the channel is a meta channel, that is if its id starts with "/meta/".
boolean	isReleased()
boolean	isService()	Tells whether the channel is a service channel, that is if its id starts with "/service/".
boolean	isWild()	Tells whether a channel contains the wild character '*', for example /foo/* or if it is Channel.isDeepWild().
protected void	notifyMessageListeners(Message message)
protected void	notifyOnMessage(ClientSessionChannel.MessageListener listener, Message message)
void	publish(Object data)	Publishes the given data onto this channel.
void	publish(Object data, ClientSessionChannel.MessageListener callback)	Publishes the given data onto this channel, notifying the given callback of the publish result, whether successful or unsuccessful.
void	publish(Message.Mutable message, ClientSessionChannel.MessageListener callback)	Publishes the given message onto this channel, notifying the given callback of the publish result.
boolean	release()	Releases this channel from its ClientSession.
Object	removeAttribute(String name)	Removes a named channel attribute.
void	removeListener(ClientSessionChannel.ClientSessionChannelListener listener)	Removes the given listener from this channel.
protected void	resetSubscriptions()
protected void	sendSubscribe(ClientSessionChannel.MessageListener listener, ClientSessionChannel.MessageListener callback)
protected void	sendUnSubscribe(ClientSessionChannel.MessageListener callback)
void	setAttribute(String name, Object value)	Sets a named channel attribute value.
void	subscribe(ClientSessionChannel.MessageListener listener)	Equivalent to subscribe(listener, null).
void	subscribe(ClientSessionChannel.MessageListener listener, ClientSessionChannel.MessageListener callback)	Subscribes the given listener to receive messages sent to this channel.
protected void	throwIfReleased()
String	toString()
void	unsubscribe()	Unsubscribes all subscribers registered on this channel.
void	unsubscribe(ClientSessionChannel.MessageListener listener)	Equivalent to unsubscribe(listener, null).
void	unsubscribe(ClientSessionChannel.MessageListener listener, ClientSessionChannel.MessageListener callback)	Unsubscribes the given listener from receiving messages sent to this channel.

Methods inherited from class java.lang.Object

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

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

getSession

Constructor Details

AbstractSessionChannel

protected AbstractSessionChannel(ChannelId id)

Method Details

getChannelId

public ChannelId getChannelId()

Specified by:

getChannelId in interface Channel

Returns:

The channel ID as a ChannelId

addListener

public void addListener(ClientSessionChannel.ClientSessionChannelListener listener)

Description copied from interface: ClientSessionChannel

Adds a listener to this channel.

If the listener is a ClientSessionChannel.MessageListener, it will be invoked if a message arrives to this channel.

Adding a listener never involves communication with the server, differently from ClientSessionChannel.subscribe(MessageListener).

Listeners are best suited to receive messages from meta channels.

Specified by:

addListener in interface ClientSessionChannel

Parameters:

listener - the listener to add

See Also:

ClientSessionChannel.removeListener(ClientSessionChannelListener)

removeListener

public void removeListener(ClientSessionChannel.ClientSessionChannelListener listener)

Description copied from interface: ClientSessionChannel

Removes the given listener from this channel.

Removing a listener never involves communication with the server, differently from ClientSessionChannel.unsubscribe(MessageListener).

Specified by:

removeListener in interface ClientSessionChannel

Parameters:

listener - the listener to remove

See Also:

ClientSessionChannel.addListener(ClientSessionChannelListener)

getListeners

public List<ClientSessionChannel.ClientSessionChannelListener> getListeners()

Specified by:

getListeners in interface ClientSessionChannel

Returns:

an immutable snapshot of the listeners

See Also:

ClientSessionChannel.addListener(ClientSessionChannelListener)

publish

public void publish(Object data)

Description copied from interface: ClientSessionChannel

Publishes the given data onto this channel.

The data published must not be null and can be any object that can be natively converted to JSON (numbers, strings, arrays, lists, maps), or objects for which a JSON converter has been registered with the infrastructure responsible of the JSON conversion.

Specified by:

publish in interface ClientSessionChannel

Parameters:

data - the data to publish

See Also:

ClientSessionChannel.publish(Object, MessageListener)

publish

public void publish(Object data, ClientSessionChannel.MessageListener callback)

Description copied from interface: ClientSessionChannel

Publishes the given data onto this channel, notifying the given callback of the publish result, whether successful or unsuccessful.

Specified by:

publish in interface ClientSessionChannel

Parameters:

data - the data to publish

callback - the message callback to notify of the publish result

See Also:

ClientSessionChannel.publish(Object), ClientSessionChannel.publish(Message.Mutable, MessageListener)

publish

public void publish(Message.Mutable message, ClientSessionChannel.MessageListener callback)

Description copied from interface: ClientSessionChannel

Publishes the given message onto this channel, notifying the given callback of the publish result.

Specified by:

publish in interface ClientSessionChannel

Parameters:

message - the message to publish

callback - the message callback to notify of the publish result

See Also:

ClientSessionChannel.publish(Object, MessageListener)

subscribe

public void subscribe(ClientSessionChannel.MessageListener listener)

Description copied from interface: ClientSessionChannel

Equivalent to subscribe(listener, null).

Specified by:

subscribe in interface ClientSessionChannel

Parameters:

listener - the listener to register and invoke when a message arrives on this channel.

subscribe

public void subscribe(ClientSessionChannel.MessageListener listener, ClientSessionChannel.MessageListener callback)

Description copied from interface: ClientSessionChannel

Subscribes the given listener to receive messages sent to this channel.

Subscription involves communication with the server only for the first listener subscribed to this channel. Listeners registered after the first will not cause a message being sent to the server.

The callback parameter will be invoked upon acknowledgment of the subscription by the server, and therefore only for the first subscription to this channel.

Specified by:

subscribe in interface ClientSessionChannel

Parameters:

listener - the listener to register and invoke when a message arrives on this channel.

callback - the listener to notify of the subscribe result.

See Also:

ClientSessionChannel.unsubscribe(MessageListener), ClientSessionChannel.addListener(ClientSessionChannelListener)

sendSubscribe

protected void sendSubscribe(ClientSessionChannel.MessageListener listener, ClientSessionChannel.MessageListener callback)

unsubscribe

public void unsubscribe(ClientSessionChannel.MessageListener listener)

Description copied from interface: ClientSessionChannel

Equivalent to unsubscribe(listener, null).

Specified by:

unsubscribe in interface ClientSessionChannel

Parameters:

listener - the listener to unsubscribe

unsubscribe

public void unsubscribe(ClientSessionChannel.MessageListener listener, ClientSessionChannel.MessageListener callback)

Description copied from interface: ClientSessionChannel

Unsubscribes the given listener from receiving messages sent to this channel.

Unsubscription involves communication with the server only for the last listener unsubscribed from this channel.

The callback parameter will be invoked upon acknowledgment of the unsubscription by the server, and therefore only for the last unsubscription from this channel.

Specified by:

unsubscribe in interface ClientSessionChannel

Parameters:

listener - the listener to unsubscribe

callback - the listener to notify of the unsubscribe result.

See Also:

ClientSessionChannel.subscribe(MessageListener), ClientSessionChannel.unsubscribe()

sendUnSubscribe

protected void sendUnSubscribe(ClientSessionChannel.MessageListener callback)

unsubscribe

public void unsubscribe()

Description copied from interface: ClientSessionChannel

Unsubscribes all subscribers registered on this channel.

Specified by:

unsubscribe in interface ClientSessionChannel

See Also:

ClientSessionChannel.subscribe(MessageListener)

getSubscribers

public List<ClientSessionChannel.MessageListener> getSubscribers()

Specified by:

getSubscribers in interface ClientSessionChannel

Returns:

an immutable snapshot of the subscribers

See Also:

ClientSessionChannel.subscribe(MessageListener)

release

public boolean release()

Description copied from interface: ClientSessionChannel

Releases this channel from its ClientSession.

If the release is successful, subsequent invocations of ClientSession.getChannel(String) will return a new, different, instance of a ClientSessionChannel.

The release of a ClientSessionChannel is successful only if no listeners and no subscribers are present at the moment of the release.

Specified by:

release in interface ClientSessionChannel

Returns:

true if the release was successful, false otherwise

See Also:

ClientSessionChannel.isReleased()

isReleased

public boolean isReleased()

Specified by:

isReleased in interface ClientSessionChannel

Returns:

whether this channel has been released

See Also:

ClientSessionChannel.release()

resetSubscriptions

protected void resetSubscriptions()

getId

public String getId()

Specified by:

getId in interface Channel

Returns:

The channel id as a String

isDeepWild

public boolean isDeepWild()

Description copied from interface: Channel

Tells whether a channel contains the deep wild characters '**', for example /foo/**

Specified by:

isDeepWild in interface Channel

Returns:

true if the channel contains the '**' characters

isMeta

public boolean isMeta()

Description copied from interface: Channel

Tells whether the channel is a meta channel, that is if its id starts with "/meta/".

Specified by:

isMeta in interface Channel

Returns:

true if the channel is a meta channel

isService

public boolean isService()

Description copied from interface: Channel

Tells whether the channel is a service channel, that is if its id starts with "/service/".

Specified by:

isService in interface Channel

Returns:

true if the channel is a service channel

isBroadcast

public boolean isBroadcast()

Description copied from interface: Channel

A broadcasting channel is a channel that is neither a meta channel nor a service channel.

Specified by:

isBroadcast in interface Channel

Returns:

whether the channel is a broadcasting channel

isWild

public boolean isWild()

Description copied from interface: Channel

Tells whether a channel contains the wild character '*', for example /foo/* or if it is Channel.isDeepWild().

Specified by:

isWild in interface Channel

Returns:

true if the channel contains the '*' or '**' characters

notifyMessageListeners

protected void notifyMessageListeners(Message message)

notifyOnMessage

protected void notifyOnMessage(ClientSessionChannel.MessageListener listener, Message message)

setAttribute

public void setAttribute(String name, Object value)

Description copied from interface: Channel

Sets a named channel attribute value.

Channel attributes are convenience data that allows arbitrary application data to be associated with a channel.

Specified by:

setAttribute in interface Channel

Parameters:

name - the attribute name

value - the attribute value

getAttribute

public Object getAttribute(String name)

Description copied from interface: Channel

Retrieves the value of named channel attribute.

Specified by:

getAttribute in interface Channel

Parameters:

name - the name of the attribute

Returns:

the attribute value or null if the attribute is not present

getAttributeNames

public Set<String> getAttributeNames()

Specified by:

getAttributeNames in interface Channel

Returns:

the list of channel attribute names.

removeAttribute

public Object removeAttribute(String name)

Description copied from interface: Channel

Removes a named channel attribute.

Specified by:

removeAttribute in interface Channel

Parameters:

name - the name of the attribute

Returns:

the value of the attribute

throwIfReleased

protected void throwIfReleased()

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

toString

public String toString()

Overrides:

toString in class Object