com.hpe.caf.worker.document.model

Interface ResponseQueue

All Superinterfaces:

DocumentWorkerObject

public interface ResponseQueue
extends DocumentWorkerObject

Used for managing the queue that response messages are published to.

The queue may or may not be enabled. If the queue is not enabled then response messages published to it will be discarded.

Method Summary

Modifier and Type	Method and Description
void	disable() Disables the response queue.
String	getName() Returns the name of the response queue.
Response	getResponse() Returns the response customization object that this response queue object is associated with.
boolean	isEnabled() Returns true if the response queue is enabled.
void	reset() Resets the response queue back to its original state, undoing any changes made to it using the disable() or set() methods.
void	set(String name) Sets the response queue.

Methods inherited from interface com.hpe.caf.worker.document.model.DocumentWorkerObject

getApplication

Method Detail

disable

void disable()

Disables the response queue. This causes response messages that would otherwise have been published to the queue to be discarded.

getName

@Nonnull
String getName()

Returns the name of the response queue. The isEnabled() call should be used before calling this method as it is only available if the queue is enabled. This method will throw a RuntimeException if the queue is not enabled.

Returns:

the name of the response queue

Throws:

RuntimeException - if the response queue is disabled

getResponse

@Nonnull
Response getResponse()

Returns the response customization object that this response queue object is associated with.

Returns:

the response customization object that this response queue object is associated with

isEnabled

boolean isEnabled()

Returns true if the response queue is enabled.

Returns:

true if the response queue is enabled

reset

void reset()

Resets the response queue back to its original state, undoing any changes made to it using the disable() or set() methods.

set

void set(String name)

Sets the response queue. If the specified response queue name is non-null then the queue will be enabled and the response queue name will be set. If the specified name is null then the response queue will be disabled. In this case the method is equivalent to calling the disable() method.

Parameters:

name - the name of the response queue, or null to disable the queue