All Superinterfaces:

BaseComponentMBean

All Known Subinterfaces:

AdapterManagerMBean, AdapterRuntimeComponent<S>, AdapterRuntimeManager, ChannelManagerMBean, ChannelRuntimeManager, ChildComponent<S>, ChildComponentMBean, WorkflowManagerMBean, WorkflowRuntimeManager

All Known Implementing Classes:

AdapterManager, ChannelManager, ComponentManagerImpl, WorkflowManager
```
public interface AdapterComponentMBean
extends BaseComponentMBean
```
Base interface that exposes management functionality for an Adapter component.

Field Summary

Fields
Modifier and Type	Field	Description
`static java.lang.String`	`ADAPTER_PREFIX`	The standard prefix indicating the parent adapter which is ",adapter="
`static java.lang.String`	`CHANNEL_PREFIX`	The standard prefix indicating the parent channel which is ",channel="
`static java.lang.String`	`EQUALS`
`static java.lang.String`	`ID_PREFIX`	The standard prefix indicating the id of this component, which is @{value}
`static java.lang.String`	`JMX_ADAPTER_TYPE`	The standard JMX Prefix specifying domain and type which resolves to "com.adaptris:type=Adapter"
`static java.lang.String`	`JMX_CHANNEL_TYPE`	The standard JMX Prefix for channels which resolves to "com.adaptris:type=Channel"
`static java.lang.String`	`JMX_CONSUMER_MONITOR_TYPE`	The standard JMX Prefix for a given consumer monitor exposed via JMX which resolves to "com.adaptris:type=ConsumerMonitor"
`static java.lang.String`	`JMX_DOMAIN_NAME`	The standard Domain name for components.
`static java.lang.String`	`JMX_FAILED_MESSAGE_RETRIER_TYPE`	The standard JMX Prefix for a `FailedMessageRetrier` that is exposed via JMX which resolves to "com.adaptris:type=FailedMessageRetrier"
`static java.lang.String`	`JMX_FS_MONITOR_TYPE`	The standard JMX Prefix for a given Filesystem monitor exposed via JMX which resolves to "com.adaptris:type=FsMonitor"
`static java.lang.String`	`JMX_INFLIGHT_TYPE`	The standard JMX Prefix for a given MessageInFlight Interceptor exposed via JMX which resolves to "com.adaptris:type=InFlight"
`static java.lang.String`	`JMX_LOG_HANDLER_TYPE`	Deprecated.
`static java.lang.String`	`JMX_METRICS_TYPE`	The standard JMX Prefix for a given MessageMetricsStatistics exposed via JMX which resolves to "com.adaptris:type=Metrics"
`static java.lang.String`	`JMX_MSG_ERR_DIGESTER_TYPE`	The standard JMX Prefix for a given Message Error Digest exposed via JMX which resolves to "com.adaptris:type=MessageErrorDigest"
`static java.lang.String`	`JMX_NOTIFIER_TYPE`	The standard JMX Prefix for an Interceptor which emits `Notification` which resolves to "com.adaptris:type=Notifications"
`static java.lang.String`	`JMX_RETRY_MONITOR_TYPE`	The standard JMX Prefix for a given RetryMessageErrorHandler monitor exposed via JMX which resolves to "com.adaptris:type=RetryMessageHandlerMonitor"
`static java.lang.String`	`JMX_WORKFLOW_TYPE`	The standard JMX Prefix specifying domain and type which resolves to "com.adaptris:type=Workflow"
`static java.lang.String`	`KEY_ADAPTER`	ObjectName Key representing the adapter unique-id
`static java.lang.String`	`KEY_CHANNEL`	ObjectName Key representing parent channel unique-id
`static java.lang.String`	`KEY_ID`	ObjectName Key representing the unique-id of a component
`static java.lang.String`	`KEY_WORKFLOW`	ObjectName Key representing the parent workflow unique-id
`static java.lang.String`	`NOTIF_MSG_CLOSED`	The standard message for a component being closed '"Component Closed" '.
`static java.lang.String`	`NOTIF_MSG_CONFIG_UPDATED`	Standard Message for a configuration update.
`static java.lang.String`	`NOTIF_MSG_INITIALISED`	The standard message for a component being initialised '"Component Initialised" '.
`static java.lang.String`	`NOTIF_MSG_RESTARTED`	The standard message for a component being restarted '"Component Restarted" '.
`static java.lang.String`	`NOTIF_MSG_STARTED`	The standard message for a component being started '"Component Started" '.
`static java.lang.String`	`NOTIF_MSG_STOPPED`	The standard message for a component being stopped '"Component Stopped" '.
`static java.lang.String`	`NOTIF_TYPE_ADAPTER_CONFIG`	Notification type for adapter config update notifications '"adaptris.jmx.adapter.config" '
`static java.lang.String`	`NOTIF_TYPE_ADAPTER_LIFECYCLE`	The notification type for adapter lifecycle notifications '"adaptris.jmx.adapter.lifecycle" '.
`static java.lang.String`	`NOTIF_TYPE_CHANNEL_CONFIG`	Notification type for channel config update notifications '"adaptris.jmx.channel.config" '
`static java.lang.String`	`NOTIF_TYPE_CHANNEL_LIFECYCLE`	The notification type for channel lifecycle notifications '"adaptris.jmx.channel.lifecycle" '.
`static java.lang.String`	`NOTIF_TYPE_WORKFLOW_CONFIG`	Notification type for workflow config update notifications '"adaptris.jmx.workflow.config" '
`static java.lang.String`	`NOTIF_TYPE_WORKFLOW_LIFECYCLE`	The notification type for workflow lifecycle notifications '"adaptris.jmx.workflow.lifecycle" '.
`static java.lang.String`	`PROPERTY_SEPARATOR`
`static java.lang.String`	`WORKFLOW_PREFIX`	The standard prefix indicating the parent workflow which is ",workflow="

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method	Description
`ComponentState`	`getComponentState()`	Get the state of this managed runtime component.
`java.lang.String`	`getConfiguration()`	Get a marshalled copy of the configuration for this item.
`java.lang.String`	`getUniqueId()`	Get the name of this runtime component.
`java.lang.String`	`getWrappedComponentClassname()`	Get the class name that is wrapped by this MBean.
`void`	`requestClose()`	Deprecated. since 3.0.0, use `requestClose(long)` instead.
`void`	`requestClose(long timeoutMs)`	Close this component.
`void`	`requestInit()`	Deprecated. since 3.0.0, use `requestInit(long)` instead.
`void`	`requestInit(long timeoutMs)`	Initialise this component.
`void`	`requestRestart()`	Deprecated. since 3.0.0, use `requestRestart(long)` instead.
`void`	`requestRestart(long timeoutMs)`	Restart this component.
`void`	`requestStart()`	Deprecated. since 3.0.0, use `requestStart(long)` instead.
`void`	`requestStart(long timeoutMs)`	Start this component.
`long`	`requestStartTime()`	Returns timestamp of the last start time for this component
`void`	`requestStop()`	Deprecated. since 3.0.0, use `requestStop(long)` instead.
`void`	`requestStop(long timeout)`	Stop this component.
`long`	`requestStopTime()`	Returns timestamp of the last stop time for this component

