com.wm.app.b2b.server.dispatcher.trigger

Class TriggerFacade

java.lang.Object

com.wm.app.b2b.server.dispatcher.trigger.TriggerFacade

public final class TriggerFacade
extends java.lang.Object

Provides a collection of methods that can be used to suspend and resume document retrieval or document processing for an individual trigger. The class also contains methods that can be used to view and modify trigger properties. A TriggerFacade object represents an individual trigger on the Integration Server.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	TriggerFacade.TriggerRunTimeStatus Provides read access to the trigger's run-time information, including current thread usage, retrieval state, and document processing state.
class	TriggerFacade.TriggerThrottleValues Provides read access to the trigger's throttled (adjusted) values for trigger queue capacity, trigger queue refill level, and maximum execution threads

Constructor Summary

Constructors

Constructor and Description
TriggerFacade(java.lang.String triggerName) Initializes a TriggerFacade object that represents an individual trigger on the Integration Server.

Method Summary

Modifier and Type	Method and Description
ICondition[]	getConditions() Returns the conditions specified in this trigger.
long	getJoinTimeout() Returns the join condition time out value (in milliseconds) for this trigger.
int	getMaxConcurrentThreads() Returns the maximum number of server threads that can process documents for this trigger at one time.
int	getMaxDeliveryAttempts() Returns the maximum number of times the trigger service is executed if the previous execution ended because of an ISRuntimeException.
int	getMaxDocsPrefetch() Returns the configured queue capacity for this trigger.
int	getMinDocsPrefetch() Returns the trigger queue refill level for this trigger.
long	getRedeliveryDelay() Returns the number of milliseconds between attempts to execute a trigger service.
long	getResolutionHistoryTTL() Returns the number of milliseconds that the document history database maintains a record for a document processed by this trigger.
int	getTransportAckSize() Returns the maximum size of the acknowledgment queue for this trigger.
java.lang.String	getTriggerName() Returns the name of the trigger.
TriggerFacade.TriggerRunTimeStatus	getTriggerRunTimeStatus() Returns run-time information for the trigger, including thread usage, retrieval state, document processing state, and the trigger queue level.
TriggerFacade.TriggerThrottleValues	getTriggerThrottleValues() Returns the current queue capacity and number of concurrent execution threads for this trigger as determined by the global Queue Capacity Throttle and the Execution Threads throttle.
boolean	isConcurrent() Returns a boolean indicating whether the processing mode for this trigger is set to concurrent or serial.
boolean	isExecuteEnabled() Returns a boolean indicating whether the trigger is enabled.
boolean	isInDoubtDetection() Returns a boolean indicating whether duplicate detection is provided for guaranteed documents received by this trigger.
boolean	isNodeLocked() Returns a boolean indicating whether this trigger is locked.
boolean	isResolveWithHistory() Returns a boolean indicating whether document history is used to determine whether a document is a duplicate of one already processed by the trigger.
boolean	isSerialSuspendOnError() Returns a boolean indicating whether document retrieval and document processing will be suspended for this trigger if the associated trigger service ends in error.
void	setProcessingSuspended(boolean suspendFlag, boolean persistFlag) Suspends or resumes document processing for this trigger.
void	setRetrievalSuspended(boolean suspendFlag, boolean persistFlag) Suspends or resumes document retrieval for this trigger.
void	setRunTimeProperties(java.lang.String queueCapacity, java.lang.String queueRefillLevel, java.lang.String maxExecutionThreads) Edit the run-time properties of the trigger.

Methods inherited from class java.lang.Object

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

Constructor Detail

TriggerFacade

public TriggerFacade(java.lang.String triggerName)
              throws ServiceException

Initializes a TriggerFacade object that represents an individual trigger on the Integration Server.

Parameters:

triggerName - the String representing the fully qualified name of the trigger.

Throws:

ServiceException

Method Detail

getTriggerName

public java.lang.String getTriggerName()

Returns the name of the trigger.

Returns:

the name of the trigger

getTriggerRunTimeStatus

public TriggerFacade.TriggerRunTimeStatus getTriggerRunTimeStatus()
                                                           throws ServiceException

