PoolingWorkflow (Base Interlok)

java.lang.Object
- com.adaptris.core.WorkflowImp
- - com.adaptris.core.PoolingWorkflow

All Implemented Interfaces:

AdaptrisComponent, AdaptrisMessageListener, ComponentLifecycle, ComponentLifecycleExtension, ConfigComment, EventHandlerAware, StateManagedComponent, Workflow
```
@ComponentProfile(summary="Workflow with a thread pool handling the service chain",
                  tag="workflow,base")
public class PoolingWorkflow
extends WorkflowImp
```
A Workflow that pools ServiceCollections.
Pooling of ServiceCollections is useful in situations where the services are considered the bottleneck for the throughput of messages (e.g. local FS to local FS, but with a slow JdbcService or WebServicesQueryService to extract data for lookups).

If you specify min-idle, max-idle and pool-size to be equal to each other then you will effectively end up with a fixed size pool of the size requested. There are some instances where a fixed size pool is desirable, such as when the service list that is being pooled takes a significant amount of time to become ready to use (e.g. multiple database connections/JMS connections over a WAN). By making a pool size fixed you only pay the cost of initialisation once when the workflow is first started. Of course, using a fixed size pool can cause its own problems if long-lived connections are terminated silently by the remote system. If you are using SharedConnection within the service-collection, then it is advised that you use a fixed size pool; otherwise as workers are deactivated then this could cause the underlying connection instance to be closed, which will cause issues for other objects sharing the connection.

If stop() is invoked then any messages that are currently being processed will be allowed to finish, however any new messages that enter the workflow via onAdaptrisMessage(AdaptrisMessage) before the AdaptrisMessageConsumer is succesfully stopped will be treated as bad messages and sent directly to the configured ProcessingExceptionHandler.

See Also:

ProcessingExceptionHandler

In the adapter configuration file this class is aliased as pooling-workflow which is the preferred alternative to the fully qualified classname when building your configuration.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`DEFAULT_MAX_IDLE` The default max idle size.
`static int`	`DEFAULT_MAX_POOLSIZE` The default maximum pool size.
`static int`	`DEFAULT_MIN_IDLE` the default minimum idle size.

Fields inherited from class com.adaptris.core.WorkflowImp
eventHandler, log, startTime, stopTime

Fields inherited from interface com.adaptris.core.Workflow
PREVIOUS_GUID_KEY, WORKFLOW_ID_KEY

Constructor Summary

Constructors
Constructor and Description

PoolingWorkflow()

PoolingWorkflow(java.lang.String uniqueId)

