com.adaptris.core.runtime

Class ComponentManagerImpl<E extends StateManagedComponent>

java.lang.Object

javax.management.NotificationBroadcasterSupport

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

All Implemented Interfaces:

AdapterComponentMBean, AdapterRuntimeComponent<E>, BaseComponentMBean, javax.management.NotificationBroadcaster, javax.management.NotificationEmitter

Direct Known Subclasses:

AdapterManager, ChannelManager, WorkflowManager

public abstract class ComponentManagerImpl<E extends StateManagedComponent>
extends javax.management.NotificationBroadcasterSupport
implements AdapterRuntimeComponent<E>

Base class for all component managers.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	ComponentManagerImpl.ComponentNotificationType

Field Summary

Fields

Modifier and Type	Field and Description
protected org.slf4j.Logger	log

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

Method Summary

Modifier and Type	Method and Description
protected java.lang.String	asXml(java.lang.Object o) Marshal the object as XML.
protected abstract void	checkTransitionTo(ComponentState futureState) Check whether the transition is allowed in the context of the current component's (or parent's) state.
protected void	closeQuietly(AdaptrisComponent c)
protected javax.management.Notification	createLifecycleNotification(java.lang.String message, javax.management.ObjectName objectName)
protected void	ensureState(ComponentState... states)
ComponentState	getComponentState() Get the state of this managed runtime component.
java.lang.String	getConfiguration() Get a marshalled copy of the configuration for this item.
protected abstract java.lang.String	getNotificationType(ComponentManagerImpl.ComponentNotificationType type)
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.
protected void	marshalAndSendNotification() Store the XML representation of the object and send a config-update notification.
protected void	marshalConfig() Store the XML representation of the object.
protected void	registerSelf() Convenience method to handle BaseComponentMBean.registerMBean()
void	requestClose() Close this component.
void	requestClose(long timeout) Close this component.
void	requestInit() Initialise this component.
void	requestInit(long timeout) Initialise this component.
void	requestRestart() Restart this channel.
void	requestRestart(long timeout) Restart this component.
void	requestStart() Start this component.
void	requestStart(long timeout) Start this component.
void	requestStop() stop this component.
void	requestStop(long timeout) Stop this component.
protected void	sendConfigUpdateNotification()
protected void	unregisterSelf() Convenience method to handle BaseComponentMBean.unregisterMBean()

Methods inherited from class javax.management.NotificationBroadcasterSupport

addNotificationListener, getNotificationInfo, handleNotification, removeNotificationListener, removeNotificationListener, sendNotification

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

getAllDescendants, getWrappedComponent

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

requestStartTime, requestStopTime

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

createObjectName, registerMBean, unregisterMBean

Field Detail

log

protected transient org.slf4j.Logger log

Constructor Detail

ComponentManagerImpl

public ComponentManagerImpl()

Method Detail

checkTransitionTo

protected abstract void checkTransitionTo(ComponentState futureState)
                                   throws CoreException,
                                          java.lang.IllegalArgumentException

Check whether the transition is allowed in the context of the current component's (or parent's) state.

Parameters:

futureState - the state we want to transition to.

Throws:

CoreException - if the state transition check fails.

java.lang.IllegalArgumentException - - if the futureState could not be handled.

getUniqueId

public java.lang.String getUniqueId()

Description copied from interface: AdapterComponentMBean

Get the name of this runtime component.

Specified by:

getUniqueId in interface AdapterComponentMBean

Returns:

the name of this component which is generally semantically equivalent to the corresponding Workflow.getUniqueId() or Channel.getUniqueId()

getComponentState

public ComponentState getComponentState()

Description copied from interface: AdapterComponentMBean

Get the state of this managed runtime component.

Specified by:

getComponentState in interface AdapterComponentMBean

Returns:

the component state

requestInit

public void requestInit()
                 throws CoreException

Description copied from interface: AdapterComponentMBean

Initialise this component.

Specified by:

requestInit in interface AdapterComponentMBean

Throws:

CoreException - wrapping any underlying Exception

requestInit

public void requestInit(long timeout)
                 throws CoreException,
                        java.util.concurrent.TimeoutException

Description copied from interface: AdapterComponentMBean

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.

Specified by:

requestInit in interface AdapterComponentMBean

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.

requestStart

public void requestStart()
                  throws CoreException

Description copied from interface: AdapterComponentMBean