Returns run-time information for the trigger, including thread usage, retrieval state, document processing state, and the trigger queue level.

Returns:

the TriggerRunTimeStatus object associated with this trigger

Throws:

ServiceException - Among the possible causes, if the method is run against a trigger that has been created, but is not yet configured.

getTriggerThrottleValues

public TriggerFacade.TriggerThrottleValues getTriggerThrottleValues()

Returns the current queue capacity and number of concurrent execution threads for this trigger as determined by the global Queue Capacity Throttle and the Execution Threads throttle.

Returns:

the TriggerThrottleValues object associated with this trigger

getConditions

public ICondition[] getConditions()

Returns the conditions specified in this trigger.

Returns:

an array of ICondition objects that are associated with this trigger. ICondition contains information about the conditions for a trigger such as subscribed document types and service name

getMaxDocsPrefetch

public int getMaxDocsPrefetch()

Returns the configured queue capacity for this trigger.

Returns:

int The maximum number of unprocessed documents that can exist in the trigger queue.

getMinDocsPrefetch

public int getMinDocsPrefetch()

Returns the trigger queue refill level for this trigger.

Returns:

The number of unprocessed documents that must remain in this trigger queue before the Integration Server will retrieve more documents for this trigger.

getTransportAckSize

public int getTransportAckSize()

Returns the maximum size of the acknowledgment queue for this trigger.

Returns:

The maximum number of pending document acknowledgements that can exist for this trigger. A server thread places acknowledgements in the acknowledgement queue after it finishes executing the trigger service. Acknowledgements collect in the queue until the server returns them as a group to the sending resource

getMaxConcurrentThreads

public int getMaxConcurrentThreads()

Returns the maximum number of server threads that can process documents for this trigger at one time.

Returns:

The maximum number of server threads that can process documents for this trigger concurrently. The Integration Server uses one server thread to process each document in the trigger queue. Serial triggers can process a maximum of one document at a time.

getJoinTimeout

public long getJoinTimeout()

Returns the join condition time out value (in milliseconds) for this trigger.

Returns:

The number of milliseconds that the Integration Server waits for the remaining documents in a join condition.A value of -1 indicates that the join does not expire.

getResolutionHistoryTTL

public long getResolutionHistoryTTL()

Returns the number of milliseconds that the document history database maintains a record for a document processed by this trigger. Note that this method returns a value even if the trigger does not use document history for duplicate detection.

Returns:

The number of milliseconds that a document history is maintained for a document processed by this trigger. During this time period, the Integration Server discards any documents with the same universally unique identifier (UUID) as an existing document history entry for this trigger. When a document history entry expires, the Integration Server removes it.

getMaxDeliveryAttempts

public int getMaxDeliveryAttempts()

Returns the maximum number of times the trigger service is executed if the previous execution ended because of an ISRuntimeException.

Returns:

The maximum number of times the Integration Server attempts to reprocess a document by re-executing the trigger service. A value of -1 indicates that the trigger service retries until it is successful. A value of 0 indicates that the trigger service is not configured to retry.

getRedeliveryDelay

public long getRedeliveryDelay()

Returns the number of milliseconds between attempts to execute a trigger service.

Returns:

The number of milliseconds that the Integration Server waits between attempts to re-execute a trigger service if the trigger service ended because of an ISRuntimeException.

isInDoubtDetection

public boolean isInDoubtDetection()

Returns a boolean indicating whether duplicate detection is provided for guaranteed documents received by this trigger. Duplicate detection prevents the same document from being processed twice by determining whether a document is a copy of one previously processed by the trigger. True indicates that duplicate detection is provided; false indicates that duplicate detection is not performed. Duplicate detection can be provided for guaranteed documents only.

Returns:

true if duplicate detection is enabled for this trigger; false if duplicate detection is not enabled

isResolveWithHistory

public boolean isResolveWithHistory()

Returns a boolean indicating whether document history is used to determine whether a document is a duplicate of one already processed by the trigger. True indicates document history is used; false indicates that document history is not used

Returns:

true if document history is used; false if document history is not used

isConcurrent

public boolean isConcurrent()