Methods inherited from interface com.adaptris.core.runtime.BaseComponentMBean
createObjectName, registerMBean, unregisterMBean

- Field Detail
  - PROPERTY_SEPARATOR
```
static final java.lang.String PROPERTY_SEPARATOR
```
    See Also:
    
    Constant Field Values
  - EQUALS
```
static final java.lang.String EQUALS
```
    See Also:
    
    Constant Field Values
  - KEY_ID
```
static final java.lang.String KEY_ID
```
    ObjectName Key representing the unique-id of a component
    
    See Also:
    
    Constant Field Values
  - KEY_ADAPTER
```
static final java.lang.String KEY_ADAPTER
```
    ObjectName Key representing the adapter unique-id
    
    See Also:
    
    Constant Field Values
  - KEY_CHANNEL
```
static final java.lang.String KEY_CHANNEL
```
    ObjectName Key representing parent channel unique-id
    
    See Also:
    
    Constant Field Values
  - KEY_WORKFLOW
```
static final java.lang.String KEY_WORKFLOW
```
    ObjectName Key representing the parent workflow unique-id
    
    See Also:
    
    Constant Field Values
  - ID_PREFIX
```
static final java.lang.String ID_PREFIX
```
    The standard prefix indicating the id of this component, which is @{value}
    
    See Also:
    
    Constant Field Values
  - ADAPTER_PREFIX
