Package org.cometd.server

Class BayeuxServerImpl

java.lang.Object

org.eclipse.jetty.util.component.AbstractLifeCycle

org.eclipse.jetty.util.component.ContainerLifeCycle

org.cometd.server.BayeuxServerImpl

All Implemented Interfaces:

Bayeux, BayeuxServer, org.eclipse.jetty.util.component.Container, org.eclipse.jetty.util.component.Destroyable, org.eclipse.jetty.util.component.Dumpable, org.eclipse.jetty.util.component.Dumpable.DumpableContainer, org.eclipse.jetty.util.component.LifeCycle

@ManagedObject("The CometD server")
public class BayeuxServerImpl
extends org.eclipse.jetty.util.component.ContainerLifeCycle
implements BayeuxServer, org.eclipse.jetty.util.component.Dumpable

Nested Class Summary

Nested classes/interfaces inherited from class org.eclipse.jetty.util.component.AbstractLifeCycle

org.eclipse.jetty.util.component.AbstractLifeCycle.AbstractLifeCycleListener, org.eclipse.jetty.util.component.AbstractLifeCycle.StopException

Nested classes/interfaces inherited from interface org.cometd.bayeux.Bayeux

Bayeux.BayeuxListener, Bayeux.Validator

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

BayeuxServer.BayeuxServerListener, BayeuxServer.ChannelListener, BayeuxServer.Extension, BayeuxServer.SessionListener, BayeuxServer.SubscriptionListener

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

org.eclipse.jetty.util.component.Container.InheritedListener, org.eclipse.jetty.util.component.Container.Listener

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.eclipse.jetty.util.component.LifeCycle

org.eclipse.jetty.util.component.LifeCycle.Listener

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ALLOWED_TRANSPORTS_OPTION
static final String	BROADCAST_TO_PUBLISHER_OPTION
static final String	EXECUTOR_MAX_THREADS
static final String	SCHEDULER_THREADS
static final String	SWEEP_PERIOD_OPTION
static final String	TRANSPORTS_OPTION
static final String	VALIDATE_MESSAGE_FIELDS_OPTION

Fields inherited from class org.eclipse.jetty.util.component.AbstractLifeCycle

FAILED, STARTED, STARTING, STOPPED, STOPPING

Fields inherited from interface org.cometd.bayeux.server.BayeuxServer

ATTRIBUTE

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

KEY

Constructor Summary

Constructors

Constructor	Description
BayeuxServerImpl()

Method Summary

