Interface BayeuxServer
- All Superinterfaces:
org.cometd.bayeux.Bayeux
The server-side Bayeux interface.
An instance of the BayeuxServer interface is available to
web applications via the ""org.cometd.bayeux"" attribute
of the javax.servlet.ServletContext.
The BayeuxServer APIs give access to the
ServerSessions via the getSession(String)
method. It also allows new LocalSession to be
created within the server using the newLocalSession(String)
method.
ServerChannel instances may be accessed via the
getChannel(String) method, but the server has
no direct relationship with ClientSessionChannels or
ClientSession.
If subscription semantics is required, then
the newLocalSession(String) method should be used to
create a LocalSession that can subscribe and publish
like a client-side Bayeux session.
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic interfaceCommon base interface for all server-side Bayeux listeners.static interfaceSpecialized listener forServerChannelevents.static interfaceExtension API forBayeuxServer.static interfaceSpecialized listener forServerSessionevents.static interfaceSpecialized listener forServerChannelsubscription events.Nested classes/interfaces inherited from interface org.cometd.bayeux.Bayeux
org.cometd.bayeux.Bayeux.BayeuxListener, org.cometd.bayeux.Bayeux.Validator -
Field Summary
Fields -
Method Summary
Modifier and TypeMethodDescriptionvoidaddExtension(BayeuxServer.Extension extension) Adds the given extension to this Bayeux object.voidaddListener(BayeuxServer.BayeuxServerListener listener) Adds a listener to this Bayeux object.org.cometd.bayeux.MarkedReference<ServerChannel>createChannelIfAbsent(String channelName, ConfigurableServerChannel.Initializer... initializers) Creates aServerChanneland initializes it atomically if the channel does not exist, or returns it if it already exists.getChannel(String channelId) getSession(String clientId) newLocalSession(String idHint) Creates a newLocalSession.voidremoveExtension(BayeuxServer.Extension extension) Removes the given extension from this Bayeux object.voidRemoves a listener from this Bayeux object.booleanremoveSession(ServerSession session) Removes the givensessionfrom this BayeuxServer.voidsetSecurityPolicy(SecurityPolicy securityPolicy) Methods inherited from interface org.cometd.bayeux.Bayeux
getAllowedTransports, getKnownTransportNames, getOption, getOptionNames, getTransport, setOption
-
Field Details
-
ATTRIBUTE
ServletContext attribute name used to obtain the Bayeux object- See Also:
-
-
Method Details
-
addExtension
Adds the given extension to this Bayeux object.
- Parameters:
extension- the extension to add- See Also:
-
removeExtension
Removes the given extension from this Bayeux object.
- Parameters:
extension- the extension to remove- See Also:
-
getExtensions
List<BayeuxServer.Extension> getExtensions()- Returns:
- an immutable list of extensions present in this BayeuxServer instance
- See Also:
-
addListener
Adds a listener to this Bayeux object.
- Parameters:
listener- the listener to add- See Also:
-
removeListener
Removes a listener from this Bayeux object.
- Parameters:
listener- the listener to remove- See Also:
-
getChannel
- Parameters:
channelId- the channel identifier- Returns:
- a
ServerChannelwith the givenchannelId, or null if no such channel exists - See Also:
-
getChannels
List<ServerChannel> getChannels()- Returns:
- the list of channels known to this BayeuxServer object
-
createChannelIfAbsent
org.cometd.bayeux.MarkedReference<ServerChannel> createChannelIfAbsent(String channelName, ConfigurableServerChannel.Initializer... initializers) Creates a
ServerChanneland 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.ChannelListenerto atomically initialize a channel. Theinitializerswill 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.
- Parameters:
channelName- the channel nameinitializers- the initializers invoked to configure the channel- Returns:
- a
MarkedReferencewhose reference is the channel, and the mark signals whether the channel has been created because it did not exist before.
-
getSession
- Parameters:
clientId- theServerSessionidentifier- Returns:
- the
ServerSessionwith the givenclientIdor null if no such valid session exists.
-
getSessions
List<ServerSession> getSessions()- Returns:
- the list of
ServerSessions known to this BayeuxServer object
-
removeSession
Removes the given
sessionfrom 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.
- Parameters:
session- the session to remove- Returns:
- true if the session was known to this BayeuxServer and was removed
-
newLocalSession
Creates a new
LocalSession.A
LocalSessionis 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.- Parameters:
idHint- a hint to be included in the unique clientId of the session.- Returns:
- a new
LocalSession
-
newMessage
ServerMessage.Mutable newMessage()- Returns:
- a new or recycled mutable message instance.
-
getSecurityPolicy
SecurityPolicy getSecurityPolicy()- Returns:
- the
SecurityPolicyassociated with this session - See Also:
-
setSecurityPolicy
- Parameters:
securityPolicy- theSecurityPolicyassociated with this session- See Also:
-