```
static final java.lang.String ADAPTER_PREFIX
```
    The standard prefix indicating the parent adapter which is ",adapter="
    
    See Also:
    
    Constant Field Values
  - CHANNEL_PREFIX
```
static final java.lang.String CHANNEL_PREFIX
```
    The standard prefix indicating the parent channel which is ",channel="
    
    See Also:
    
    Constant Field Values
  - WORKFLOW_PREFIX
```
static final java.lang.String WORKFLOW_PREFIX
```
    The standard prefix indicating the parent workflow which is ",workflow="
    
    See Also:
    
    Constant Field Values
  - JMX_DOMAIN_NAME
```
static final java.lang.String JMX_DOMAIN_NAME
```
    The standard Domain name for components.
    
    See Also:
    
    Constant Field Values
  - JMX_ADAPTER_TYPE
```
static final java.lang.String JMX_ADAPTER_TYPE
```
    The standard JMX Prefix specifying domain and type which resolves to "com.adaptris:type=Adapter"
    
    See Also:
    
    Constant Field Values
  - JMX_WORKFLOW_TYPE
```
static final java.lang.String JMX_WORKFLOW_TYPE
```
    The standard JMX Prefix specifying domain and type which resolves to "com.adaptris:type=Workflow"
    
    See Also:
    
    Constant Field Values
  - JMX_CHANNEL_TYPE
```
static final java.lang.String JMX_CHANNEL_TYPE
```
    The standard JMX Prefix for channels which resolves to "com.adaptris:type=Channel"
    
    See Also:
    
    Constant Field Values
  - JMX_MSG_ERR_DIGESTER_TYPE
```
static final java.lang.String JMX_MSG_ERR_DIGESTER_TYPE
```
    The standard JMX Prefix for a given Message Error Digest exposed via JMX which resolves to "com.adaptris:type=MessageErrorDigest"
    
    See Also:
    
    Constant Field Values
  - JMX_LOG_HANDLER_TYPE
