Class AbstractService
AbstractService
provides convenience methods to assist with the
creation of a CometD services.
A CometD service runs application code whenever a message is received on a particular channel.
Specifically it provides:
- Mapping of channel subscriptions to method invocation on the derived service class.
- Optional use of a thread pool used for method invocation if handling can take considerable time and it is desired not to hold up the delivering thread (typically a HTTP request handling thread).
- The objects returned from method invocation are delivered back to the calling client in a private message.
Subclasses should call addService(String, String)
in order to
map channel subscriptions to method invocations, usually in the subclass
constructor.
Each CometD service has an associated LocalSession
that can be
used as the source for messages published via
ServerChannel.publish(Session, ServerMessage.Mutable, Promise)
or
ServerSession.deliver(Session, ServerMessage.Mutable, Promise)
.
- See Also:
-
Constructor Summary
ConstructorDescriptionAbstractService
(BayeuxServer bayeux, String name) Instantiates a CometD service with the given name.AbstractService
(BayeuxServer bayeux, String name, int maxThreads) Instantiate a CometD service with the given name and max number of pooled threads. -
Method Summary
Modifier and TypeMethodDescriptionvoid
addService
(String channelName, String methodName) Maps the method of a subclass with the given name to aServerChannel.MessageListener
on the given channel, so that the method is invoked for each message received on the channel.protected void
doInvoke
(Method method, ServerSession session, ServerMessage message) protected void
exception
(String method, ServerSession session, LocalSession local, ServerMessage message, Throwable x) Handles exceptions during the invocation of a mapped method.getName()
org.eclipse.jetty.util.thread.ThreadPool
boolean
void
removeService
(String channelName) Unmaps all the methods that have been mapped to the given channel.void
removeService
(String channelName, String methodName) Unmaps the method with the given name that has been mapped to the given channel.protected void
send
(ServerSession toClient, String onChannel, Object data) Sends data to an individual remote client.void
setSeeOwnPublishes
(boolean seeOwnPublishes) void
setThreadPool
(org.eclipse.jetty.util.thread.ThreadPool pool) Sets the thread pool associated to this CometD service.
-
Constructor Details
-
AbstractService
Instantiates a CometD service with the given name.
- Parameters:
bayeux
- The BayeuxServer instance.name
- The name of the service (used as client ID prefix).
-
AbstractService
Instantiate a CometD service with the given name and max number of pooled threads.
- Parameters:
bayeux
- The BayeuxServer instance.name
- The name of the service (used as client ID prefix).maxThreads
- The max size of a ThreadPool to create to handle messages.
-
-
Method Details
-
getBayeux
-
getName
-
getLocalSession
- Returns:
- The
LocalSession
associated with this CometD service
-
getServerSession
- Returns:
- The
ServerSession
of theLocalSession
associated with this CometD service
-
getThreadPool
public org.eclipse.jetty.util.thread.ThreadPool getThreadPool()- Returns:
- The thread pool associated with this CometD service, or null
- See Also:
-
setThreadPool
public void setThreadPool(org.eclipse.jetty.util.thread.ThreadPool pool) Sets the thread pool associated to this CometD service.
If the
ThreadPool
is aLifeCycle
instance, and it is not already started, then it will started.- Parameters:
pool
- The ThreadPool
-
isSeeOwnPublishes
public boolean isSeeOwnPublishes()- Returns:
- whether this CometD service receives messages published by itself on channels it is subscribed to (defaults to false).
- See Also:
-
setSeeOwnPublishes
public void setSeeOwnPublishes(boolean seeOwnPublishes) - Parameters:
seeOwnPublishes
- whether this CometD service receives messages published by itself on channels it is subscribed to (defaults to false).- See Also:
-
addService
Maps the method of a subclass with the given name to a
ServerChannel.MessageListener
on the given channel, so that the method is invoked for each message received on the channel.The channel name may be a
wildcard channel name
.The method must have a unique name and the following signature:
myMethod(ServerSession from, ServerMessage message)
Typically a service will be used to a channel in the
/service/**
space which is not a broadcast channel.Any object returned by a mapped method is delivered back to the client that sent the message and not broadcast. If the method returns void or null, then no response is sent.
A mapped method may also call
send(org.cometd.bayeux.server.ServerSession, String, Object)
to deliver message(s) to specific clients and/or channels.A mapped method may also publish to different channels via
ServerChannel.publish(Session, ServerMessage.Mutable, Promise)
.- Parameters:
channelName
- The channel to listen tomethodName
- The name of the method on this subclass to call when messages are received on the channel- See Also:
-
removeService
-
removeService
Unmaps all the methods that have been mapped to the given channel.
- Parameters:
channelName
- The channel name- See Also:
-
send
Sends data to an individual remote client.
The data passed is sent to the client as the "data" member of a message with the given channel. The message is not published on the channel and is thus not broadcast to all channel subscribers, but instead delivered directly to the target client.
Typically this method is only required if a service method sends response(s) to clients other than the sender, or on different channels. If the response is to be sent to the sender on the same channel, then the data can simply be the return value of the method.
- Parameters:
toClient
- The target clientonChannel
- The channel of the messagedata
- The data of the message
-
exception
protected void exception(String method, ServerSession session, LocalSession local, ServerMessage message, Throwable x) Handles exceptions during the invocation of a mapped method.
This method is called when a mapped method throws and exception while handling a message.
- Parameters:
method
- the name of the method invoked that threw an exceptionsession
- the remote session that sent the messagelocal
- the local session associated to this servicemessage
- the message sent by the remote sessionx
- the exception thrown
-
doInvoke
-