Constructors
Constructor and Description
`PoolingWorkflow()`
`PoolingWorkflow(java.lang.String uniqueId)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`closeWorkflow()` Close the workflow.
`int`	`currentlyActiveObjects()` Return the number of currently active objects.
`int`	`currentlyIdleObjects()` Return the number of currently idle objects.
`int`	`currentObjectPoolCount()` Return the total number of objects in the pool.
`int`	`currentThreadPoolCount()` Return the current number of active threads in the thread pool.
`void`	`doProduce(AdaptrisMessage msg)` This method contains the behaviour that varies between standard and request -reply workflows.
`TimeInterval`	`getInitWaitTime()`
`java.lang.Integer`	`getMaxIdle()` Return the maximum idle objects in the pool.
`java.lang.Integer`	`getMinIdle()` Return the minimum idle objects in the pool.
`java.lang.Integer`	`getPoolSize()` Get the size of the pool.
`TimeInterval`	`getShutdownWaitTime()`
`TimeInterval`	`getThreadKeepAlive()`
`java.lang.Integer`	`getThreadPriority()`
`void`	`handleBadMessage(AdaptrisMessage msg)` Handle a 'bad' message.
`protected void`	`handleBadMessage(java.lang.String logMsg, java.lang.Exception e, AdaptrisMessage msg)`
`void`	`handleProduceException()` Handle an `Exception` encountered producing a message.
`protected void`	`initialiseWorkflow()` Initialise the workflow.
`long`	`initWaitTimeMs()`
`int`	`maxIdle()` Return the maximum idle objects in the pool.
`int`	`minIdle()` Return the maximum idle objects in the pool.
`void`	`onAdaptrisMessage(AdaptrisMessage msg)` Process a message from the `MessageConsumer`
`int`	`poolSize()`
`protected void`	`prepareWorkflow()`
`protected void`	`resubmitMessage(AdaptrisMessage msg)` Resubmit a message upon the channel becoming available again.
`protected void`	`sendMessageLifecycleEvent(AdaptrisMessage msg)`
`void`	`setInitWaitTime(TimeInterval t)` Set the amount of time to wait for object pool population.
`void`	`setMaxIdle(java.lang.Integer i)` Set the maximum number of idle objects in the pool.
`void`	`setMinIdle(java.lang.Integer i)` Set the minimum number of idle objects in the pool.
`void`	`setPoolSize(java.lang.Integer i)` Set the size of the pool.
`void`	`setShutdownWaitTime(TimeInterval interval)` Set the shutdown wait timeout for the pool.
`void`	`setThreadKeepAlive(TimeInterval interval)` Set the lifetime for threads in the pool.
`void`	`setThreadPriority(java.lang.Integer i)`
`long`	`shutdownWaitTimeMs()`
`protected void`	`startWorkflow()` Start the workflow.
`protected void`	`stopWorkflow()` Stop the workflow.
`long`	`threadLifetimeMs()`
`int`	`threadPriority()`

Methods inherited from class com.adaptris.core.WorkflowImp
addConsumeLocation, addInterceptor, changeState, channelUnavailableWait, close, copyExceptionHeaders, disableMessageCount, friendlyName, getChannelUnavailableWaitInterval, getComments, getConsumer, getDisableDefaultMessageCount, getInterceptors, getLogPayload, getMessageErrorHandler, getMessageLogger, getProduceExceptionHandler, getProducer, getSendEvents, getServiceCollection, getUniqueId, handleChannelUnavailable, init, lastStartTime, lastStopTime, logSuccess, messageLogger, obtainChannel, obtainWorkflowId, prepare, processingStart, registerActiveMsgErrorHandler, registerChannel, registerEventHandler, requestClose, requestInit, requestStart, requestStop, retrieveActiveMsgErrorHandler, retrieveComponentState, setChannelUnavailableWaitInterval, setComments, setConsumer, setDisableDefaultMessageCount, setInterceptors, setLogPayload, setMessageErrorHandler, setMessageLogger, setProduceExceptionHandler, setProducer, setSendEvents, setServiceCollection, setUniqueId, start, stop, workflowEnd, workflowStart

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - DEFAULT_MAX_POOLSIZE
```
public static final int DEFAULT_MAX_POOLSIZE
```
    The default maximum pool size.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_MIN_IDLE
```
public static final int DEFAULT_MIN_IDLE
```
    the default minimum idle size.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_MAX_IDLE
```
public static final int DEFAULT_MAX_IDLE
```
    The default max idle size.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - PoolingWorkflow
```
public PoolingWorkflow()
```
  - PoolingWorkflow
```
public PoolingWorkflow(java.lang.String uniqueId)
                throws CoreException
```
    Throws:
    
    CoreException
- Method Detail
  - setPoolSize
```
public void setPoolSize(java.lang.Integer i)
```
    Set the size of the pool.
    
    Parameters:
    
    i - the size of the pool
  - getPoolSize
```
public java.lang.Integer getPoolSize()
```
    Get the size of the pool.
    
    Returns:
    
    the size.
    
    See Also:
    
    setPoolSize(Integer)
  - poolSize
```
public int poolSize()
```
  - threadLifetimeMs
```
public long threadLifetimeMs()
```
  - shutdownWaitTimeMs
```
public long shutdownWaitTimeMs()
```
  - getThreadKeepAlive
```
public TimeInterval getThreadKeepAlive()
```
  - setThreadKeepAlive
```
public void setThreadKeepAlive(TimeInterval interval)
```
    Set the lifetime for threads in the pool.
    Threads that have been dormant for the specified interval are discarded.
    
    Parameters:
    
    interval - the lifetime (default is 60 seconds)
  - getShutdownWaitTime
```
public TimeInterval getShutdownWaitTime()
```
  - setShutdownWaitTime
```
public void setShutdownWaitTime(TimeInterval interval)
```
    Set the shutdown wait timeout for the pool.
    When stop() is invoked, this causes a emptying and shutdown of the pool. The specified value is the amount of time to wait for a clean shutdown. If this timeout is exceeded then a forced shutdown ensues, which may mean messages are in an inconsistent state.
    
    Parameters:
    
    interval - the shutdown time (default is 60 seconds)
    
    See Also:
    
    WorkflowImp.stop()
  - initialiseWorkflow
```
protected void initialiseWorkflow()
                           throws CoreException