Returns a boolean indicating whether the processing mode for this trigger is set to concurrent or serial. Concurrent processing mode indicates that multiple documents received by this trigger can be processed at the same time. Serial indicates that documents received by this trigger are processed one at a time in the same order in which they were received.

Returns:

true if concurrent; false if serial

isExecuteEnabled

public boolean isExecuteEnabled()

Returns a boolean indicating whether the trigger is enabled. True indicates the trigger is enabled; false indicates the trigger is disabled. Note that you can change properties, the retrieval state, or the document processing state for enabled triggers only.

Returns:

true if enabled; false if disabled

isSerialSuspendOnError

public boolean isSerialSuspendOnError()

Returns a boolean indicating whether document retrieval and document processing will be suspended for this trigger if the associated trigger service ends in error. The Integration Server will suspend on error only after all retries have been exhausted or a service exception occurs. True indicates that document processing and retrieval are suspended on error; false indicates that document processing and retrieval are not suspended on error. Only triggers with a serial processing mode can be configured to suspend on error.

Returns:

true if configured to suspend on error; otherwise, false

isNodeLocked

public boolean isNodeLocked()

Returns a boolean indicating whether this trigger is locked.

Returns:

true if trigger is locked; false if unlocked

setProcessingSuspended

public void setProcessingSuspended(boolean suspendFlag,
                                   boolean persistFlag)
                            throws ServiceException

Suspends or resumes document processing for this trigger.

When you suspend document processing, the Integration Server will not dispatch any more server threads to process documents in the trigger queue. Any server threads currently processing documents for the trigger will execute to completion. This includes documents that are being retried.

This method affects all documents in this trigger queue on the Integration Server, including documents retrieved from the Broker and from local publishing.

The Integration Server will not suspend or resume document processing for this trigger if it is locked.

Parameters:

suspendFlag - A boolean indicating whether document processing should be suspended or resumed for this trigger. Use true to suspend; false to resume.

persistFlag - A boolean indicating whether the document processing change for this trigger should be permanent or temporary. Use true to save the change; false to indicate that the change is temporary.

Throws:

ServiceException - Can occur for many reasons, two of which are: when the trigger is locked; or the trigger has been created, but has not yet been configured. Note that no exception will be thrown if document processing for the trigger is already suspended.

setRetrievalSuspended

public void setRetrievalSuspended(boolean suspendFlag,
                                  boolean persistFlag)
                           throws ServiceException

Suspends or resumes document retrieval for this trigger.

This method does not affect document retrieval for locally published documents.

The Integration Server will not suspend or resume document processing for the trigger if it is locked.

When you suspend document retrieval, the trigger will continue to receive documents delivered to the default client.

When you suspend document retrieval, Integration Server will not dispatch any server threads to retrieve documents from the messaging provider (Broker or Univesal Messaging) for the trigger. Any server threads currently retrieving documents for the trigger will execute to completion.

Parameters:

suspendFlag - A boolean indicating whether document retrieval should be suspended or resumed for this trigger. Use true to suspend; false to resume.

persistFlag - A boolean indicating whether the document processing change for this trigger should be permanent or temporary. Use true to save the change; false to indicate that the change is temporary.

Throws:

ServiceException - Can occur for many reasons, two of which are: when the trigger is locked; or the trigger has been created, but has not yet been configured.Note that no exception will be thrown if document retrieval for the trigger is already suspended.

setRunTimeProperties

public void setRunTimeProperties(java.lang.String queueCapacity,
                                 java.lang.String queueRefillLevel,
                                 java.lang.String maxExecutionThreads)
                          throws ServiceException

Edit the run-time properties of the trigger. Note that these changes are always persisted across server restarts and package reloads.

Parameters:

queueCapacity - A String specifying the maximum number of documents that the Integration Server can store in this trigger queue.

queueRefillLevel - A String specifying the number of unprocessed documents that must remain in this trigger queue before the server retrieves more documents for this trigger from the Broker.

maxExecutionThreads - A String specifying the maximum number of threads that can process documents for this trigger concurrently.

Throws:

ServiceException - Can occur for many reasons, two of which are: when the trigger is locked; or the trigger has been created, but has not yet been configured.