Package org.eclipse.scanning.server.servlet

Class AbstractResponderServlet<B extends IdBean>

java.lang.Object

org.eclipse.scanning.server.servlet.AbstractResponderServlet<B>

Type Parameters:

T -

All Implemented Interfaces:

AutoCloseable, IConnection, IConnectable, IResponderServlet<B>

Direct Known Subclasses:

AcquireServlet, DeviceServlet, NodeInsertionRequestResponder, PositionerServlet

public abstract class AbstractResponderServlet<B extends IdBean>
extends Object
implements IResponderServlet<B>

Class used to register a servlet S

Field Summary

Fields

Modifier and Type	Field	Description
protected String	broker
protected IEventService	eventService
protected String	requestTopic
protected IResponder<B>	responder
protected String	responseTopic

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractResponderServlet()
protected	AbstractResponderServlet(String requestTopic, String responseTopic)
protected	AbstractResponderServlet(String requestTopic, String responseTopic, String broker)

Method Summary

Modifier and Type	Method	Description
void	connect()	Should called to start the servlet.
protected IResponseCreator<B>	createResponseCreator()	Override to change the behaviour of the IResponseCreator
void	disconnect()	Call to disconnect any resources which we no longer need.
String	getBroker()
String	getRequestTopic()
String	getResponseTopic()
boolean	isConnected()	Returns whether this connection is connected.
void	setBroker(String uri)
void	setRequestTopic(String requestTopic)
void	setResponseTopic(String responseTopic)
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.eclipse.scanning.api.event.core.IConnection

close

Methods inherited from interface org.eclipse.scanning.api.event.servlet.IResponderServlet

createResponder

Field Details

eventService

protected IEventService eventService

broker

protected String broker

requestTopic

protected String requestTopic

responseTopic

protected String responseTopic

responder

protected IResponder<B extends IdBean> responder

Constructor Details

AbstractResponderServlet

protected AbstractResponderServlet()

AbstractResponderServlet

protected AbstractResponderServlet(String requestTopic,
 String responseTopic)

AbstractResponderServlet

protected AbstractResponderServlet(String requestTopic,
 String responseTopic,
 String broker)

Method Details

connect

@PostConstruct
public void connect()
             throws EventException,
URISyntaxException

Description copied from interface: IConnectable

Should called to start the servlet.

Specified by:

connect in interface IConnectable

Throws:

EventException

URISyntaxException

createResponseCreator

protected IResponseCreator<B> createResponseCreator()

Override to change the behaviour of the IResponseCreator

Returns:

isConnected

public boolean isConnected()

Description copied from interface: IConnection

Returns whether this connection is connected. This method returns true until disconnect is called, even if the connection is created lazily.

Specified by:

isConnected in interface IConnection

Returns:

true if connected, false otherwise

disconnect

@PreDestroy
public void disconnect()
                throws EventException

Description copied from interface: IConnection

Call to disconnect any resources which we no longer need. The resource may have timed out so it might not be connected, in that case it silently returns. Note, that the method IConnection.close(), inherited from AutoCloseable calls this method, which means that if an object of a class implementing IConnection is used with a try-with-resources block this method will be called automatically when exiting that block.

Specified by:

disconnect in interface IConnection

Throws:

EventException - if resource could not be disconnected.

getBroker

public String getBroker()

setBroker

public void setBroker(String uri)

getRequestTopic

public String getRequestTopic()

setRequestTopic

public void setRequestTopic(String requestTopic)

getResponseTopic

public String getResponseTopic()

setResponseTopic

public void setResponseTopic(String responseTopic)

toString

public String toString()

Overrides:

toString in class Object