Package org.eclipse.scanning.event

Class EventServiceImpl

java.lang.Object

org.eclipse.scanning.event.EventServiceImpl

All Implemented Interfaces:

IEventService

public class EventServiceImpl
extends Object
implements IEventService

Constructor Summary

Constructors

Constructor	Description
EventServiceImpl()
EventServiceImpl(IEventConnectorService serviceToUse)

Method Summary

Modifier and Type	Method	Description
<T extends EventListener> ISubscriber<T>	createAMQPSubscriber(URI uri, String topicName)	Creates an ISubscriber for an AMQP topic with a given routingKey.
<U extends StatusBean> IJmsQueueReader<U>	createJmsQueueReader(URI uri, String queueName)	Create a Jms queue reader.
<U extends StatusBean> IJobQueue<U>	createJobQueue(URI uri)	Create an IJobQueue with the default submission queue, status topic and command topic names
<U extends StatusBean> IJobQueue<U>	createJobQueue(URI uri, String submissionQueueName, String statusTopicName)	Create a consumer with the given submission queue, and status topic names.
<U extends StatusBean> IJobQueue<U>	createJobQueue(URI uri, String submissionQName, String statusTopicName, String queueStatusTopicName, String commandTopicName, String commandAckTopicName)	Create a job queue with the given submission queue, status queue, status topic, consumer status topic, command topic and command acknowledgement topic names.
<U extends StatusBean> IJobQueue<U>	createJobQueueProxy(URI uri, String submissionQueueName)	Create a proxy for the IJobQueue for the given submission queue name, using the default command and command acknowledgement topics.
<U extends StatusBean> IJobQueue<U>	createJobQueueProxy(URI uri, String submissionQueueName, String commandTopicName, String commandAckTopicName)	Create a proxy for the IJobQueue for the given submission queue.
<U> IPublisher<U>	createPublisher(URI uri, String topicName)	Creates an IEventPublisher for the topic with the given name.
<T> T	createRemoteService(URI uri, Class<T> serviceClass)	Use this call to create a remote service.
<T extends IdBean> IRequester<T>	createRequestor(URI uri, String requestTopic, String responseTopic)	A poster encapsulates sending and receiving a reply.
<T extends IdBean> IResponder<T>	createResponder(URI uri, String requestTopic, String responseTopic)	Creates a responder on a given topic.
<U extends StatusBean> ISubmitter<U>	createSubmitter(URI uri, String queueName)	Create a submitter for adding a bean of type U onto the queue.
<T extends EventListener> ISubscriber<T>	createSubscriber(URI uri, String topicName)	Creates an ISubscriber for the topic with the given name.
void	disposeAllJobQueues()	Disconnect all JMS resources used by all IJobQueues and unregisters them from this service.
void	disposeJobQueue(String queueName)	Disconnect the JMS resources used by the IJobQueue for the given submission queue name and unregisters it from this service.
IEventConnectorService	getEventConnectorService()	The current event connector service that this event service is using to talk to messaging and to marshall objects.
IJobQueue<? extends StatusBean>	getJobQueue(String queueName)	Returns the job queue for the given submission queue name.
void	setEventConnectorService(IEventConnectorService eventService)

Methods inherited from class java.lang.Object

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

Constructor Details

EventServiceImpl

public EventServiceImpl()

EventServiceImpl

public EventServiceImpl(IEventConnectorService serviceToUse)

Method Details

setEventConnectorService

public void setEventConnectorService(IEventConnectorService eventService)

createSubscriber

public <T extends EventListener> ISubscriber<T> createSubscriber(URI uri,
 String topicName)

Description copied from interface: IEventService

Creates an ISubscriber for the topic with the given name. Useful on the client for adding event listeners to be notified. Scan events have a unique id with which to ascertain if a given scan event came from given scan.

Specified by:

createSubscriber in interface IEventService

Parameters:

uri - - the location of the JMS broker

Returns:

IEventManager

createAMQPSubscriber

public <T extends EventListener> ISubscriber<T> createAMQPSubscriber(URI uri,
 String topicName)

Description copied from interface: IEventService

Creates an ISubscriber for an AMQP topic with a given routingKey.

Specified by:

createAMQPSubscriber in interface IEventService

Parameters:

uri - - the location of the JMS broker

Returns:

IEventManager

createPublisher

public <U> IPublisher<U> createPublisher(URI uri,
 String topicName)

Description copied from interface: IEventService

Creates an IEventPublisher for the topic with the given name.

Specified by:

createPublisher in interface IEventService

Parameters:

uri - - the location of the JMS broker

Returns:

IEventManager

createSubmitter

public <U extends StatusBean> ISubmitter<U> createSubmitter(URI uri,
 String queueName)

Description copied from interface: IEventService

Create a submitter for adding a bean of type U onto the queue.

Specified by:

createSubmitter in interface IEventService

Parameters:

uri -

queueName -

Returns:

the new submitter

createJobQueue

public <U extends StatusBean> IJobQueue<U> createJobQueue(URI uri)
                                                   throws EventException

Description copied from interface: IEventService

Create an IJobQueue with the default submission queue, status topic and command topic names

Specified by:

createJobQueue in interface IEventService

Parameters:

uri -

Returns:

the new job queue

Throws:

EventException

