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:
org.cometd.bayeux.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
org.cometd.bayeux.Bayeux.BayeuxListener, org.cometd.bayeux.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 java.lang.String
ALLOWED_TRANSPORTS_OPTION
static java.lang.String
BROADCAST_TO_PUBLISHER_OPTION
static java.lang.String
EXECUTOR_MAX_THREADS
static java.lang.String
SCHEDULER_THREADS
static java.lang.String
SWEEP_PERIOD_OPTION
static java.lang.String
TRANSPORTS_OPTION
static java.lang.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)
void
addListener(BayeuxServer.BayeuxServerListener listener)
protected void
addServerSession(ServerSessionImpl session, ServerMessage message)
ServerTransport
addTransport(ServerTransport transport)
org.cometd.bayeux.MarkedReference<ServerChannel>
createChannelIfAbsent(java.lang.String channelName, ConfigurableServerChannel.Initializer... initializers)
protected ServerMessage.Mutable
createReply(ServerMessage.Mutable message)
protected void
doStart()
protected void
doStop()
void
dump(java.lang.Appendable out, java.lang.String indent)
protected void
error(ServerMessage.Mutable reply, java.lang.String error)
void
execute(java.lang.Runnable job)
protected void
extendOutgoing(ServerSession sender, ServerSession session, ServerMessage.Mutable message, org.cometd.bayeux.Promise<java.lang.Boolean> promise)
void
extendReply(ServerSessionImpl sender, ServerSessionImpl session, ServerMessage.Mutable reply, org.cometd.bayeux.Promise<ServerMessage.Mutable> promise)
protected AbstractHttpTransport
findHttpTransport(javax.servlet.http.HttpServletRequest request)
void
freeze(ServerMessage.Mutable mutable)
java.util.List<java.lang.String>
getAllowedTransports()
ServerChannel
getChannel(java.lang.String channelId)
java.util.List<ServerChannel>
getChannels()
java.util.concurrent.Executor
getExecutor()
java.util.List<BayeuxServer.Extension>
getExtensions()
JSONContextServer
getJSONContext()
java.util.Set<java.lang.String>
getKnownTransportNames()
protected java.util.List<BayeuxServer.BayeuxServerListener>
getListeners()
java.lang.String
getName()
java.lang.Object
getOption(java.lang.String qualifiedName)
protected boolean
getOption(java.lang.String name, boolean dft)
protected long
getOption(java.lang.String name, long dft)
java.util.Set<java.lang.String>
getOptionNames()
java.util.Map<java.lang.String,java.lang.Object>
getOptions()
org.eclipse.jetty.util.thread.Scheduler
getScheduler()
SecurityPolicy
getSecurityPolicy()
ServerSession
getSession(java.lang.String clientId)
java.util.List<ServerSession>
getSessions()
ServerTransport
getTransport(java.lang.String transport)
java.util.List<ServerTransport>
getTransports()
void
handle(ServerSessionImpl session, ServerMessage.Mutable message, org.cometd.bayeux.Promise<ServerMessage.Mutable> promise)
protected void
initializeJSONContext()
protected void
initializeMetaChannels()
protected void
initializeServerTransports()
boolean
isBroadcastToPublisher()
boolean
isDetailedDump()
org.cometd.bayeux.ChannelId
newChannelId(java.lang.String id)
LocalSession
newLocalSession(java.lang.String idHint)
ServerMessage.Mutable
newMessage()
ServerMessage.Mutable
newMessage(ServerMessage original)
ServerSessionImpl
newServerSession()
protected void
publish(ServerSessionImpl session, ServerChannelImpl channel, ServerMessage.Mutable message, boolean receiving, org.cometd.bayeux.Promise<java.lang.Boolean> promise)
long
randomLong()
void
removeExtension(BayeuxServer.Extension extension)
void
removeListener(BayeuxServer.BayeuxServerListener listener)
protected boolean
removeServerChannel(ServerChannelImpl channel)
boolean
removeServerSession(ServerSession session, boolean timeout)
boolean
removeSession(ServerSession session)
protected org.cometd.bayeux.Promise<java.lang.Boolean>
resolveLoop(AsyncFoldLeft.Loop<java.lang.Boolean> loop)
org.eclipse.jetty.util.thread.Scheduler.Task
schedule(java.lang.Runnable task, long delay)
Entry point to schedule tasks in CometD.void
setAllowedTransports(java.lang.String... allowed)
void
setAllowedTransports(java.util.List<java.lang.String> allowed)
void
setDetailedDump(boolean detailedDump)
void
setExecutor(java.util.concurrent.Executor executor)
void
setOption(java.lang.String qualifiedName, java.lang.Object value)
void
setOptions(java.util.Map<java.lang.String,java.lang.Object> options)
void
setScheduler(org.eclipse.jetty.util.thread.Scheduler scheduler)
void
setSecurityPolicy(SecurityPolicy securityPolicy)
void
setTransports(java.util.List<ServerTransport> transports)
void
setTransports(ServerTransport... transports)
void
sweep()
protected void
unknownSession(ServerMessage.Mutable reply)
protected java.lang.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
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 java.lang.String ALLOWED_TRANSPORTS_OPTION- See Also:
- Constant Field Values
-
SWEEP_PERIOD_OPTION
public static final java.lang.String SWEEP_PERIOD_OPTION- See Also:
- Constant Field Values
-
TRANSPORTS_OPTION
public static final java.lang.String TRANSPORTS_OPTION- See Also:
- Constant Field Values
-
VALIDATE_MESSAGE_FIELDS_OPTION
public static final java.lang.String VALIDATE_MESSAGE_FIELDS_OPTION- See Also:
- Constant Field Values
-
BROADCAST_TO_PUBLISHER_OPTION
public static final java.lang.String BROADCAST_TO_PUBLISHER_OPTION- See Also:
- Constant Field Values
-
SCHEDULER_THREADS
public static final java.lang.String SCHEDULER_THREADS- See Also:
- Constant Field Values
-
EXECUTOR_MAX_THREADS
public static final java.lang.String EXECUTOR_MAX_THREADS- See Also:
- Constant Field Values
-
-
Constructor Details
-
BayeuxServerImpl
public BayeuxServerImpl()
-
-
Method Details
-
getName
public java.lang.String getName() -
doStart
protected void doStart() throws java.lang.Exception- Overrides:
doStart
in classorg.eclipse.jetty.util.component.ContainerLifeCycle
- Throws:
java.lang.Exception
-
doStop
protected void doStop() throws java.lang.Exception- Overrides:
doStop
in classorg.eclipse.jetty.util.component.ContainerLifeCycle
- Throws:
java.lang.Exception
-
initializeMetaChannels
protected void initializeMetaChannels() -
initializeJSONContext
protected void initializeJSONContext() throws java.lang.Exception- Throws:
java.lang.Exception
-
initializeServerTransports
protected void initializeServerTransports() -
setExecutor
public void setExecutor(java.util.concurrent.Executor executor) -
getExecutor
public java.util.concurrent.Executor getExecutor() -
execute
public void execute(java.lang.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(java.lang.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 scheduledelay
- the delay, in milliseconds, to run the task- Returns:
- the task promise
-
newChannelId
public org.cometd.bayeux.ChannelId newChannelId(java.lang.String id) -
getOptions
public java.util.Map<java.lang.String,java.lang.Object> getOptions() -
getOption
@ManagedOperation(value="The value of the given configuration option", impact="INFO") public java.lang.Object getOption(@Name("optionName") java.lang.String qualifiedName)- Specified by:
getOption
in interfaceorg.cometd.bayeux.Bayeux
-
getOption
protected long getOption(java.lang.String name, long dft) -
getOption
protected boolean getOption(java.lang.String name, boolean dft) -
getOptionNames
public java.util.Set<java.lang.String> getOptionNames()- Specified by:
getOptionNames
in interfaceorg.cometd.bayeux.Bayeux
-
setOption
public void setOption(java.lang.String qualifiedName, java.lang.Object value)- Specified by:
setOption
in interfaceorg.cometd.bayeux.Bayeux
-
setOptions
public void setOptions(java.util.Map<java.lang.String,java.lang.Object> options) -
randomLong
public long randomLong() -
getSecurityPolicy
- Specified by:
getSecurityPolicy
in interfaceBayeuxServer
-
getJSONContext
-
createChannelIfAbsent
public org.cometd.bayeux.MarkedReference<ServerChannel> createChannelIfAbsent(java.lang.String channelName, ConfigurableServerChannel.Initializer... initializers)- Specified by:
createChannelIfAbsent
in interfaceBayeuxServer
-
getSessions
- Specified by:
getSessions
in interfaceBayeuxServer
-
getSession
- Specified by:
getSession
in interfaceBayeuxServer
-
addServerSession
-
removeSession
- Specified by:
removeSession
in interfaceBayeuxServer
-
removeServerSession
- Parameters:
session
- the session to removetimeout
- whether the session has been removed due to a timeout- Returns:
- true if the session was removed and was connected
-
newServerSession
-
newLocalSession
- Specified by:
newLocalSession
in interfaceBayeuxServer
-
newMessage
- Specified by:
newMessage
in interfaceBayeuxServer
-
newMessage
-
setSecurityPolicy
- Specified by:
setSecurityPolicy
in interfaceBayeuxServer
-
addExtension
- Specified by:
addExtension
in interfaceBayeuxServer
-
removeExtension
- Specified by:
removeExtension
in interfaceBayeuxServer
-
getExtensions
- Specified by:
getExtensions
in interfaceBayeuxServer
-
addListener
- Specified by:
addListener
in interfaceBayeuxServer
-
getChannel
- Specified by:
getChannel
in interfaceBayeuxServer
-
getChannels
- Specified by:
getChannels
in interfaceBayeuxServer
-
removeListener
- Specified by:
removeListener
in interfaceBayeuxServer
-
handle
public void handle(ServerSessionImpl session, ServerMessage.Mutable message, org.cometd.bayeux.Promise<ServerMessage.Mutable> promise) -
validateMessage
-
publish
protected void publish(ServerSessionImpl session, ServerChannelImpl channel, ServerMessage.Mutable message, boolean receiving, org.cometd.bayeux.Promise<java.lang.Boolean> promise) -
resolveLoop
protected org.cometd.bayeux.Promise<java.lang.Boolean> resolveLoop(AsyncFoldLeft.Loop<java.lang.Boolean> loop) -
freeze
-
extendOutgoing
protected void extendOutgoing(ServerSession sender, ServerSession session, ServerMessage.Mutable message, org.cometd.bayeux.Promise<java.lang.Boolean> promise) -
extendReply
public void extendReply(ServerSessionImpl sender, ServerSessionImpl session, ServerMessage.Mutable reply, org.cometd.bayeux.Promise<ServerMessage.Mutable> promise) -
removeServerChannel
-
getListeners
-
getKnownTransportNames
public java.util.Set<java.lang.String> getKnownTransportNames()- Specified by:
getKnownTransportNames
in interfaceorg.cometd.bayeux.Bayeux
-
getTransport
- Specified by:
getTransport
in interfaceorg.cometd.bayeux.Bayeux
-
addTransport
-
setTransports
-
setTransports
-
getTransports
-
findHttpTransport
-
getAllowedTransports
@ManagedAttribute(value="The transports allowed by this CoemtD server", readonly=true) public java.util.List<java.lang.String> getAllowedTransports()- Specified by:
getAllowedTransports
in interfaceorg.cometd.bayeux.Bayeux
-
setAllowedTransports
public void setAllowedTransports(java.lang.String... allowed) -
setAllowedTransports
public void setAllowedTransports(java.util.List<java.lang.String> allowed) -
isBroadcastToPublisher
@ManagedAttribute(value="Whether this CometD server broadcast messages to the publisher", readonly=true) public boolean isBroadcastToPublisher() -
unknownSession
-
error
-
createReply
-
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(java.lang.Appendable out, java.lang.String indent) throws java.io.IOException- Specified by:
dump
in interfaceorg.eclipse.jetty.util.component.Dumpable
- Overrides:
dump
in classorg.eclipse.jetty.util.component.ContainerLifeCycle
- Throws:
java.io.IOException
-