Package org.eclipse.scanning.server.servlet

Class ScanServlet

java.lang.Object

org.eclipse.scanning.server.servlet.AbstractJobQueueServlet<ScanBean>

org.eclipse.scanning.server.servlet.ScanServlet

All Implemented Interfaces:

AutoCloseable, IConnection, IConnectable, IJobQueueServlet<ScanBean>

public class ScanServlet
extends AbstractJobQueueServlet<ScanBean>

A servlet to do any scan type based on the information provided in a ScanBean.

See Also:

• invalid reference

  Spring config started, for instance:
      
  
      <bean id="scanServlet" class="org.eclipse.scanning.server.servlet.ScanServlet" init-method="connect">
         <property name="broker"      value="tcp://p45-control:61616" />
         <property name="submitQueue" value="uk.ac.diamond.p45.submitQueue" />
         <property name="statusTopic" value="uk.ac.diamond.p45.statusTopic" />
         <property name="durable"     value="true" />
      </bean>
  
      
  
      FIXME Add security via activemq layer. Anyone can run this now.

Field Summary

Fields inherited from class org.eclipse.scanning.server.servlet.AbstractJobQueueServlet

broker, commandAckTopic, commandTopic, eventService, jobQueue, queueStatusTopic, statusTopic, submitQueue

Constructor Summary

Constructors

Constructor	Description
ScanServlet()
ScanServlet(boolean forTest)	Utility constructor for test classes only- this forces the MVStore for JobQueueImpl (which uses scanServlet.getSubmitQueue()) to be unique per JVM, ensuring that multiple sets of running tests do not collide on trying to access their MVStores.

Method Summary

Modifier and Type	Method	Description
ScanProcess	createProcess(ScanBean scanBean, IPublisher<ScanBean> response)	Creates a process for each request processed from the queue for this servlet.
String	getName()

Methods inherited from class org.eclipse.scanning.server.servlet.AbstractJobQueueServlet

connect, disconnect, getBroker, getCommandAckTopic, getCommandTopic, getJobQueue, getQueueStatusTopic, getStatusTopic, getSubmitQueue, isBlocking, isConnected, isPauseOnStart, isPurgeQueue, setBlocking, setBroker, setCommandTopic, setConsumer, setPauseOnStart, setPurgeQueue, setQueueStatusTopic, setStatusTopic, setSubmitQueue

Methods inherited from class java.lang.Object

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

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

close

Constructor Details

ScanServlet

public ScanServlet()

ScanServlet

public ScanServlet(boolean forTest)

Utility constructor for test classes only- this forces the MVStore for JobQueueImpl (which uses scanServlet.getSubmitQueue()) to be unique per JVM, ensuring that multiple sets of running tests do not collide on trying to access their MVStores. The creation of submission queues and of their submitters both use getSubmitQueue so parity is conserved. Special care should be taken by any test using this method to clean up any MVStore files that are produced. See ScanningTestUtil.clearStore()

Parameters:

forTest -

Method Details

getName

public String getName()

Specified by:

getName in class AbstractJobQueueServlet<ScanBean>

createProcess

public ScanProcess createProcess(ScanBean scanBean,
 IPublisher<ScanBean> response)
                          throws EventException

Description copied from interface: IJobQueueServlet

Creates a process for each request processed from the queue for this servlet.

Parameters:

scanBean -

response -

Returns:

Throws:

EventException