Start this component.

Specified by:

requestStart in interface AdapterComponentMBean

Throws:

CoreException - wrapping any underlying Exception

requestStart

public void requestStart(long timeout)
                  throws CoreException,
                         java.util.concurrent.TimeoutException

Description copied from interface: AdapterComponentMBean

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.

Specified by:

requestStart in interface AdapterComponentMBean

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.

requestStop

public void requestStop()
                 throws CoreException

Description copied from interface: AdapterComponentMBean

stop this component.

Specified by:

requestStop in interface AdapterComponentMBean

Throws:

CoreException - wrapping any underlying Exception

requestStop

public void requestStop(long timeout)
                 throws CoreException,
                        java.util.concurrent.TimeoutException

Description copied from interface: AdapterComponentMBean

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.

Specified by:

requestStop in interface AdapterComponentMBean

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

public void requestClose()
                  throws CoreException

Description copied from interface: AdapterComponentMBean

Close this component.

Specified by:

requestClose in interface AdapterComponentMBean

Throws:

CoreException - wrapping any underlying Exception

requestClose

public void requestClose(long timeout)
                  throws CoreException,
                         java.util.concurrent.TimeoutException

Description copied from interface: AdapterComponentMBean

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.

Specified by:

requestClose in interface AdapterComponentMBean

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.

requestRestart

public void requestRestart()
                    throws CoreException

Description copied from interface: AdapterComponentMBean

Restart this channel.

This is semantically equivalent to calling AdapterComponentMBean.requestClose() and AdapterComponentMBean.requestStart()

Specified by:

requestRestart in interface AdapterComponentMBean

Throws:

CoreException - wrapping any underlying Exception

requestRestart

public void requestRestart(long timeout)
                    throws CoreException,
                           java.util.concurrent.TimeoutException

Description copied from interface: AdapterComponentMBean

Restart this component.

This just invokes AdapterComponentMBean.requestClose(long) and AdapterComponentMBean.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.

Specified by:

requestRestart in interface AdapterComponentMBean

Parameters:

timeout - the max timeout to pass into AdapterComponentMBean.requestClose(long) and AdapterComponentMBean.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.

asXml

protected java.lang.String asXml(java.lang.Object o)
                          throws CoreException

Marshal the object as XML.

Throws:

CoreException

getConfiguration

public java.lang.String getConfiguration()
                                  throws CoreException

Description copied from interface: AdapterComponentMBean

Get a marshalled copy of the configuration for this item.

Specified by:

getConfiguration in interface AdapterComponentMBean

Returns:

a string representation of the config for this item.

Throws:

CoreException - wrapping any underlying Exception

See Also:

DefaultMarshaller.getDefaultMarshaller()

getWrappedComponentClassname

public java.lang.String getWrappedComponentClassname()

Description copied from interface: AdapterRuntimeComponent

Get the class name that is wrapped by this MBean.

Specified by:

getWrappedComponentClassname in interface AdapterComponentMBean

Specified by:

getWrappedComponentClassname in interface AdapterRuntimeComponent<E extends StateManagedComponent>

Returns:

the class name (e.g. com.adaptris.core.StandardWorkflow)

marshalConfig

protected void marshalConfig()
                      throws CoreException

Store the XML representation of the object.

Note that this does not send any notifications, and is only intended for use upon first initialisation; you should probably use marshalAndSendNotification() if the config has been updated at runtime.

Throws:

CoreException

marshalAndSendNotification

protected void marshalAndSendNotification()
                                   throws CoreException

Store the XML representation of the object and send a config-update notification.

Throws:

CoreException

unregisterSelf

protected void unregisterSelf()
                       throws CoreException

Convenience method to handle BaseComponentMBean.unregisterMBean()

Throws:

CoreException

registerSelf

protected void registerSelf()
                     throws CoreException

Convenience method to handle BaseComponentMBean.registerMBean()

Throws:

CoreException

ensureState

protected void ensureState(ComponentState... states)

createLifecycleNotification

protected javax.management.Notification createLifecycleNotification(java.lang.String message,
                                                                    javax.management.ObjectName objectName)

sendConfigUpdateNotification

protected void sendConfigUpdateNotification()

getNotificationType

protected abstract java.lang.String getNotificationType(ComponentManagerImpl.ComponentNotificationType type)

closeQuietly

protected void closeQuietly(AdaptrisComponent c)