```
@Deprecated
@Removal(version="5.0")
static final java.lang.String JMX_LOG_HANDLER_TYPE
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - JMX_FAILED_MESSAGE_RETRIER_TYPE
```
static final java.lang.String JMX_FAILED_MESSAGE_RETRIER_TYPE
```
    The standard JMX Prefix for a FailedMessageRetrier that is exposed via JMX which resolves to "com.adaptris:type=FailedMessageRetrier"
    
    See Also:
    
    Constant Field Values
  - JMX_METRICS_TYPE
```
static final java.lang.String JMX_METRICS_TYPE
```
    The standard JMX Prefix for a given MessageMetricsStatistics exposed via JMX which resolves to "com.adaptris:type=Metrics"
    
    See Also:
    
    Constant Field Values
  - JMX_INFLIGHT_TYPE
```
static final java.lang.String JMX_INFLIGHT_TYPE
```
    The standard JMX Prefix for a given MessageInFlight Interceptor exposed via JMX which resolves to "com.adaptris:type=InFlight"
    
    See Also:
    
    Constant Field Values
  - JMX_FS_MONITOR_TYPE
```
static final java.lang.String JMX_FS_MONITOR_TYPE
```
    The standard JMX Prefix for a given Filesystem monitor exposed via JMX which resolves to "com.adaptris:type=FsMonitor"
    
    See Also:
    
    Constant Field Values
  - JMX_CONSUMER_MONITOR_TYPE
```
static final java.lang.String JMX_CONSUMER_MONITOR_TYPE
```
    The standard JMX Prefix for a given consumer monitor exposed via JMX which resolves to "com.adaptris:type=ConsumerMonitor"
    
    See Also:
    
    Constant Field Values
  - JMX_RETRY_MONITOR_TYPE
```
static final java.lang.String JMX_RETRY_MONITOR_TYPE
```
    The standard JMX Prefix for a given RetryMessageErrorHandler monitor exposed via JMX which resolves to "com.adaptris:type=RetryMessageHandlerMonitor"
    
    See Also:
    
    Constant Field Values
  - JMX_NOTIFIER_TYPE
```
static final java.lang.String JMX_NOTIFIER_TYPE
```
    The standard JMX Prefix for an Interceptor which emits Notification which resolves to "com.adaptris:type=Notifications"
    
    See Also:
    
    Constant Field Values
  - NOTIF_TYPE_ADAPTER_LIFECYCLE
```
static final java.lang.String NOTIF_TYPE_ADAPTER_LIFECYCLE
```
    The notification type for adapter lifecycle notifications '"adaptris.jmx.adapter.lifecycle" '.
    
    See Also:
    
    Constant Field Values
  - NOTIF_TYPE_CHANNEL_LIFECYCLE
```
static final java.lang.String NOTIF_TYPE_CHANNEL_LIFECYCLE
```
    The notification type for channel lifecycle notifications '"adaptris.jmx.channel.lifecycle" '.
    
    See Also:
    
    Constant Field Values
  - NOTIF_TYPE_WORKFLOW_LIFECYCLE
```
static final java.lang.String NOTIF_TYPE_WORKFLOW_LIFECYCLE
```
    The notification type for workflow lifecycle notifications '"adaptris.jmx.workflow.lifecycle" '.
    
    See Also:
    
    Constant Field Values
  - NOTIF_TYPE_WORKFLOW_CONFIG
```
static final java.lang.String NOTIF_TYPE_WORKFLOW_CONFIG
```
    Notification type for workflow config update notifications '"adaptris.jmx.workflow.config" '
    
    See Also:
    
    Constant Field Values
  - NOTIF_TYPE_CHANNEL_CONFIG
```
static final java.lang.String NOTIF_TYPE_CHANNEL_CONFIG
```
    Notification type for channel config update notifications '"adaptris.jmx.channel.config" '
    
    See Also:
    
    Constant Field Values
  - NOTIF_TYPE_ADAPTER_CONFIG
```
static final java.lang.String NOTIF_TYPE_ADAPTER_CONFIG
```
    Notification type for adapter config update notifications '"adaptris.jmx.adapter.config" '
    
    See Also:
    
    Constant Field Values
  - NOTIF_MSG_CONFIG_UPDATED
```
static final java.lang.String NOTIF_MSG_CONFIG_UPDATED
```
    Standard Message for a configuration update.
    
    See Also:
    
    Constant Field Values
  - NOTIF_MSG_INITIALISED
```
static final java.lang.String NOTIF_MSG_INITIALISED
```
    The standard message for a component being initialised '"Component Initialised" '.
    
    See Also:
    
    Constant Field Values
  - NOTIF_MSG_STARTED
```
static final java.lang.String NOTIF_MSG_STARTED
```
    The standard message for a component being started '"Component Started" '.
    
    See Also:
    
    Constant Field Values
  - NOTIF_MSG_STOPPED
```
static final java.lang.String NOTIF_MSG_STOPPED
```
    The standard message for a component being stopped '"Component Stopped" '.
    
    See Also:
    
    Constant Field Values
  - NOTIF_MSG_CLOSED
```
static final java.lang.String NOTIF_MSG_CLOSED
```
    The standard message for a component being closed '"Component Closed" '.
    
    See Also:
    
    Constant Field Values
  - NOTIF_MSG_RESTARTED
```
static final java.lang.String NOTIF_MSG_RESTARTED
```
    The standard message for a component being restarted '"Component Restarted" '.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - requestInit
```
@Deprecated
void requestInit()
          throws CoreException
