public interface AdapterManagerMBean extends AdapterComponentMBean, ParentRuntimeInfoComponentMBean, HierarchicalMBean, ParentComponentMBean
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
NOTIF_MSG_FORCE_CLOSE
Standard Message for a force close notification '"Adapter Force Close" '
|
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
Modifier and Type | Method and Description |
---|---|
boolean |
addAndBindSharedConnection(java.lang.String xmlString)
Add an
AdaptrisConnection to the adapter's shared components. |
boolean |
addAndBindSharedService(java.lang.String xmlString)
Add an
Service to the adapter's shared components. |
javax.management.ObjectName |
addChannel(java.lang.String xmlString)
Add a
Channel to this adapter. |
boolean |
addSharedConnection(java.lang.String xmlString)
Add an
AdaptrisConnection to the adapter's shared components.. |
boolean |
addSharedService(java.lang.String xmlString)
Add a
Service to the adapter's shared components. |
boolean |
containsSharedConnection(java.lang.String connectionId)
Check if the associated connectionId is already present in the shared connections.
|
boolean |
containsSharedService(java.lang.String serviceId)
Check if the associated serviceId is already present in the shared services.
|
void |
forceClose()
Forcibly close the associated adapter.
|
java.lang.String |
getAdapterBuildVersion()
Get the adapter build version.
|
java.util.List<java.lang.String> |
getArtifactIdentifiers()
Get a list of all the modules currently installed for this adapter.
|
java.util.List<java.lang.String> |
getModuleVersions()
Get a list of all the modules currently installed for this adapter.
|
java.util.Collection<java.lang.String> |
getSharedConnectionIds()
Get all the connection unique-ids that are currently registered as a shared connection.
|
java.util.Collection<java.lang.String> |
getSharedServiceIds()
Get all the service unique-ids that are currently registered as a shared service.
|
boolean |
removeChannel(java.lang.String id)
Remove a
Channel from this adapter. |
boolean |
removeSharedComponent(java.lang.String id)
Convenience method to do both
removeSharedService(String) and #removeSharedConnection(String) at once. |
boolean |
removeSharedConnection(java.lang.String connectionId)
Remove a connection from the adapter's shared connections.
|
boolean |
removeSharedService(java.lang.String serviceId)
Remove a service from the adapter's shared components.
|
void |
sendLifecycleEvent(AdapterLifecycleEvent event)
Send an
AdapterLifecycleEvent to any configured event handlers. |
void |
setFailedMessageRetrier(java.lang.String xmlString)
Set the
FailedMessageRetrier for this adapter. |
void |
setMessageErrorHandler(java.lang.String xmlString)
Set the
ProcessingExceptionHandler for this adapter. |
getComponentState, getConfiguration, getUniqueId, getWrappedComponentClassname, requestClose, requestClose, requestInit, requestInit, requestRestart, requestRestart, requestStart, requestStart, requestStartTime, requestStop, requestStop, requestStopTime
getChildRuntimeInfoComponents
createObjectHierarchyString
getChildren
createObjectName, registerMBean, unregisterMBean
static final java.lang.String NOTIF_MSG_FORCE_CLOSE
boolean addSharedConnection(java.lang.String xmlString) throws CoreException, java.lang.IllegalStateException, java.lang.IllegalArgumentException
AdaptrisConnection
to the adapter's shared components..xmlString
- the string representation of the connection.CoreException
- wrapping any other exceptionjava.lang.IllegalStateException
- if the state of the adapter is not closed.java.lang.IllegalArgumentException
- if the connection does not have an unique-idboolean addAndBindSharedConnection(java.lang.String xmlString) throws CoreException, java.lang.IllegalStateException, java.lang.IllegalArgumentException
AdaptrisConnection
to the adapter's shared components. and bind it to JNDI.
This is primarily for adding shared connections when the Adapter is currently started. Runtime manipulation of the adapter
allows you to invoke addChannel(String)
while the adapter is running. If the Channel
object
contains a reference to a shared connection, then you should use this method to add the and bind the shared connection to JNDI
ready for use.
xmlString
- the string representation of the connection.CoreException
- wrapping any other exceptionjava.lang.IllegalStateException
- if the state of the adapter is actually closed, in which case you should use
addSharedConnection(String)
instead..java.lang.IllegalArgumentException
- if the connection does not have an unique-idboolean removeSharedConnection(java.lang.String connectionId) throws CoreException, java.lang.IllegalStateException
connectionId
- the connection unique-id to remove.CoreException
- wrapping any other exceptionjava.lang.IllegalStateException
- if the state of the adapter is not closed.boolean containsSharedConnection(java.lang.String connectionId) throws CoreException
connectionId
- the connection unique-id to check forCoreException
- wrapping any other exceptionjava.util.Collection<java.lang.String> getSharedConnectionIds() throws CoreException
CoreException
- wrapping any other exceptionboolean addSharedService(java.lang.String xmlString) throws CoreException, java.lang.IllegalStateException, java.lang.IllegalArgumentException
Service
to the adapter's shared components.xmlString
- the string representation of the service.CoreException
- wrapping any other exceptionjava.lang.IllegalStateException
- if the state of the adapter is not closed.java.lang.IllegalArgumentException
- if the connection does not have an unique-idboolean addAndBindSharedService(java.lang.String xmlString) throws CoreException, java.lang.IllegalStateException, java.lang.IllegalArgumentException
Service
to the adapter's shared components. and bind it to JNDI.
This is primarily for adding shared services when the Adapter is currently started. Runtime manipulation of the adapter allows
you to invoke addChannel(String)
while the adapter is running. If the Channel
object
contains a reference to a shared service, then you should use this method to add the and bind the shared connection to JNDI
ready for use.
xmlString
- the string representation of the service.CoreException
- wrapping any other exceptionjava.lang.IllegalStateException
- if the state of the adapter is actually closed, in which case you should use
addSharedConnection(String)
instead..java.lang.IllegalArgumentException
- if the connection does not have an unique-idboolean removeSharedService(java.lang.String serviceId) throws CoreException, java.lang.IllegalStateException
serviceId
- the shared service unique-id to remove.CoreException
- wrapping any other exceptionjava.lang.IllegalStateException
- if the state of the adapter is not closed.boolean containsSharedService(java.lang.String serviceId) throws CoreException
serviceId
- the shared service unique-id to remove.CoreException
- wrapping any other exceptionjava.util.Collection<java.lang.String> getSharedServiceIds() throws CoreException
CoreException
- wrapping any other exceptionboolean removeSharedComponent(java.lang.String id) throws CoreException, java.lang.IllegalStateException
removeSharedService(String)
and #removeSharedConnection(String)
at once.id
- the shared id to remove.CoreException
- wrapping any other exceptionjava.lang.IllegalStateException
- if the state of the adapter is not closed.javax.management.ObjectName addChannel(java.lang.String xmlString) throws CoreException, javax.management.MalformedObjectNameException
Channel
to this adapter.xmlString
- the string representation of the channel.CoreException
- wrapping any exceptionjavax.management.MalformedObjectNameException
- upon ObjectName errors.boolean removeChannel(java.lang.String id) throws CoreException, javax.management.MalformedObjectNameException
Channel
from this adapter.
This also removes the associated ChannelManager
and calls BaseComponentMBean.unregisterMBean()
.
id
- the id of the channel to remove.CoreException
- wrapping any exceptionjavax.management.MalformedObjectNameException
- upon ObjectName errors.void setMessageErrorHandler(java.lang.String xmlString) throws CoreException
ProcessingExceptionHandler
for this adapter.xmlString
- the string representation of the error handler.CoreException
- wrapping any exceptionjava.lang.IllegalStateException
- if the state of the adapter is not "Closed"void setFailedMessageRetrier(java.lang.String xmlString) throws CoreException
FailedMessageRetrier
for this adapter.xmlString
- the string representation of the error handler.CoreException
- wrapping any exceptionjava.lang.IllegalStateException
- if the state of the adapter is not "Closed"java.lang.String getAdapterBuildVersion()
java.util.List<java.lang.String> getModuleVersions()
java.util.List<java.lang.String> getArtifactIdentifiers()
groupId:artifactId:version
.void sendLifecycleEvent(AdapterLifecycleEvent event) throws CoreException
AdapterLifecycleEvent
to any configured event handlers.event
- the AdapterLifecycleEvent
to send.CoreException
- wrapping any exceptionvoid forceClose() throws CoreException
In the event that there is a concrete AllowsRetriesConnection
that is configured incorrectly, and set
with infinite retries; then the adapter will appear to be stuck waiting in the incorrect state (generally, attempting to
initialise) when asked nicely to stop. Use this method to forcibly terminate whatever operations are being attempted and to
shutdown the adapter.
CoreException