public interface AdapterComponentMBean extends BaseComponentMBean
Modifier and Type | Field and 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
The standard JMX Prefix for a
LogHandler that is exposed via JMX which resolves to "com.adaptris:type=LogHandler" |
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="
|
Modifier and Type | Method and 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
|
createObjectName, registerMBean, unregisterMBean
static final java.lang.String PROPERTY_SEPARATOR
static final java.lang.String EQUALS
static final java.lang.String KEY_ID
static final java.lang.String KEY_ADAPTER
static final java.lang.String KEY_CHANNEL
static final java.lang.String KEY_WORKFLOW
static final java.lang.String ID_PREFIX
static final java.lang.String ADAPTER_PREFIX
static final java.lang.String CHANNEL_PREFIX
static final java.lang.String WORKFLOW_PREFIX
static final java.lang.String JMX_DOMAIN_NAME
static final java.lang.String JMX_ADAPTER_TYPE
static final java.lang.String JMX_WORKFLOW_TYPE
static final java.lang.String JMX_CHANNEL_TYPE
static final java.lang.String JMX_MSG_ERR_DIGESTER_TYPE
static final java.lang.String JMX_LOG_HANDLER_TYPE
LogHandler
that is exposed via JMX which resolves to "com.adaptris:type=LogHandler"static final java.lang.String JMX_FAILED_MESSAGE_RETRIER_TYPE
FailedMessageRetrier
that is exposed via JMX which resolves to "com.adaptris:type=FailedMessageRetrier"static final java.lang.String JMX_METRICS_TYPE
static final java.lang.String JMX_INFLIGHT_TYPE
static final java.lang.String JMX_FS_MONITOR_TYPE
static final java.lang.String JMX_CONSUMER_MONITOR_TYPE
static final java.lang.String JMX_RETRY_MONITOR_TYPE
static final java.lang.String JMX_NOTIFIER_TYPE
Notification
which resolves to "com.adaptris:type=Notifications"static final java.lang.String NOTIF_TYPE_ADAPTER_LIFECYCLE
static final java.lang.String NOTIF_TYPE_CHANNEL_LIFECYCLE
static final java.lang.String NOTIF_TYPE_WORKFLOW_LIFECYCLE
static final java.lang.String NOTIF_TYPE_WORKFLOW_CONFIG
static final java.lang.String NOTIF_TYPE_CHANNEL_CONFIG
static final java.lang.String NOTIF_TYPE_ADAPTER_CONFIG
static final java.lang.String NOTIF_MSG_CONFIG_UPDATED
static final java.lang.String NOTIF_MSG_INITIALISED
static final java.lang.String NOTIF_MSG_STARTED
static final java.lang.String NOTIF_MSG_STOPPED
static final java.lang.String NOTIF_MSG_CLOSED
static final java.lang.String NOTIF_MSG_RESTARTED
@Deprecated void requestInit() throws CoreException
requestInit(long)
instead.CoreException
- wrapping any underlying Exceptionvoid requestInit(long timeoutMs) throws CoreException, java.util.concurrent.TimeoutException
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.
timeoutMs
- the max timeout to wait for in millisecondsCoreException
- wrapping any underlying adapter exceptionjava.util.concurrent.TimeoutException
- if the timeout was exceeded.@Deprecated void requestStart() throws CoreException
requestStart(long)
instead.CoreException
- wrapping any underlying Exceptionvoid requestStart(long timeoutMs) throws CoreException, java.util.concurrent.TimeoutException
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.
timeoutMs
- the max timeout to wait for in millisecondsCoreException
- wrapping any underlying adapter exceptionjava.util.concurrent.TimeoutException
- if the timeout was exceeded.@Deprecated void requestStop() throws CoreException
requestStop(long)
instead.CoreException
- wrapping any underlying Exceptionvoid requestStop(long timeout) throws CoreException, java.util.concurrent.TimeoutException
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.
timeout
- the max timeout to wait for in millisecondsCoreException
- wrapping any underlying adapter exceptionjava.util.concurrent.TimeoutException
- if the timeout was exceeded.@Deprecated void requestClose() throws CoreException
requestClose(long)
instead.CoreException
- wrapping any underlying Exceptionvoid requestClose(long timeoutMs) throws CoreException, java.util.concurrent.TimeoutException
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.
timeoutMs
- the max timeout to wait for in millisecondsCoreException
- wrapping any underlying adapter exceptionjava.util.concurrent.TimeoutException
- if the timeout was exceeded.@Deprecated void requestRestart() throws CoreException
requestRestart(long)
instead.
This is semantically equivalent to calling requestClose()
and requestStart()
CoreException
- wrapping any underlying Exceptionvoid requestRestart(long timeoutMs) throws CoreException, java.util.concurrent.TimeoutException
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.
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.CoreException
- wrapping any underlying adapter exceptionjava.util.concurrent.TimeoutException
- if the timeout was exceeded.long requestStartTime()
long requestStopTime()
ComponentState getComponentState()
java.lang.String getUniqueId()
Workflow.getUniqueId()
or Channel.getUniqueId()
java.lang.String getConfiguration() throws CoreException
CoreException
- wrapping any underlying ExceptionDefaultMarshaller.getDefaultMarshaller()
java.lang.String getWrappedComponentClassname()
com.adaptris.core.StandardWorkflow
)