com.adaptris.core.runtime

Class WorkflowManager

java.lang.Object

javax.management.NotificationBroadcasterSupport

com.adaptris.core.runtime.ComponentManagerImpl<Workflow>

com.adaptris.core.runtime.WorkflowManager

All Implemented Interfaces:

AdapterComponentMBean, AdapterRuntimeComponent<Workflow>, BaseComponentMBean, ChildComponent<ChannelManager>, ChildComponentMBean, HierarchicalMBean, ParentRuntimeInfoComponent, ParentRuntimeInfoComponentMBean, RuntimeInfoComponent, WorkflowManagerMBean, WorkflowRuntimeManager, MessageProcessor, javax.management.NotificationBroadcaster, javax.management.NotificationEmitter

public class WorkflowManager
extends ComponentManagerImpl<Workflow>
implements WorkflowManagerMBean, WorkflowRuntimeManager

Base implementation of WorkflowManagerMBean.

Nested Class Summary

Nested classes/interfaces inherited from class com.adaptris.core.runtime.ComponentManagerImpl

ComponentManagerImpl.ComponentNotificationType

Field Summary

Fields inherited from class com.adaptris.core.runtime.ComponentManagerImpl

log

Fields inherited from interface com.adaptris.core.runtime.AdapterComponentMBean

ADAPTER_PREFIX, CHANNEL_PREFIX, EQUALS, ID_PREFIX, JMX_ADAPTER_TYPE, JMX_CHANNEL_TYPE, JMX_CONSUMER_MONITOR_TYPE, JMX_DOMAIN_NAME, JMX_FAILED_MESSAGE_RETRIER_TYPE, JMX_FS_MONITOR_TYPE, JMX_INFLIGHT_TYPE, JMX_LOG_HANDLER_TYPE, JMX_METRICS_TYPE, JMX_MSG_ERR_DIGESTER_TYPE, JMX_NOTIFIER_TYPE, JMX_RETRY_MONITOR_TYPE, JMX_WORKFLOW_TYPE, KEY_ADAPTER, KEY_CHANNEL, KEY_ID, KEY_WORKFLOW, NOTIF_MSG_CLOSED, NOTIF_MSG_CONFIG_UPDATED, NOTIF_MSG_INITIALISED, NOTIF_MSG_RESTARTED, NOTIF_MSG_STARTED, NOTIF_MSG_STOPPED, NOTIF_TYPE_ADAPTER_CONFIG, NOTIF_TYPE_ADAPTER_LIFECYCLE, NOTIF_TYPE_CHANNEL_CONFIG, NOTIF_TYPE_CHANNEL_LIFECYCLE, NOTIF_TYPE_WORKFLOW_CONFIG, NOTIF_TYPE_WORKFLOW_LIFECYCLE, PROPERTY_SEPARATOR, WORKFLOW_PREFIX

Constructor Summary

Constructors

Constructor and Description
WorkflowManager(Workflow w, ChannelManager owner)

Method Summary

Modifier and Type	Method and Description
boolean	addChildJmxComponent(ChildRuntimeInfoComponent comp)
protected void	checkTransitionTo(ComponentState futureState) Check whether the transition is allowed in the context of the current component's (or parent's) state.
java.lang.String	createObjectHierarchyString() Create an ObjectName key/value pair hierarchy.
javax.management.ObjectName	createObjectName() Create the object name representation of the mbean.
boolean	equals(java.lang.Object o) Equality is based on the underlying ObjectName.
java.util.Collection<BaseComponentMBean>	getAllDescendants() Get all the descendants of this ParentComponent implementation.
java.util.Collection<javax.management.ObjectName>	getChildRuntimeInfoComponents()
javax.management.MBeanNotificationInfo[]	getNotificationInfo()
protected java.lang.String	getNotificationType(ComponentManagerImpl.ComponentNotificationType type)
ChannelManager	getParent() Get our direct parent component.
java.lang.String	getParentId() Get the parent's uniqueid.
javax.management.ObjectName	getParentObjectName() Get the parents ObjectName representation.
Workflow	getWrappedComponent() Get the component that this implementation manages.
int	hashCode()
boolean	injectMessage(SerializableAdaptrisMessage msgToProcess) Deprecated.
SerializableAdaptrisMessage	injectMessageWithReply(SerializableAdaptrisMessage msgToProcess) Deprecated.
SerializableMessage	process(SerializableMessage msgToProcess)
void	processAsync(SerializableMessage msgToProcess)
void	registerMBean() Register this component (and all children) against the default Platform MBeanServer.
boolean	removeChildJmxComponent(ChildRuntimeInfoComponent comp)
long	requestStartTime() Returns timestamp of the last start time for this component
long	requestStopTime() Returns timestamp of the last stop time for this component
java.lang.String	toString()
void	unregisterMBean() Unregister this component (and all children) from the default Platform MBeanServer.