```
    Deprecated.
    since 3.0.0, use requestInit(long) instead.
    
    Initialise this component.
    
    Throws:
    
    CoreException - wrapping any underlying Exception
  - requestInit
```
void requestInit(long timeoutMs)
          throws CoreException,
                 java.util.concurrent.TimeoutException
```
    Initialise this component.
    A timeout is required as Connections within the adapter may be configured to retry forever (if a broker is not available for instance) which would cause this method to never return.
    
    Parameters:
    
    timeoutMs - the max timeout to wait for in milliseconds
    
    Throws:
    
    CoreException - wrapping any underlying adapter exception
    
    java.util.concurrent.TimeoutException - if the timeout was exceeded.
  - requestStart
```
@Deprecated
void requestStart()
           throws CoreException
```
    Deprecated.
    since 3.0.0, use requestStart(long) instead.
    
    Start this component.
    
    Throws:
    
    CoreException - wrapping any underlying Exception
  - requestStart
```
void requestStart(long timeoutMs)
           throws CoreException,
                  java.util.concurrent.TimeoutException
```
    Start this component.
    A timeout is required as Connections within the adapter may be configured to retry forever (if a broker is not available for instance) which would cause this method to never return.
    
    Parameters:
    
    timeoutMs - the max timeout to wait for in milliseconds
    
    Throws:
    
    CoreException - wrapping any underlying adapter exception
    
    java.util.concurrent.TimeoutException - if the timeout was exceeded.
  - requestStop
```
@Deprecated
void requestStop()
          throws CoreException
```
    Deprecated.
    since 3.0.0, use requestStop(long) instead.
    
    stop this component.
    
    Throws:
    
    CoreException - wrapping any underlying Exception
  - requestStop
```
void requestStop(long timeout)
          throws CoreException,
                 java.util.concurrent.TimeoutException
```
    Stop this component.
    A timeout is required as Connections within the adapter may be configured to retry forever (if a broker is not available for instance) which would cause this method to never return.
    
    Parameters:
    
    timeout - the max timeout to wait for in milliseconds
    
    Throws:
    
    CoreException - wrapping any underlying adapter exception
    
    java.util.concurrent.TimeoutException - if the timeout was exceeded.
  - requestClose
```
@Deprecated
void requestClose()
           throws CoreException
```
    Deprecated.
    since 3.0.0, use requestClose(long) instead.
    
    Close this component.
    
    Throws:
    
    CoreException - wrapping any underlying Exception
  - requestClose
```
void requestClose(long timeoutMs)
           throws CoreException,
                  java.util.concurrent.TimeoutException
```
    Close this component.
    A timeout is required as Connections within the adapter may be configured to retry forever (if a broker is not available for instance) which would cause this method to never return.
    
    Parameters:
    
    timeoutMs - the max timeout to wait for in milliseconds
    
    Throws:
    
    CoreException - wrapping any underlying adapter exception
    
    java.util.concurrent.TimeoutException - if the timeout was exceeded.
  - requestRestart
```
@Deprecated
void requestRestart()
             throws CoreException
```
    Deprecated.
    since 3.0.0, use requestRestart(long) instead.
    
    Restart this channel.
    This is semantically equivalent to calling requestClose() and requestStart()
    
    Throws:
    
    CoreException - wrapping any underlying Exception
  - requestRestart
```
void requestRestart(long timeoutMs)
             throws CoreException,
                    java.util.concurrent.TimeoutException