Modifier and Type	Method	Description
void	addExtension(BayeuxServer.Extension extension)	Adds the given extension to this Bayeux object.
void	addListener(BayeuxServer.BayeuxServerListener listener)	Adds a listener to this Bayeux object.
protected void	addServerSession(ServerSessionImpl session, ServerMessage message)
ServerTransport	addTransport(ServerTransport transport)
MarkedReference<ServerChannel>	createChannelIfAbsent(String channelName, ConfigurableServerChannel.Initializer... initializers)	Creates a ServerChannel and initializes it atomically if the channel does not exist, or returns it if it already exists.
protected ServerMessage.Mutable	createReply(ServerMessage.Mutable message)
protected void	doStart()
protected void	doStop()
void	dump(Appendable out, String indent)
protected void	error(ServerMessage.Mutable reply, String error)
void	execute(Runnable job)
protected void	extendOutgoing(ServerSession sender, ServerSession session, ServerMessage.Mutable message, Promise<Boolean> promise)
void	extendReply(ServerSessionImpl sender, ServerSessionImpl session, ServerMessage.Mutable reply, Promise<ServerMessage.Mutable> promise)
protected AbstractHttpTransport	findHttpTransport(jakarta.servlet.http.HttpServletRequest request)
void	freeze(ServerMessage.Mutable mutable)
List<String>	getAllowedTransports()
ServerChannel	getChannel(String channelId)
List<ServerChannel>	getChannels()
Executor	getExecutor()
List<BayeuxServer.Extension>	getExtensions()
JSONContextServer	getJSONContext()
Set<String>	getKnownTransportNames()
protected List<BayeuxServer.BayeuxServerListener>	getListeners()
String	getName()
Object	getOption(String qualifiedName)
protected boolean	getOption(String name, boolean dft)
protected long	getOption(String name, long dft)
Set<String>	getOptionNames()
Map<String,Object>	getOptions()
org.eclipse.jetty.util.thread.Scheduler	getScheduler()
SecurityPolicy	getSecurityPolicy()
ServerSession	getSession(String clientId)
List<ServerSession>	getSessions()
ServerTransport	getTransport(String transport)
List<ServerTransport>	getTransports()
void	handle(ServerSessionImpl session, ServerMessage.Mutable message, Promise<ServerMessage.Mutable> promise)
protected void	initializeJSONContext()
protected void	initializeMetaChannels()
protected void	initializeServerTransports()
boolean	isBroadcastToPublisher()
boolean	isDetailedDump()
ChannelId	newChannelId(String id)
LocalSession	newLocalSession(String idHint)	Creates a new LocalSession.
ServerMessage.Mutable	newMessage()
ServerMessage.Mutable	newMessage(ServerMessage original)
ServerSessionImpl	newServerSession()
protected void	publish(ServerSessionImpl session, ServerChannelImpl channel, ServerMessage.Mutable message, boolean receiving, Promise<Boolean> promise)
long	randomLong()
void	removeExtension(BayeuxServer.Extension extension)	Removes the given extension from this Bayeux object.
void	removeListener(BayeuxServer.BayeuxServerListener listener)	Removes a listener from this Bayeux object.
protected boolean	removeServerChannel(ServerChannelImpl channel)
boolean	removeServerSession(ServerSession session, boolean timeout)
boolean	removeSession(ServerSession session)	Removes the given session from this BayeuxServer.
protected Promise<Boolean>	resolveLoop(AsyncFoldLeft.Loop<Boolean> loop)
org.eclipse.jetty.util.thread.Scheduler.Task	schedule(Runnable task, long delay)	Entry point to schedule tasks in CometD.
void	setAllowedTransports(String... allowed)
void	setAllowedTransports(List<String> allowed)
void	setDetailedDump(boolean detailedDump)
void	setExecutor(Executor executor)
void	setOption(String qualifiedName, Object value)
void	setOptions(Map<String,Object> options)
void	setScheduler(org.eclipse.jetty.util.thread.Scheduler scheduler)
void	setSecurityPolicy(SecurityPolicy securityPolicy)
void	setTransports(List<ServerTransport> transports)
void	setTransports(ServerTransport... transports)
void	sweep()
protected void	unknownSession(ServerMessage.Mutable reply)
protected String	validateMessage(ServerMessage.Mutable message)

Methods inherited from class org.eclipse.jetty.util.component.ContainerLifeCycle

addBean, addBean, addEventListener, addManaged, contains, destroy, dump, dump, dumpObjects, dumpStdErr, getBean, getBeans, getBeans, getContainedBeans, getContainedBeans, isAuto, isManaged, isUnmanaged, manage, removeBean, removeBeans, removeEventListener, setBeans, start, stop, unmanage, updateBean, updateBean, updateBeans, updateBeans

Methods inherited from class org.eclipse.jetty.util.component.AbstractLifeCycle

getEventListeners, getState, getState, isFailed, isRunning, isStarted, isStarting, isStopped, isStopping, setEventListeners, start, stop, toString

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.Container

getCachedBeans, getEventListeners

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

dump, dumpSelf

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

isDumpable

Field Details

ALLOWED_TRANSPORTS_OPTION

public static final String ALLOWED_TRANSPORTS_OPTION

See Also:

• Constant Field Values

SWEEP_PERIOD_OPTION

public static final String SWEEP_PERIOD_OPTION

See Also:

• Constant Field Values