Methods inherited from class com.adaptris.core.runtime.ComponentManagerImpl

asXml, closeQuietly, createLifecycleNotification, ensureState, getComponentState, getConfiguration, getUniqueId, getWrappedComponentClassname, marshalAndSendNotification, marshalConfig, registerSelf, requestClose, requestClose, requestInit, requestInit, requestRestart, requestRestart, requestStart, requestStart, requestStop, requestStop, sendConfigUpdateNotification, unregisterSelf

Methods inherited from class javax.management.NotificationBroadcasterSupport

addNotificationListener, handleNotification, removeNotificationListener, removeNotificationListener, sendNotification

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.adaptris.core.runtime.AdapterRuntimeComponent

getWrappedComponentClassname

Methods inherited from interface com.adaptris.core.runtime.AdapterComponentMBean

getComponentState, getConfiguration, getUniqueId, requestClose, requestClose, requestInit, requestInit, requestRestart, requestRestart, requestStart, requestStart, requestStop, requestStop

Constructor Detail

WorkflowManager

public WorkflowManager(Workflow w,
                       ChannelManager owner)
                throws javax.management.MalformedObjectNameException,
                       CoreException

Throws:

javax.management.MalformedObjectNameException

CoreException

Method Detail

createObjectName

public javax.management.ObjectName createObjectName()
                                             throws javax.management.MalformedObjectNameException

Description copied from interface: BaseComponentMBean

Create the object name representation of the mbean.

Specified by:

createObjectName in interface BaseComponentMBean

Returns:

the object name.

Throws:

javax.management.MalformedObjectNameException - on exception.

getWrappedComponent

public Workflow getWrappedComponent()

Description copied from interface: AdapterRuntimeComponent

Get the component that this implementation manages.

Specified by:

getWrappedComponent in interface AdapterRuntimeComponent<Workflow>

Returns:

my component.

requestStartTime

public long requestStartTime()

Description copied from interface: AdapterComponentMBean

Returns timestamp of the last start time for this component

Specified by:

requestStartTime in interface AdapterComponentMBean

Returns:

the last start time, or 0 if the component has never been started.

requestStopTime

public long requestStopTime()

Description copied from interface: AdapterComponentMBean

Returns timestamp of the last stop time for this component

Specified by:

requestStopTime in interface AdapterComponentMBean

Returns:

the last stop time; generally speaking this will be the time when the component was "created" if an explicit stop has never been requested.

injectMessageWithReply

@Deprecated
public SerializableAdaptrisMessage injectMessageWithReply(SerializableAdaptrisMessage msgToProcess)
                                                               throws CoreException

Deprecated.

Description copied from interface: WorkflowManagerMBean

Allows you to inject a serialised message into a workflow.

Specified by:

injectMessageWithReply in interface WorkflowManagerMBean

Parameters:

msgToProcess - an adaptris message

Returns:

the contents of the message after processing from the workflow.

Throws:

CoreException - wrapping any underlying Exception

injectMessage

@Deprecated
public boolean injectMessage(SerializableAdaptrisMessage msgToProcess)
                                  throws CoreException

Deprecated.

Description copied from interface: WorkflowManagerMBean

Allows you to inject a serialised message into a workflow.

Specified by:

injectMessage in interface WorkflowManagerMBean

Parameters:

msgToProcess - an adaptris message

Returns:

true - if the message cold be handed to the workflow

Throws:

CoreException - wrapping any underlying Exception

processAsync

