com.adaptris.core.runtime

Class AdapterManager

java.lang.Object

javax.management.NotificationBroadcasterSupport

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

com.adaptris.core.runtime.AdapterManager

All Implemented Interfaces:

AdapterComponentMBean, AdapterManagerMBean, AdapterRuntimeComponent<Adapter>, AdapterRuntimeManager, BaseComponentMBean, HierarchicalMBean, ParentComponent<ChannelRuntimeManager>, ParentComponentMBean, ParentRuntimeInfoComponent, ParentRuntimeInfoComponentMBean, RuntimeInfoComponent, javax.management.NotificationBroadcaster, javax.management.NotificationEmitter

public class AdapterManager
extends ComponentManagerImpl<Adapter>
implements AdapterManagerMBean, AdapterRuntimeManager

Base implementation of AdapterManagerMBean.

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.AdapterManagerMBean

NOTIF_MSG_FORCE_CLOSE

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
AdapterManager(Adapter owner)

Method Summary

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 xml) Add a Channel to this adapter.
boolean	addChild(ChannelRuntimeManager cmb) Add a a child to this parent.
boolean	addChildJmxComponent(ChildRuntimeInfoComponent comp)
boolean	addChildren(java.util.Collection<ChannelRuntimeManager> coll) Add some children to this parent (optional operation).
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.
protected void	checkTransitionTo(ComponentState futureState) Check whether the transition is allowed in the context of the current component's (or parent's) state.
void	childUpdated() Notifies a parent that a child component has been updated.
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.
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.
void	forceClose() Forcibly close the associated adapter.
java.lang.String	getAdapterBuildVersion() Get the adapter build version.
java.util.Collection<BaseComponentMBean>	getAllDescendants() Get all the descendants of this ParentComponent implementation.
java.util.List<java.lang.String>	getArtifactIdentifiers() Get a list of all the modules currently installed for this adapter.
java.util.Collection<javax.management.ObjectName>	getChildren() Get the list of ObjectName instances that map to all the immeidate child components of this parent.
java.util.Collection<javax.management.ObjectName>	getChildRuntimeInfoComponents()
java.util.List<java.lang.String>	getModuleVersions() Get a list of all the modules currently installed for this adapter.
javax.management.MBeanNotificationInfo[]	getNotificationInfo()
protected java.lang.String	getNotificationType(ComponentManagerImpl.ComponentNotificationType type)
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.
Adapter	getWrappedComponent() Get the component that this implementation manages.
int	hashCode()
void	registerMBean() Register this component (and all children) against the default Platform MBeanServer.
boolean	removeChannel(java.lang.String id) Remove a Channel from this adapter.
boolean	removeChild(ChannelRuntimeManager cmb) Remove a Child from this parent.
boolean	removeChildJmxComponent(ChildRuntimeInfoComponent comp)
boolean	removeChildren(java.util.Collection<ChannelRuntimeManager> coll) Remove some children from this parent.
boolean	removeSharedComponent(java.lang.String id) Convenience method to do both AdapterManagerMBean.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.
long	requestStartTime() Returns timestamp of the last start time for this component
long	requestStopTime() Returns timestamp of the last stop time for this component
void	sendLifecycleEvent(AdapterLifecycleEvent event) Send an AdapterLifecycleEvent to any configured event handlers.
void	setFailedMessageRetrier(java.lang.String xml) Set the FailedMessageRetrier for this adapter.
void	setMessageErrorHandler(java.lang.String xml) Set the ProcessingExceptionHandler for this adapter.
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

AdapterManager