```
    Initialise the workflow.
    
    Specified by:
    
    initialiseWorkflow in class WorkflowImp
    
    Throws:
    
    CoreException - if the workflow failed to initialise. This exception encapsulates any underlying exception.
    
    See Also:
    
    WorkflowImp.initialiseWorkflow()
  - startWorkflow
```
protected void startWorkflow()
                      throws CoreException
```
    Description copied from class: WorkflowImp
    
    Start the workflow.
    
    Specified by:
    
    startWorkflow in class WorkflowImp
    
    Throws:
    
    CoreException - encapsulating any underlying Exception
    
    See Also:
    
    WorkflowImp.startWorkflow()
  - closeWorkflow
```
protected void closeWorkflow()
```
    Description copied from class: WorkflowImp
    
    Close the workflow.
    
    Specified by:
    
    closeWorkflow in class WorkflowImp
    
    See Also:
    
    WorkflowImp.closeWorkflow()
  - stopWorkflow
```
protected void stopWorkflow()
```
    Description copied from class: WorkflowImp
    
    Stop the workflow.
    
    Specified by:
    
    stopWorkflow in class WorkflowImp
    
    See Also:
    
    WorkflowImp.stopWorkflow()
  - onAdaptrisMessage
```
public void onAdaptrisMessage(AdaptrisMessage msg)
```
    Process a message from the MessageConsumer
    If stop() is invoked then any messages that are currently being processed will be allowed to finish, however any new messages that enter the workflow via onAdaptrisMessage(AdaptrisMessage) will be treated as BAD messages and sent directly to the configured MessageErrorHandler.
    
    Parameters:
    
    msg - the AdaptrisMessage.
    
    See Also:
    
    AdaptrisMessageListener.onAdaptrisMessage(AdaptrisMessage), WorkflowImp.handleBadMessage(AdaptrisMessage)
  - resubmitMessage
```
protected void resubmitMessage(AdaptrisMessage msg)
```
    Description copied from class: WorkflowImp
    
    Resubmit a message upon the channel becoming available again.
    
    Specified by:
    
    resubmitMessage in class WorkflowImp
    
    Parameters:
    
    msg - the AdaptrisMessage.
    
    See Also:
    
    WorkflowImp.resubmitMessage(com.adaptris.core.AdaptrisMessage)
  - handleBadMessage
```
public void handleBadMessage(AdaptrisMessage msg)
```
    Description copied from interface: Workflow
    
    Handle a 'bad' message. A bad message is one which has caused an Exception in the ServceCollection or AdaptrisMessageProducer.
    
    Specified by:
    
    handleBadMessage in interface Workflow
    
    Overrides:
    
    handleBadMessage in class WorkflowImp
    
    Parameters:
    
    msg - the original version of the 'bad' message
    
    See Also:
    
    WorkflowImp.handleBadMessage(AdaptrisMessage)
  - handleBadMessage
```
protected void handleBadMessage(java.lang.String logMsg,
                                java.lang.Exception e,
                                AdaptrisMessage msg)
```
    Overrides:
    
    handleBadMessage in class WorkflowImp
  - doProduce
```
public void doProduce(AdaptrisMessage msg)
               throws ServiceException,
                      ProduceException