```
    Restart this component.
    This just invokes requestClose(long) and requestStart(long) in sequence with the timeoutMs parameter. Bear in mind that a TimeoutException may not occur until 2 * timeoutMs depending on how long the component takes to close and start.
    
    Parameters:
    
    timeoutMs - the max timeout to pass into requestClose(long) and requestStart(long) in ms. This means that a TimeoutException might not occur until 2 * timeoutMs.
    
    Throws:
    
    CoreException - wrapping any underlying adapter exception
    
    java.util.concurrent.TimeoutException - if the timeout was exceeded.
  - requestStartTime
```
long requestStartTime()
```
    Returns timestamp of the last start time for this component
    
    Returns:
    
    the last start time, or 0 if the component has never been started.
  - requestStopTime
```
long requestStopTime()
```
    Returns timestamp of the last stop time for this component
    
    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.
  - getComponentState
```
ComponentState getComponentState()
```
    Get the state of this managed runtime component.
    
    Returns:
    
    the component state
  - getUniqueId
```
java.lang.String getUniqueId()
```
    Get the name of this runtime component.
    
    Returns:
    
    the name of this component which is generally semantically equivalent to the corresponding Workflow.getUniqueId() or Channel.getUniqueId()
  - getConfiguration
```
java.lang.String getConfiguration()
                           throws CoreException
```
    Get a marshalled copy of the configuration for this item.
    
    Returns:
    
    a string representation of the config for this item.
    
    Throws:
    
    CoreException - wrapping any underlying Exception
    
    See Also:
    
    DefaultMarshaller.getDefaultMarshaller()
  - getWrappedComponentClassname
```
java.lang.String getWrappedComponentClassname()
```
    Get the class name that is wrapped by this MBean.
    
    Returns:
    
    the class name (e.g. com.adaptris.core.StandardWorkflow)

Interface AdapterComponentMBean

Field Summary

Method Summary

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

Field Detail

PROPERTY_SEPARATOR

EQUALS

KEY_ID

KEY_ADAPTER

KEY_CHANNEL

KEY_WORKFLOW

ID_PREFIX

ADAPTER_PREFIX

CHANNEL_PREFIX

WORKFLOW_PREFIX

JMX_DOMAIN_NAME

JMX_ADAPTER_TYPE

JMX_WORKFLOW_TYPE

JMX_CHANNEL_TYPE

JMX_MSG_ERR_DIGESTER_TYPE

JMX_LOG_HANDLER_TYPE

JMX_FAILED_MESSAGE_RETRIER_TYPE

JMX_METRICS_TYPE

JMX_INFLIGHT_TYPE

JMX_FS_MONITOR_TYPE

JMX_CONSUMER_MONITOR_TYPE

JMX_RETRY_MONITOR_TYPE

JMX_NOTIFIER_TYPE

NOTIF_TYPE_ADAPTER_LIFECYCLE

NOTIF_TYPE_CHANNEL_LIFECYCLE

NOTIF_TYPE_WORKFLOW_LIFECYCLE

NOTIF_TYPE_WORKFLOW_CONFIG

NOTIF_TYPE_CHANNEL_CONFIG

NOTIF_TYPE_ADAPTER_CONFIG

NOTIF_MSG_CONFIG_UPDATED

NOTIF_MSG_INITIALISED

NOTIF_MSG_STARTED

NOTIF_MSG_STOPPED

NOTIF_MSG_CLOSED

NOTIF_MSG_RESTARTED

Method Detail

requestInit

requestInit

requestStart

requestStart

requestStop

requestStop

requestClose

requestClose

requestRestart

requestRestart

requestStartTime

requestStopTime

getComponentState

getUniqueId

getConfiguration

getWrappedComponentClassname