Package org.cometd.server

Class ServerChannelImpl

java.lang.Object

org.cometd.server.ServerChannelImpl

All Implemented Interfaces:

Channel, ConfigurableServerChannel, ServerChannel, org.eclipse.jetty.util.component.Dumpable

public class ServerChannelImpl
extends Object
implements ServerChannel, org.eclipse.jetty.util.component.Dumpable

Nested Class Summary

Nested classes/interfaces inherited from interface org.cometd.bayeux.server.ConfigurableServerChannel

ConfigurableServerChannel.Initializer, ConfigurableServerChannel.ServerChannelListener

Nested classes/interfaces inherited from interface org.eclipse.jetty.util.component.Dumpable

org.eclipse.jetty.util.component.Dumpable.DumpableContainer

Nested classes/interfaces inherited from interface org.cometd.bayeux.server.ServerChannel

ServerChannel.MessageListener, ServerChannel.SubscriptionListener

Field Summary

Fields inherited from interface org.cometd.bayeux.Channel

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

Fields inherited from interface org.eclipse.jetty.util.component.Dumpable

KEY

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ServerChannelImpl(BayeuxServerImpl bayeux, ChannelId id)

Method Summary

Modifier and Type	Method	Description
void	addAuthorizer(Authorizer authorizer)	Adds the given Authorizer that grants or denies operations on this channel.
void	addListener(ConfigurableServerChannel.ServerChannelListener listener)
protected List<Authorizer>	authorizers()
void	dump(Appendable out, String indent)
Object	getAttribute(String name)	Retrieves the value of named channel attribute.
Set<String>	getAttributeNames()
List<Authorizer>	getAuthorizers()
ChannelId	getChannelId()
String	getId()
long	getLazyTimeout()
List<ConfigurableServerChannel.ServerChannelListener>	getListeners()
Set<ServerSession>	getSubscribers()
boolean	isBroadcast()	A broadcasting channel is a channel that is neither a meta channel nor a service channel.
boolean	isBroadcastToPublisher()
boolean	isDeepWild()	Tells whether a channel contains the deep wild characters '**', for example /foo/**
boolean	isLazy()
boolean	isMeta()	Tells whether the channel is a meta channel, that is if its id starts with "/meta/".
boolean	isPersistent()
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 List<ConfigurableServerChannel.ServerChannelListener>	listeners()
void	publish(Session from, Object data, Promise<Boolean> promise)	Publishes the given information to this channel.
void	publish(Session from, ServerMessage.Mutable mutable, Promise<Boolean> promise)	Publishes the given message to this channel, delivering the message to all the ServerSessions subscribed to this channel.
void	remove()	Removes this channel, and all the children channels.
Object	removeAttribute(String name)	Removes a named channel attribute.
void	removeAuthorizer(Authorizer authorizer)	Removes the given Authorizer.
void	removeListener(ConfigurableServerChannel.ServerChannelListener listener)
void	setAttribute(String name, Object value)	Sets a named channel attribute value.
void	setBroadcastToPublisher(boolean broadcastToPublisher)	Sets whether a publisher that is also a subscriber to the channel will receive the messages it publishes on that channel.
void	setLazy(boolean lazy)	A lazy channel marks all messages published to it as lazy.
void	setLazyTimeout(long lazyTimeout)	Sets the lazy timeout for this channel.
void	setPersistent(boolean persistent)	A persistent channel is not removed when the last subscription is removed
boolean	subscribe(ServerSession session)	Subscribes the given session to this channel.
protected boolean	subscribe(ServerSessionImpl session, ServerMessage message)
Set<ServerSession>	subscribers()
protected boolean	sweep()
String	toString()
boolean	unsubscribe(ServerSession session)	Unsubscribes the given session from this channel.
protected boolean	unsubscribe(ServerSessionImpl session, ServerMessage message)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.eclipse.jetty.util.component.Dumpable

dump, dumpSelf

Constructor Details

ServerChannelImpl

protected ServerChannelImpl(BayeuxServerImpl bayeux,
 ChannelId id)

Method Details

subscribe

public boolean subscribe(ServerSession session)

Description copied from interface: ServerChannel

Subscribes the given session to this channel.

Subscriptions are effective for broadcast channels and are successful no-operations for service channels.

The subscription may fail if the session is already subscribed to the channel or if the session is expired or if the channel is a meta channel.

Specified by:

subscribe in interface ServerChannel

Parameters:

session - the session to subscribe

Returns:

whether the subscription succeeded

See Also:

• ServerChannel.unsubscribe(ServerSession)

subscribe

protected boolean subscribe(ServerSessionImpl session,
 ServerMessage message)

unsubscribe

public boolean unsubscribe(ServerSession session)

Description copied from interface: ServerChannel

Unsubscribes the given session from this channel.

Unsubscriptions are effective for broadcast channels and are successful no-operations for service channels.

The unsubscription may fail if the session is already unsubscribed from the channel or if the session is expired or if the channel is a meta channel.

Specified by:

unsubscribe in interface ServerChannel

Parameters:

session - the session to unsubscribe

Returns:

whether the unsubscription succeeded

unsubscribe

protected boolean unsubscribe(ServerSessionImpl session,
 ServerMessage message)

getSubscribers

public Set<ServerSession> getSubscribers()

Specified by:

getSubscribers in interface ServerChannel

Returns:

a snapshot of the set of subscribers of this channel

subscribers

public Set<ServerSession> subscribers()

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

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

isLazy

public boolean isLazy()

Specified by:

isLazy in interface ConfigurableServerChannel

Returns:

whether the channel is lazy

See Also:

• ConfigurableServerChannel.setLazy(boolean)

isPersistent

public boolean isPersistent()

Specified by:

isPersistent in interface ConfigurableServerChannel

Returns:

whether the channel is persistent

See Also:

• ConfigurableServerChannel.setPersistent(boolean)

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

setLazy

public void setLazy(boolean lazy)

Description copied from interface: ConfigurableServerChannel

A lazy channel marks all messages published to it as lazy.

Specified by:

setLazy in interface ConfigurableServerChannel

Parameters:

lazy - whether the channel is lazy

See Also:

• ConfigurableServerChannel.isLazy()

getLazyTimeout

public long getLazyTimeout()

Specified by:

getLazyTimeout in interface ConfigurableServerChannel

Returns:

the lazy timeout for this channel

See Also:

• ConfigurableServerChannel.setLazyTimeout(long)

setLazyTimeout

public void setLazyTimeout(long lazyTimeout)

Description copied from interface: ConfigurableServerChannel

Sets the lazy timeout for this channel. A positive value makes the channel lazy, a negative value makes the channel non-lazy.

Specified by:

setLazyTimeout in interface ConfigurableServerChannel

Parameters:

lazyTimeout - the lazy timeout for this channel

See Also:

• ConfigurableServerChannel.setLazy(boolean)

setPersistent

public void setPersistent(boolean persistent)

Description copied from interface: ConfigurableServerChannel

A persistent channel is not removed when the last subscription is removed

Specified by:

setPersistent in interface ConfigurableServerChannel

Parameters:

persistent - whether the channel is persistent

See Also:

• ConfigurableServerChannel.isPersistent()

addListener

public void addListener(ConfigurableServerChannel.ServerChannelListener listener)

Specified by:

addListener in interface ConfigurableServerChannel

Parameters:

listener - the listener to add

See Also:

• ConfigurableServerChannel.removeListener(ServerChannelListener)

isBroadcastToPublisher

public boolean isBroadcastToPublisher()

Specified by:

isBroadcastToPublisher in interface ConfigurableServerChannel

Returns:

whether the channel broadcasts messages back to the publisher

setBroadcastToPublisher

public void setBroadcastToPublisher(boolean broadcastToPublisher)

Description copied from interface: ConfigurableServerChannel

Sets whether a publisher that is also a subscriber to the channel will receive the messages it publishes on that channel.

Specified by:

setBroadcastToPublisher in interface ConfigurableServerChannel

Parameters:

broadcastToPublisher - whether the channel broadcasts messages back to the publisher

removeListener

public void removeListener(ConfigurableServerChannel.ServerChannelListener listener)

Specified by:

removeListener in interface ConfigurableServerChannel

Parameters:

listener - the listener to remove

See Also:

• ConfigurableServerChannel.addListener(ServerChannelListener)

getListeners

public List<ConfigurableServerChannel.ServerChannelListener> getListeners()

Specified by:

getListeners in interface ConfigurableServerChannel

Returns:

an immutable list of listeners

See Also:

• ConfigurableServerChannel.addListener(ServerChannelListener)

listeners

protected List<ConfigurableServerChannel.ServerChannelListener> listeners()

getChannelId

public ChannelId getChannelId()

Specified by:

getChannelId in interface Channel

Returns:

The channel ID as a ChannelId

getId

public String getId()

Specified by:

getId in interface Channel

Returns:

The channel id as a String

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

publish

public void publish(Session from,
 ServerMessage.Mutable mutable,
 Promise<Boolean> promise)

Description copied from interface: ServerChannel

Publishes the given message to this channel, delivering the message to all the ServerSessions subscribed to this channel.

Specified by:

publish in interface ServerChannel

Parameters:

from - the session from which the message originates

mutable - the message to publish

promise - the promise to notify whether the message has been published

See Also:

• ServerChannel.publish(Session, Object, Promise)

publish

public void publish(Session from,
 Object data,
 Promise<Boolean> promise)

Description copied from interface: ServerChannel

Publishes the given information to this channel.

Specified by:

publish in interface ServerChannel

Parameters:

from - the session from which the message originates

data - the data of the message

promise - the promise to notify whether the message has been published

See Also:

• ServerChannel.publish(Session, ServerMessage.Mutable, Promise)

sweep

protected boolean sweep()

remove

public void remove()

Description copied from interface: ServerChannel

Removes this channel, and all the children channels.

If channel "/foo", "/foo/bar" and "/foo/blip" exist, removing channel "/foo" will remove also "/foo/bar" and "/foo/blip".

The removal will notify BayeuxServer.ChannelListener listeners.

Specified by:

remove in interface ServerChannel

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

addAuthorizer

public void addAuthorizer(Authorizer authorizer)

Description copied from interface: ConfigurableServerChannel

Adds the given Authorizer that grants or denies operations on this channel.

Operations must be granted by at least one Authorizer and must not be denied by any.

Specified by:

addAuthorizer in interface ConfigurableServerChannel

Parameters:

authorizer - the Authorizer to add

See Also:

• ConfigurableServerChannel.removeAuthorizer(Authorizer)
• Authorizer

removeAuthorizer

public void removeAuthorizer(Authorizer authorizer)

Description copied from interface: ConfigurableServerChannel

Removes the given Authorizer.

Specified by:

removeAuthorizer in interface ConfigurableServerChannel

Parameters:

authorizer - the Authorizer to remove

See Also:

• ConfigurableServerChannel.addAuthorizer(Authorizer)

getAuthorizers

public List<Authorizer> getAuthorizers()

Specified by:

getAuthorizers in interface ConfigurableServerChannel

Returns:

an immutable list of authorizers for this channel

authorizers

protected List<Authorizer> authorizers()

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