Package org.eclipse.scanning.api.event.queue

Class QueueCommandBean<B extends StatusBean>

java.lang.Object

org.eclipse.scanning.api.event.IdBean

org.eclipse.scanning.api.event.queue.QueueCommandBean<B>

Type Parameters:

B - the type of status bean

All Implemented Interfaces:

Serializable

public class QueueCommandBean<B extends StatusBean>
extends IdBean

A QueueCommandBean can be used to control an IJobQueue. It can be sent to the IJobQueues command topic (as returned by IJobQueue.getCommandTopicName()). A proxy to the IJobQueue created by calling IEventService.createJobQueueProxy(java.net.URI, String) controls the real job queue on the server by sending QueueCommandBeans.

The action to be taken by the job queue is determined by the command, as set by calling setCommand(Command). The command available can by split into three categories:

• Some command, such as QueueCommandBean.Command.PAUSE_QUEUE and QueueCommandBean.Command.RESUME_QUEUE, affect the job queue's consumer thread;
• others, such as QueueCommandBean.Command.MOVE_FORWARD, QueueCommandBean.Command.MOVE_BACKWARD, QueueCommandBean.Command.REMOVE_FROM_QUEUE and QueueCommandBean.Command.CLEAR_QUEUE, affect the submission queue, most of these methods require the bean to be set;
• the remaining commands such as QueueCommandBean.Command.REMOVE_COMPLETED and affect the set of running and completed jobs (the status set)

The IJobQueue can be identified either by calling setJobQueueId(UUID) with the UUID of the job queue, or by calling setQueueName(String) with the name of the job queue's submission queue.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	QueueCommandBean.Command	An enumeration of the commands that an IJobQueue can perform.

Constructor Summary

Constructors

Constructor	Description
QueueCommandBean()
QueueCommandBean(String queueName, QueueCommandBean.Command command)
QueueCommandBean(String queueName, QueueCommandBean.Command command, B jobBean)
QueueCommandBean(String queueName, QueueCommandBean.Command command, String commandParam)
QueueCommandBean(UUID consumerId, QueueCommandBean.Command command)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
QueueCommandBean.Command	getCommand()
String	getErrorMessage()
B	getJobBean()
UUID	getJobQueueId()
String	getMessage()
String	getQueueName()
Object	getResult()
int	hashCode()
void	setCommand(QueueCommandBean.Command command)
void	setErrorMessage(String errorMessage)
void	setJobBean(B jobBean)
void	setJobQueueId(UUID consumerId)
void	setMessage(String message)
void	setQueueName(String queueName)
void	setResult(Object result)
String	toString()

Methods inherited from class org.eclipse.scanning.api.event.IdBean

getUniqueId, merge, setUniqueId

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

QueueCommandBean

public QueueCommandBean()

QueueCommandBean

public QueueCommandBean(UUID consumerId,
 QueueCommandBean.Command command)

QueueCommandBean

public QueueCommandBean(String queueName,
 QueueCommandBean.Command command)

QueueCommandBean

public QueueCommandBean(String queueName,
 QueueCommandBean.Command command,
 B jobBean)

QueueCommandBean

public QueueCommandBean(String queueName,
 QueueCommandBean.Command command,
 String commandParam)

Method Details

getJobQueueId

public UUID getJobQueueId()

setJobQueueId

public void setJobQueueId(UUID consumerId)

getMessage

public String getMessage()

setMessage

public void setMessage(String message)

getQueueName

public String getQueueName()

setQueueName

public void setQueueName(String queueName)

getCommand

public QueueCommandBean.Command getCommand()

setCommand

public void setCommand(QueueCommandBean.Command command)

getJobBean

public B getJobBean()

setJobBean

public void setJobBean(B jobBean)

getErrorMessage

public String getErrorMessage()

setErrorMessage

public void setErrorMessage(String errorMessage)

getResult

public Object getResult()

setResult

public void setResult(Object result)

hashCode

public int hashCode()

Overrides:

hashCode in class IdBean

equals

public boolean equals(Object obj)

Overrides:

equals in class IdBean

toString

public String toString()

Overrides:

toString in class Object