```
    Description copied from class: WorkflowImp
    
    This method contains the behaviour that varies between standard and request -reply workflows. It is overridden in RequestReplyWorkflow.
    
    Specified by:
    
    doProduce in interface Workflow
    
    Overrides:
    
    doProduce in class WorkflowImp
    
    Parameters:
    
    msg - the message to process
    
    Throws:
    
    ServiceException - not thrown by this implementation
    
    ProduceException - if any occur
    
    See Also:
    
    WorkflowImp.doProduce(com.adaptris.core.AdaptrisMessage)
  - handleProduceException
```
public void handleProduceException()
```
    Description copied from interface: Workflow
    
    Handle an Exception encountered producing a message.
    
    Specified by:
    
    handleProduceException in interface Workflow
    
    Overrides:
    
    handleProduceException in class WorkflowImp
    
    See Also:
    
    WorkflowImp.handleProduceException()
  - sendMessageLifecycleEvent
```
protected void sendMessageLifecycleEvent(AdaptrisMessage msg)
```
    Overrides:
    
    sendMessageLifecycleEvent in class WorkflowImp
    
    See Also:
    
    WorkflowImp.sendMessageLifecycleEvent(AdaptrisMessage)
  - getThreadPriority
```
public java.lang.Integer getThreadPriority()
```
  - setThreadPriority
```
public void setThreadPriority(java.lang.Integer i)
```
  - getMinIdle
```
public java.lang.Integer getMinIdle()
```
    Return the minimum idle objects in the pool.
    
    Returns:
    
    the minimum idle number
  - setMinIdle
```
public void setMinIdle(java.lang.Integer i)
```
    Set the minimum number of idle objects in the pool.
    
    Parameters:
    
    i - the minIdle to set
  - minIdle
```
public int minIdle()
```
    Return the maximum idle objects in the pool.
    
    Returns:
    
    the maximum idle number
  - getMaxIdle
```
public java.lang.Integer getMaxIdle()
```
    Return the maximum idle objects in the pool.
    
    Returns:
    
    the maximum idle number
  - setMaxIdle
```
public void setMaxIdle(java.lang.Integer i)
```
    Set the maximum number of idle objects in the pool.
    
    Parameters:
    
    i - the maxIdle to set (default 10)
  - maxIdle
```
public int maxIdle()
```
    Return the maximum idle objects in the pool.
    
    Returns:
    
    the maximum idle number
  - threadPriority
```
public int threadPriority()
```
  - getInitWaitTime
```
public TimeInterval getInitWaitTime()
```
    Returns:
    
    the initWaitTime
  - setInitWaitTime
```
public void setInitWaitTime(TimeInterval t)
```
    Set the amount of time to wait for object pool population.
    Upon start the object pool is populated with the minIdle() number of workers.
    
    Parameters:
    
    t - the initWaitTime to set, default if not specified is 1 minute
  - initWaitTimeMs
```
public long initWaitTimeMs()
```
  - currentObjectPoolCount
```
public int currentObjectPoolCount()
```
    Return the total number of objects in the pool. This includes active and idle objects.
    
    Returns:
    
    the total number of objects in the pool.
  - currentlyActiveObjects
```
public int currentlyActiveObjects()
```
    Return the number of currently active objects. These are objects that may or may not be currently be processing messages but have been borrowed from the pool.
    
    Returns:
    
    the currently active objects.
  - currentlyIdleObjects
```
public int currentlyIdleObjects()
```
    Return the number of currently idle objects. These are objects that are currently in the pool awaiting work.
    
    Returns:
    
    the number of idle objects.
  - currentThreadPoolCount
```
public int currentThreadPoolCount()
```
    Return the current number of active threads in the thread pool. This number is just a snaphot, and may change immediately upon returning
    
    Returns:
    
    the number of threads in the threadpool.
  - prepareWorkflow
```
protected void prepareWorkflow()
                        throws CoreException
```
    Specified by:
    
    prepareWorkflow in class WorkflowImp
    
    Throws:
    
    CoreException

Class PoolingWorkflow

Field Summary

Fields inherited from class com.adaptris.core.WorkflowImp

Fields inherited from interface com.adaptris.core.Workflow

Constructor Summary

Method Summary

Methods inherited from class com.adaptris.core.WorkflowImp

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_MAX_POOLSIZE

DEFAULT_MIN_IDLE

DEFAULT_MAX_IDLE

Constructor Detail

PoolingWorkflow

PoolingWorkflow

Method Detail

setPoolSize

getPoolSize

poolSize

threadLifetimeMs

shutdownWaitTimeMs

getThreadKeepAlive

setThreadKeepAlive

getShutdownWaitTime

setShutdownWaitTime

initialiseWorkflow

startWorkflow

closeWorkflow

stopWorkflow

onAdaptrisMessage

resubmitMessage

handleBadMessage

handleBadMessage

doProduce

handleProduceException

sendMessageLifecycleEvent

getThreadPriority

setThreadPriority

getMinIdle

setMinIdle

minIdle

getMaxIdle

setMaxIdle

maxIdle

threadPriority

getInitWaitTime

setInitWaitTime

initWaitTimeMs

currentObjectPoolCount

currentlyActiveObjects

currentlyIdleObjects

currentThreadPoolCount

prepareWorkflow