com.adaptris.core.runtime

Interface ChannelManagerMBean

All Superinterfaces:

AdapterComponentMBean, BaseComponentMBean, ChildRuntimeInfoComponentMBean, HierarchicalMBean, ParentComponentMBean, ParentRuntimeInfoComponentMBean, RuntimeInfoComponent

All Known Implementing Classes:

ChannelManager

public interface ChannelManagerMBean
extends AdapterComponentMBean, ParentRuntimeInfoComponentMBean, ChildRuntimeInfoComponentMBean, HierarchicalMBean, ParentComponentMBean

Interface specifying controls for a single channel.

Field Summary

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

Method Summary

Modifier and Type	Method and Description
javax.management.ObjectName	addWorkflow(java.lang.String xmlString) Add a Workflow to this channel.
boolean	removeWorkflow(java.lang.String id) Remove a Workflow from this channel.

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

getComponentState, getConfiguration, getUniqueId, getWrappedComponentClassname, requestClose, requestClose, requestInit, requestInit, requestRestart, requestRestart, requestStart, requestStart, requestStartTime, requestStop, requestStop, requestStopTime

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

getChildRuntimeInfoComponents

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

getParentId, getParentObjectName

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

createObjectHierarchyString

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

getChildren

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

createObjectName, registerMBean, unregisterMBean

Method Detail

addWorkflow

javax.management.ObjectName addWorkflow(java.lang.String xmlString)
                                 throws CoreException,
                                        java.lang.IllegalStateException,
                                        javax.management.MalformedObjectNameException

Add a Workflow to this channel.

Parameters:

xmlString - the string representation of the workflow.

Returns:

the ObjectName reference to the newly created ChannelManagerMBean.

Throws:

CoreException - wrapping any exception

java.lang.IllegalStateException - if the state of the adapter is not "Closed"

javax.management.MalformedObjectNameException - upon ObjectName errors.

removeWorkflow

boolean removeWorkflow(java.lang.String id)
                throws CoreException,
                       java.lang.IllegalStateException,
                       javax.management.MalformedObjectNameException

Remove a Workflow from this channel.

This also removes the associated WorkflowManager and calls BaseComponentMBean.unregisterMBean().

Parameters:

id - the id of the channel to remove.

Returns:

true if the channel existed and was removed, false otherwise.

Throws:

CoreException - wrapping any exception

java.lang.IllegalStateException - if the state of the adapter is not "Closed"

javax.management.MalformedObjectNameException - upon ObjectName errors.