public AdapterManager(Adapter 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.

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.

getChildren

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

Description copied from interface: ParentComponentMBean

Get the list of ObjectName instances that map to all the immeidate child components of this parent.

Specified by:

getChildren in interface ParentComponentMBean

Returns:

a list of ObjectName instances.

Throws:

javax.management.MalformedObjectNameException

addChild

public boolean addChild(ChannelRuntimeManager cmb)
                 throws CoreException

Description copied from interface: ParentComponent

Add a a child to this parent.

Specified by:

addChild in interface ParentComponent<ChannelRuntimeManager>

Parameters:

cmb - a channel manager

Returns:

true if the underlying components were modified.

Throws:

CoreException - wrapping any underlying exception

See Also:

Set.add(Object)

removeChild

public boolean removeChild(ChannelRuntimeManager cmb)
                    throws CoreException

Description copied from interface: ParentComponent

Remove a Child from this parent.

Specified by:

removeChild in interface ParentComponent<ChannelRuntimeManager>

Parameters:

cmb - a channel manager

Returns:

true if the component existed as a child

Throws:

CoreException - wrapping any underlying exception

See Also:

Set.remove(Object)

addChildren

public boolean addChildren(java.util.Collection<ChannelRuntimeManager> coll)
                    throws CoreException

Description copied from interface: ParentComponent

Add some children to this parent (optional operation).

Specified by:

addChildren in interface ParentComponent<ChannelRuntimeManager>

Parameters:

coll - a collection of items to be added.

Returns:

true if the underlying components were modified.

Throws:

CoreException - wrapping any underlying exception

See Also:

Set.addAll(Collection)

removeChildren

public boolean removeChildren(java.util.Collection<ChannelRuntimeManager> coll)
                       throws CoreException

Description copied from interface: ParentComponent

Remove some children from this parent.

Specified by:

removeChildren in interface ParentComponent<ChannelRuntimeManager>

Parameters:

coll - a collection of items to be removed.

Returns:

true if the underlying components were modified.

Throws:

CoreException - wrapping any underlying exception

See Also:

Set.addAll(Collection)

getWrappedComponent

public Adapter getWrappedComponent()

Description copied from interface: AdapterRuntimeComponent

Get the component that this implementation manages.

Specified by:

getWrappedComponent in interface AdapterRuntimeComponent<Adapter>

Returns:

my component.

equals

public boolean equals(java.lang.Object o)

Equality is based on the underlying ObjectName.

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString 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<Adapter>

Parameters:

futureState - the state we want to transition to.

Throws:

CoreException - if the state transition check fails.

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<Adapter>

Specified by:

getAllDescendants in interface ParentComponent<ChannelRuntimeManager>

Returns:

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

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

Specified by:

createObjectHierarchyString in interface ParentComponent<ChannelRuntimeManager>

Returns:

a hierarchy based on the tree.

addSharedConnection

public boolean addSharedConnection(java.lang.String xmlString)
                            throws CoreException,
                                   java.lang.IllegalArgumentException

Description copied from interface: AdapterManagerMBean

Add an AdaptrisConnection to the adapter's shared components..

Specified by:

addSharedConnection in interface AdapterManagerMBean

Parameters:

xmlString - the string representation of the connection.

Returns:

true if the connection was added, false if the connection's unique-id already exists in the list.

Throws:

CoreException - wrapping any other exception

java.lang.IllegalArgumentException - if the connection does not have an unique-id

addAndBindSharedConnection

public boolean addAndBindSharedConnection(java.lang.String xmlString)
                                   throws CoreException,
                                          java.lang.IllegalStateException

Description copied from interface: AdapterManagerMBean

Add an 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 AdapterManagerMBean.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.

Specified by:

addAndBindSharedConnection in interface AdapterManagerMBean

Parameters:

xmlString - the string representation of the connection.

Returns:

true if the connection was added, false if the connection's unique-id already exists in the list.

Throws:

CoreException - wrapping any other exception

java.lang.IllegalStateException - if the state of the adapter is actually closed, in which case you should use AdapterManagerMBean.addSharedConnection(String) instead..

removeSharedConnection

public boolean removeSharedConnection(java.lang.String connectionId)
                               throws CoreException,
                                      java.lang.IllegalStateException

Description copied from interface: AdapterManagerMBean

Remove a connection from the adapter's shared connections.

Specified by:

removeSharedConnection in interface AdapterManagerMBean

Parameters:

connectionId - the connection unique-id to remove.

Returns:

true if the connection was removed, false otherwise.

Throws:

CoreException - wrapping any other exception

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

containsSharedConnection

public boolean containsSharedConnection(java.lang.String connectionId)
                                 throws CoreException

Description copied from interface: AdapterManagerMBean

Check if the associated connectionId is already present in the shared connections.

Specified by:

containsSharedConnection in interface AdapterManagerMBean

Parameters:

connectionId - the connection unique-id to check for

Returns:

true if the connection unique-id exists

Throws:

CoreException - wrapping any other exception

getSharedConnectionIds

public java.util.Collection<java.lang.String> getSharedConnectionIds()
                                                              throws CoreException

Description copied from interface: AdapterManagerMBean

Get all the connection unique-ids that are currently registered as a shared connection.

Specified by:

getSharedConnectionIds in interface AdapterManagerMBean

Returns:

collection of connectionIds

Throws:

CoreException - wrapping any other exception

addSharedService

public boolean addSharedService(java.lang.String xmlString)
                         throws CoreException,
                                java.lang.IllegalStateException,
                                java.lang.IllegalArgumentException

Description copied from interface: AdapterManagerMBean

Add a Service to the adapter's shared components.

Specified by:

addSharedService in interface AdapterManagerMBean

Parameters:

xmlString - the string representation of the service.

Returns:

true if the service was added, false if the service unique-id already exists in the list.

Throws:

CoreException - wrapping any other exception

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

java.lang.IllegalArgumentException - if the connection does not have an unique-id

addAndBindSharedService

public boolean addAndBindSharedService(java.lang.String xmlString)
                                throws CoreException,
                                       java.lang.IllegalStateException,
                                       java.lang.IllegalArgumentException

Description copied from interface: AdapterManagerMBean

Add an 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 AdapterManagerMBean.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.

Specified by:

addAndBindSharedService in interface AdapterManagerMBean

Parameters:

xmlString - the string representation of the service.

Returns:

true if the service was added, false if the service unique-id already exists in the list.

Throws:

CoreException - wrapping any other exception

java.lang.IllegalStateException - if the state of the adapter is actually closed, in which case you should use AdapterManagerMBean.addSharedConnection(String) instead..

java.lang.IllegalArgumentException - if the connection does not have an unique-id

removeSharedService

public boolean removeSharedService(java.lang.String serviceId)
                            throws CoreException,
                                   java.lang.IllegalStateException

Description copied from interface: AdapterManagerMBean

Remove a service from the adapter's shared components.

Specified by:

removeSharedService in interface AdapterManagerMBean

Parameters:

serviceId - the shared service unique-id to remove.

Returns:

true if the service was removed, false otherwise.

Throws:

CoreException - wrapping any other exception

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

containsSharedService

public boolean containsSharedService(java.lang.String serviceId)
                              throws CoreException

Description copied from interface: AdapterManagerMBean

Check if the associated serviceId is already present in the shared services.

Specified by:

containsSharedService in interface AdapterManagerMBean

Parameters:

serviceId - the shared service unique-id to remove.

Returns:

true if the connection unique-id exists

Throws:

CoreException - wrapping any other exception

getSharedServiceIds

public java.util.Collection<java.lang.String> getSharedServiceIds()
                                                           throws CoreException

Description copied from interface: AdapterManagerMBean

Get all the service unique-ids that are currently registered as a shared service.

Specified by:

getSharedServiceIds in interface AdapterManagerMBean

Returns:

collection of service-ids

Throws:

CoreException - wrapping any other exception

removeSharedComponent

public boolean removeSharedComponent(java.lang.String id)
                              throws CoreException,
                                     java.lang.IllegalStateException

Description copied from interface: AdapterManagerMBean

Convenience method to do both AdapterManagerMBean.removeSharedService(String) and #removeSharedConnection(String) at once.

Specified by:

removeSharedComponent in interface AdapterManagerMBean

Parameters:

id - the shared id to remove.

Returns:

true if something was removed; false otherwise.

Throws:

CoreException - wrapping any other exception

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

addChannel

public javax.management.ObjectName addChannel(java.lang.String xml)
                                       throws CoreException,
                                              javax.management.MalformedObjectNameException

Description copied from interface: AdapterManagerMBean

Add a Channel to this adapter.

Specified by:

addChannel in interface AdapterManagerMBean

Parameters:

xml - the string representation of the channel.

Returns:

the ObjectName reference to the newly created ChannelManagerMBean.

Throws:

CoreException - wrapping any exception

javax.management.MalformedObjectNameException - upon ObjectName errors.

removeChannel

public boolean removeChannel(java.lang.String id)
                      throws CoreException,
                             javax.management.MalformedObjectNameException

Description copied from interface: AdapterManagerMBean

Remove a Channel from this adapter.

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

Specified by:

removeChannel in interface AdapterManagerMBean

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

javax.management.MalformedObjectNameException - upon ObjectName errors.

setMessageErrorHandler

public void setMessageErrorHandler(java.lang.String xml)
                            throws CoreException

Description copied from interface: AdapterManagerMBean

Set the ProcessingExceptionHandler for this adapter.

Specified by:

setMessageErrorHandler in interface AdapterManagerMBean

Parameters:

xml - the string representation of the error handler.

Throws:

CoreException - wrapping any exception

setFailedMessageRetrier

public void setFailedMessageRetrier(java.lang.String xml)
                             throws CoreException

Description copied from interface: AdapterManagerMBean

Set the FailedMessageRetrier for this adapter.

Specified by:

setFailedMessageRetrier in interface AdapterManagerMBean

Parameters:

xml - the string representation of the error handler.

Throws:

CoreException - wrapping any exception

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()

childUpdated

public void childUpdated()
                  throws CoreException

Description copied from interface: ParentComponent

Notifies a parent that a child component has been updated.

Specified by:

childUpdated in interface ParentComponent<ChannelRuntimeManager>

Throws:

CoreException

getAdapterBuildVersion

public java.lang.String getAdapterBuildVersion()

Description copied from interface: AdapterManagerMBean

Get the adapter build version.

Specified by:

getAdapterBuildVersion in interface AdapterManagerMBean

Returns:

the adapter build version.

getModuleVersions

public java.util.List<java.lang.String> getModuleVersions()

Description copied from interface: AdapterManagerMBean

Get a list of all the modules currently installed for this adapter.

Specified by:

getModuleVersions in interface AdapterManagerMBean

Returns:

list of modules + version numbers.

getArtifactIdentifiers

public java.util.List<java.lang.String> getArtifactIdentifiers()

Description copied from interface: AdapterManagerMBean

Get a list of all the modules currently installed for this adapter.

Specified by:

getArtifactIdentifiers in interface AdapterManagerMBean

Returns:

list of groupId:artifactId:version.

sendLifecycleEvent

public void sendLifecycleEvent(AdapterLifecycleEvent event)
                        throws CoreException

Description copied from interface: AdapterManagerMBean

Send an AdapterLifecycleEvent to any configured event handlers.

Specified by:

sendLifecycleEvent in interface AdapterManagerMBean

Parameters:

event - the AdapterLifecycleEvent to send.

Throws:

CoreException - wrapping any exception

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<Adapter>

forceClose

public void forceClose()
                throws CoreException

Description copied from interface: AdapterManagerMBean

Forcibly close the associated adapter.

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.

Specified by:

forceClose in interface AdapterManagerMBean

Throws:

CoreException