public void processAsync(SerializableMessage msgToProcess)
                  throws InterlokException

Specified by:

processAsync in interface MessageProcessor

Throws:

InterlokException

process

public SerializableMessage process(SerializableMessage msgToProcess)
                            throws InterlokException

Specified by:

process in interface MessageProcessor

Throws:

InterlokException

equals

public boolean equals(java.lang.Object o)

Equality is based on the underlying ObjectName.

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

checkTransitionTo

protected void checkTransitionTo(ComponentState futureState)
                          throws CoreException

Description copied from class: ComponentManagerImpl

Check whether the transition is allowed in the context of the current component's (or parent's) state.

Specified by:

checkTransitionTo in class ComponentManagerImpl<Workflow>

Parameters:

futureState - the state we want to transition to.

Throws:

CoreException - if the state transition check fails.

getParent

public ChannelManager getParent()

Description copied from interface: ChildComponent

Get our direct parent component.

Specified by:

getParent in interface ChildComponent<ChannelManager>

Returns:

our parent.

getParentId

public java.lang.String getParentId()

Description copied from interface: ChildComponentMBean

Get the parent's uniqueid.

Specified by:

getParentId in interface ChildComponentMBean

Returns:

the uniqueid of the parent (e.g. workflows will return the parent channel-id, and channels the adapter-id).

getParentObjectName

public javax.management.ObjectName getParentObjectName()
                                                throws javax.management.MalformedObjectNameException

Description copied from interface: ChildComponentMBean

Get the parents ObjectName representation.

Specified by:

getParentObjectName in interface ChildComponentMBean

Returns:

the Objectname that represents the parent management bean.

Throws:

javax.management.MalformedObjectNameException

getChildRuntimeInfoComponents

public java.util.Collection<javax.management.ObjectName> getChildRuntimeInfoComponents()
                                                                                throws javax.management.MalformedObjectNameException

Specified by:

getChildRuntimeInfoComponents in interface ParentRuntimeInfoComponentMBean

Throws:

javax.management.MalformedObjectNameException

addChildJmxComponent

public boolean addChildJmxComponent(ChildRuntimeInfoComponent comp)

Specified by:

addChildJmxComponent in interface ParentRuntimeInfoComponent

removeChildJmxComponent

public boolean removeChildJmxComponent(ChildRuntimeInfoComponent comp)

Specified by:

removeChildJmxComponent in interface ParentRuntimeInfoComponent

createObjectHierarchyString

public java.lang.String createObjectHierarchyString()

Description copied from interface: HierarchicalMBean

Create an ObjectName key/value pair hierarchy.

Specified by:

createObjectHierarchyString in interface HierarchicalMBean

Returns:

a hierarchy based on the tree.

getAllDescendants

public java.util.Collection<BaseComponentMBean> getAllDescendants()

Description copied from interface: AdapterRuntimeComponent

Get all the descendants of this ParentComponent implementation.

Specified by:

getAllDescendants in interface AdapterRuntimeComponent<Workflow>

Returns:

all the children, and children's children, etc...

registerMBean

public void registerMBean()
                   throws CoreException

Description copied from interface: BaseComponentMBean

Register this component (and all children) against the default Platform MBeanServer.

Specified by:

registerMBean in interface BaseComponentMBean

Throws:

CoreException - wrapping any exception

See Also:

ManagementFactory.getPlatformMBeanServer()

unregisterMBean

public void unregisterMBean()
                     throws CoreException

Description copied from interface: BaseComponentMBean

Unregister this component (and all children) from the default Platform MBeanServer.

Specified by:

unregisterMBean in interface BaseComponentMBean

Throws:

CoreException - wrapping any exception

See Also:

ManagementFactory.getPlatformMBeanServer()

getNotificationInfo

public javax.management.MBeanNotificationInfo[] getNotificationInfo()

Specified by:

getNotificationInfo in interface javax.management.NotificationBroadcaster

Overrides:

getNotificationInfo in class javax.management.NotificationBroadcasterSupport

getNotificationType

protected java.lang.String getNotificationType(ComponentManagerImpl.ComponentNotificationType type)

Specified by:

getNotificationType in class ComponentManagerImpl<Workflow>