TRANSPORTS_OPTION

public static final String TRANSPORTS_OPTION

See Also:

• Constant Field Values

VALIDATE_MESSAGE_FIELDS_OPTION

public static final String VALIDATE_MESSAGE_FIELDS_OPTION

See Also:

• Constant Field Values

BROADCAST_TO_PUBLISHER_OPTION

public static final String BROADCAST_TO_PUBLISHER_OPTION

See Also:

• Constant Field Values

SCHEDULER_THREADS

public static final String SCHEDULER_THREADS

See Also:

• Constant Field Values

EXECUTOR_MAX_THREADS

public static final String EXECUTOR_MAX_THREADS

See Also:

• Constant Field Values

Constructor Details

BayeuxServerImpl

public BayeuxServerImpl()

Method Details

getName

public String getName()

doStart

protected void doStart()
                throws Exception

Overrides:

doStart in class org.eclipse.jetty.util.component.ContainerLifeCycle

Throws:

Exception

doStop

protected void doStop()
               throws Exception

Overrides:

doStop in class org.eclipse.jetty.util.component.ContainerLifeCycle

Throws:

Exception

initializeMetaChannels

protected void initializeMetaChannels()

initializeJSONContext

protected void initializeJSONContext()
                              throws Exception

Throws:

Exception

initializeServerTransports

protected void initializeServerTransports()

setExecutor

public void setExecutor(Executor executor)

getExecutor

public Executor getExecutor()

execute

public void execute(Runnable job)

setScheduler

public void setScheduler(org.eclipse.jetty.util.thread.Scheduler scheduler)

getScheduler

public org.eclipse.jetty.util.thread.Scheduler getScheduler()

schedule

public org.eclipse.jetty.util.thread.Scheduler.Task schedule(Runnable task,
 long delay)

Entry point to schedule tasks in CometD.

Subclasses may override and run the task in a Executor, rather than in the scheduler thread.

Parameters:

task - the task to schedule

delay - the delay, in milliseconds, to run the task

Returns:

the task promise

newChannelId

public ChannelId newChannelId(String id)

getOptions

public Map<String,Object> getOptions()

getOption

@ManagedOperation(value="The value of the given configuration option",
                  impact="INFO")
public Object getOption(@Name("optionName")
 String qualifiedName)

Specified by:

getOption in interface Bayeux

Parameters:

qualifiedName - the configuration option name

Returns:

the configuration option with the given qualifiedName

See Also:

• Bayeux.setOption(String, Object)
• Bayeux.getOptionNames()

getOption

protected long getOption(String name,
 long dft)

getOption

protected boolean getOption(String name,
 boolean dft)

getOptionNames

public Set<String> getOptionNames()

Specified by:

getOptionNames in interface Bayeux

Returns:

the set of configuration options

See Also:

• Bayeux.getOption(String)

setOption

public void setOption(String qualifiedName,
 Object value)

Specified by:

setOption in interface Bayeux

Parameters:

qualifiedName - the configuration option name

value - the configuration option value

See Also:

• Bayeux.getOption(String)

setOptions

public void setOptions(Map<String,Object> options)

randomLong

public long randomLong()

getSecurityPolicy

public SecurityPolicy getSecurityPolicy()

Specified by:

getSecurityPolicy in interface BayeuxServer

Returns:

the SecurityPolicy associated with this session

See Also:

• BayeuxServer.setSecurityPolicy(SecurityPolicy)

getJSONContext

public JSONContextServer getJSONContext()

createChannelIfAbsent

public MarkedReference<ServerChannel> createChannelIfAbsent(String channelName,
 ConfigurableServerChannel.Initializer... initializers)

Description copied from interface: BayeuxServer

Creates a ServerChannel and initializes it atomically if the channel does not exist, or returns it if it already exists.

This method can be used instead of adding a BayeuxServer.ChannelListener to atomically initialize a channel. The initializers will be called before any other thread can access the new channel instance.