createJobQueue

public <U extends StatusBean> IJobQueue<U> createJobQueue(URI uri,
 String submissionQueueName,
 String statusTopicName)
                                                   throws EventException

Description copied from interface: IEventService

Create a consumer with the given submission queue, and status topic names.

Specified by:

createJobQueue in interface IEventService

Parameters:

uri -

submissionQueueName - name of the submission queue

statusTopicName -

Returns:

the new job queue

Throws:

EventException

createJobQueue

public <U extends StatusBean> IJobQueue<U> createJobQueue(URI uri,
 String submissionQName,
 String statusTopicName,
 String queueStatusTopicName,
 String commandTopicName,
 String commandAckTopicName)
                                                   throws EventException

Description copied from interface: IEventService

Create a job queue with the given submission queue, status queue, status topic, consumer status topic, command topic and command acknowledgement topic names.

Specified by:

createJobQueue in interface IEventService

Parameters:

uri - the uri of the message

submissionQName -

statusTopicName -

commandTopicName -

commandAckTopicName -

Returns:

the new job queue

Throws:

EventException

getJobQueue

public IJobQueue<? extends StatusBean> getJobQueue(String queueName)
                                            throws EventException

Description copied from interface: IEventService

Returns the job queue for the given submission queue name. For server-side code only! Client-side code should use IEventService.createJobQueueProxy(URI, String).

Specified by:

getJobQueue in interface IEventService

Parameters:

queueName -

Returns:

the consumer for the given queue name

Throws:

EventException - thrown if no job queue exists for the given queue name.

createJmsQueueReader

public <U extends StatusBean> IJmsQueueReader<U> createJmsQueueReader(URI uri,
 String queueName)
                                                               throws EventException

Description copied from interface: IEventService

Create a Jms queue reader. This will read messages from the JMS (ActiveMq) queue with the given name and add it to the submission queue of the IJobQueue with the same name.

Specified by:

createJmsQueueReader in interface IEventService

Parameters:

uri -

queueName -

Returns:

the JMS queue reader

Throws:

EventException

createJobQueueProxy

public <U extends StatusBean> IJobQueue<U> createJobQueueProxy(URI uri,
 String submissionQueueName)
                                                        throws EventException

Description copied from interface: IEventService

Create a proxy for the IJobQueue for the given submission queue name, using the default command and command acknowledgement topics.

Specified by:

createJobQueueProxy in interface IEventService

Parameters:

uri -

submissionQueueName -

Returns:

a proxy to the job queue for the given queue name

Throws:

EventException

createJobQueueProxy

public <U extends StatusBean> IJobQueue<U> createJobQueueProxy(URI uri,
 String submissionQueueName,
 String commandTopicName,
 String commandAckTopicName)
                                                        throws EventException

Description copied from interface: IEventService

Create a proxy for the IJobQueue for the given submission queue. The given command topic and command acknowledgement topic names are used to communicate with the job queue.

Specified by:

createJobQueueProxy in interface IEventService

Parameters:

uri -

submissionQueueName -

commandTopicName -

commandAckTopicName -

Returns:

a proxy to the job queue for the given queue name

Throws:

EventException

disposeJobQueue

public void disposeJobQueue(String queueName)
                     throws EventException

Description copied from interface: IEventService

Disconnect the JMS resources used by the IJobQueue for the given submission queue name and unregisters it from this service.

Specified by:

disposeJobQueue in interface IEventService

Parameters:

queueName -

Throws:

EventException

disposeAllJobQueues

public void disposeAllJobQueues()
                         throws EventException

Description copied from interface: IEventService

Disconnect all JMS resources used by all IJobQueues and unregisters them from this service.

Specified by:

disposeAllJobQueues in interface IEventService

Throws:

EventException

createRequestor

public <T extends IdBean> IRequester<T> createRequestor(URI uri,
 String requestTopic,
 String responseTopic)
                                                 throws EventException

Description copied from interface: IEventService

A poster encapsulates sending and receiving a reply. For instance request a list of detectors on the server. This is the same as creating a broadcaster, sending an object then subscribing to the reply.

Specified by:

createRequestor in interface IEventService

Parameters:

uri -

requestTopic -

responseTopic -

Returns:

Throws:

EventException

createResponder

public <T extends IdBean> IResponder<T> createResponder(URI uri,
 String requestTopic,
 String responseTopic)
                                                 throws EventException

Description copied from interface: IEventService

Creates a responder on a given topic.

Specified by:

createResponder in interface IEventService

Parameters:

uri -

requestTopic -

responseTopic -

Returns:

Throws:

EventException

getEventConnectorService

public IEventConnectorService getEventConnectorService()

Description copied from interface: IEventService

The current event connector service that this event service is using to talk to messaging and to marshall objects.

Specified by:

getEventConnectorService in interface IEventService

Returns:

createRemoteService

public <T> T createRemoteService(URI uri,
 Class<T> serviceClass)
                          throws EventException

Description copied from interface: IEventService

Use this call to create a remote service. A wrapper will be created around the service such that methods called on the client will cause an event to trigger which has a response generated by the server. The event service caches remote services assuming that each service should exist once.

Specified by:

createRemoteService in interface IEventService

Parameters:

uri -

serviceClass -

Returns:

Throws:

EventException