This method should be used when a channel needs to be initialized (e.g. by adding listeners) before any publish or subscribes can occur on the channel, or before any other thread may concurrently create the same channel.

Specified by:

createChannelIfAbsent in interface BayeuxServer

Parameters:

channelName - the channel name

initializers - the initializers invoked to configure the channel

Returns:

a MarkedReference whose reference is the channel, and the mark signals whether the channel has been created because it did not exist before.

getSessions

public List<ServerSession> getSessions()

Specified by:

getSessions in interface BayeuxServer

Returns:

the list of ServerSessions known to this BayeuxServer object

getSession

public ServerSession getSession(String clientId)

Specified by:

getSession in interface BayeuxServer

Parameters:

clientId - the ServerSession identifier

Returns:

the ServerSession with the given clientId or null if no such valid session exists.

addServerSession

protected void addServerSession(ServerSessionImpl session,
 ServerMessage message)

removeSession

public boolean removeSession(ServerSession session)

Description copied from interface: BayeuxServer

Removes the given session from this BayeuxServer.

This method triggers the invocation of all listeners that would be called if the session was disconnected or if the session timed out.

Specified by:

removeSession in interface BayeuxServer

Parameters:

session - the session to remove

Returns:

true if the session was known to this BayeuxServer and was removed

removeServerSession

public boolean removeServerSession(ServerSession session,
 boolean timeout)

Parameters:

session - the session to remove

timeout - whether the session has been removed due to a timeout

Returns:

true if the session was removed and was connected

newServerSession

public ServerSessionImpl newServerSession()

newLocalSession

public LocalSession newLocalSession(String idHint)

Description copied from interface: BayeuxServer

Creates a new LocalSession.

A LocalSession is a server-side ClientSession that allows server-side code to have special clients (resident within the same JVM) that can be used to publish and subscribe like a client-side session would do.

Specified by:

newLocalSession in interface BayeuxServer

Parameters:

idHint - a hint to be included in the unique clientId of the session.

Returns:

a new LocalSession

newMessage

public ServerMessage.Mutable newMessage()

Specified by:

newMessage in interface BayeuxServer

Returns:

a new or recycled mutable message instance.

newMessage

public ServerMessage.Mutable newMessage(ServerMessage original)

setSecurityPolicy

public void setSecurityPolicy(SecurityPolicy securityPolicy)

Specified by:

setSecurityPolicy in interface BayeuxServer

Parameters:

securityPolicy - the SecurityPolicy associated with this session

See Also:

• BayeuxServer.getSecurityPolicy()

addExtension

public void addExtension(BayeuxServer.Extension extension)

Description copied from interface: BayeuxServer

Adds the given extension to this Bayeux object.

Specified by:

addExtension in interface BayeuxServer

Parameters:

extension - the extension to add

See Also:

• BayeuxServer.removeExtension(Extension)

removeExtension

public void removeExtension(BayeuxServer.Extension extension)

Description copied from interface: BayeuxServer

Removes the given extension from this Bayeux object.

Specified by:

removeExtension in interface BayeuxServer

Parameters:

extension - the extension to remove

See Also:

• BayeuxServer.addExtension(Extension)

getExtensions

public List<BayeuxServer.Extension> getExtensions()

Specified by:

getExtensions in interface BayeuxServer

Returns:

an immutable list of extensions present in this BayeuxServer instance

See Also:

• BayeuxServer.addExtension(Extension)

addListener

public void addListener(BayeuxServer.BayeuxServerListener listener)

Description copied from interface: BayeuxServer

Adds a listener to this Bayeux object.

Specified by:

addListener in interface BayeuxServer

Parameters:

listener - the listener to add

See Also:

• BayeuxServer.removeListener(BayeuxServerListener)

getChannel

public ServerChannel getChannel(String channelId)

Specified by:

getChannel in interface BayeuxServer

Parameters:

channelId - the channel identifier

Returns:

a ServerChannel with the given channelId, or null if no such channel exists

See Also:

• BayeuxServer.createChannelIfAbsent(String, ConfigurableServerChannel.Initializer...)

getChannels

public List<ServerChannel> getChannels()

Specified by:

getChannels in interface BayeuxServer

Returns:

the list of channels known to this BayeuxServer object

removeListener

public void removeListener(BayeuxServer.BayeuxServerListener listener)

Description copied from interface: BayeuxServer

Removes a listener from this Bayeux object.

Specified by:

removeListener in interface BayeuxServer

Parameters:

listener - the listener to remove

See Also:

• BayeuxServer.addListener(BayeuxServerListener)

handle

public void handle(ServerSessionImpl session,
 ServerMessage.Mutable message,
 Promise<ServerMessage.Mutable> promise)

validateMessage

protected String validateMessage(ServerMessage.Mutable message)

publish

protected void publish(ServerSessionImpl session,
 ServerChannelImpl channel,
 ServerMessage.Mutable message,
 boolean receiving,
 Promise<Boolean> promise)

resolveLoop

protected Promise<Boolean> resolveLoop(AsyncFoldLeft.Loop<Boolean> loop)

freeze

public void freeze(ServerMessage.Mutable mutable)

extendOutgoing

protected void extendOutgoing(ServerSession sender,
 ServerSession session,
 ServerMessage.Mutable message,
 Promise<Boolean> promise)

extendReply

public void extendReply(ServerSessionImpl sender,
 ServerSessionImpl session,
 ServerMessage.Mutable reply,
 Promise<ServerMessage.Mutable> promise)

removeServerChannel

protected boolean removeServerChannel(ServerChannelImpl channel)

getListeners

protected List<BayeuxServer.BayeuxServerListener> getListeners()

getKnownTransportNames

public Set<String> getKnownTransportNames()

Specified by:

getKnownTransportNames in interface Bayeux

Returns:

the set of known transport names of this Bayeux object.

See Also:

• Bayeux.getAllowedTransports()

getTransport

public ServerTransport getTransport(String transport)

Specified by:

getTransport in interface Bayeux

Parameters:

transport - the transport name

Returns:

the transport with the given name or null if no such transport exist

addTransport

public ServerTransport addTransport(ServerTransport transport)

setTransports

public void setTransports(ServerTransport... transports)

setTransports

public void setTransports(List<ServerTransport> transports)

getTransports

public List<ServerTransport> getTransports()

findHttpTransport

protected AbstractHttpTransport findHttpTransport(jakarta.servlet.http.HttpServletRequest request)

getAllowedTransports

@ManagedAttribute(value="The transports allowed by this CometD server",
                  readonly=true)
public List<String> getAllowedTransports()

Specified by:

getAllowedTransports in interface Bayeux

Returns:

the ordered list of transport names that will be used in the negotiation of transports with the other peer.

See Also:

• Bayeux.getKnownTransportNames()

setAllowedTransports

public void setAllowedTransports(String... allowed)

setAllowedTransports

public void setAllowedTransports(List<String> allowed)

isBroadcastToPublisher

@ManagedAttribute(value="Whether this CometD server broadcast messages to the publisher",
                  readonly=true)
public boolean isBroadcastToPublisher()

unknownSession

protected void unknownSession(ServerMessage.Mutable reply)

error

protected void error(ServerMessage.Mutable reply,
 String error)

createReply

protected ServerMessage.Mutable createReply(ServerMessage.Mutable message)

sweep

@ManagedOperation(value="Sweeps channels and sessions of this CometD server",
                  impact="ACTION")
public void sweep()

isDetailedDump

@ManagedAttribute("Reports additional details in the dump() operation")
public boolean isDetailedDump()

setDetailedDump

public void setDetailedDump(boolean detailedDump)

dump

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

Specified by:

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

Overrides:

dump in class org.eclipse.jetty.util.component.ContainerLifeCycle

Throws:

IOException