com.adaptris.core

Class AdaptrisConnectionImp

java.lang.Object

com.adaptris.core.AdaptrisConnectionImp

All Implemented Interfaces:

AdaptrisComponent, AdaptrisConnection, ComponentLifecycle, ComponentLifecycleExtension, StateManagedComponent

Direct Known Subclasses:

AllowsRetriesConnection, CacheConnection, EmbeddedConnection, JettyConnection, NoOpConnection

public abstract class AdaptrisConnectionImp
extends java.lang.Object
implements AdaptrisConnection, StateManagedComponent

Contains behaviour common to implementations of AdaptrisConnection.

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
AdaptrisConnectionImp() Created a new instance.

Method Summary

Modifier and Type	Method and Description
void	addExceptionListener(StateManagedComponent c) Add a component that will be notified upon exception.
void	addMessageConsumer(AdaptrisMessageConsumer consumer) Adds a AdaptrisMessageConsumer to this connection's internal store of message consumers.
void	addMessageProducer(AdaptrisMessageProducer producer) Adds a AdaptrisMessageProducer to this connection's internal store of message producers.
void	changeState(ComponentState s) Updates the state for the component ComponentState.
AdaptrisConnection	cloneForTesting() Make a copy of this object for test purposes.
void	close() Closes the component.
protected abstract void	closeConnection() Close the underlying connection.
ConnectionErrorHandler	connectionErrorHandler() Returns the currently active ConnectionErrorHandler
ConnectionErrorHandler	getConnectionErrorHandler() Returns the configured ConnectionErrorHandler.
java.lang.String	getUniqueId() Get the unique-id that is associated with this component.
java.lang.Boolean	getWorkersFirstOnShutdown()
void	init() Initialises the component.
protected abstract void	initConnection() Initialise the underlying connection.
void	prepare() Prepare for initialisation.
protected abstract void	prepareConnection()
void	requestClose() Request this component is closed.
void	requestInit() Request this component is init'd.
void	requestStart() Request this component is started.
void	requestStop() Request this component is stopped.
ComponentState	retrieveComponentState() Returns the last recorde ComponentState.
<T> T	retrieveConnection(java.lang.Class<T> type) Return the connection as represented by this connection
java.util.Set<StateManagedComponent>	retrieveExceptionListeners() Return a collection of components that need to be restarted on exception.
java.util.Set<AdaptrisMessageConsumer>	retrieveMessageConsumers() Returns a List of this connection's AdaptrisMessageConsumers.
java.util.Set<AdaptrisMessageProducer>	retrieveMessageProducers() Returns a List of this connection's AdaptrisMessageProducers.
void	setConnectionErrorHandler(ConnectionErrorHandler handler) Sets the ConnectionErrorHandler to use.
void	setUniqueId(java.lang.String s)
void	setWorkersFirstOnShutdown(java.lang.Boolean b) Perform consumer and producer lifecycle shutdown prior to connection shutdown.
void	start() Starts the component.
protected abstract void	startConnection() Start the underlying connection.
void	stop() Stop the component
protected abstract void	stopConnection() Stop the underlying connection.
boolean	workersFirstOnShutdown()

Methods inherited from class java.lang.Object

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

Field Detail

log

protected transient org.slf4j.Logger log

Constructor Detail

AdaptrisConnectionImp

public AdaptrisConnectionImp()

Created a new instance.

Method Detail

init

public final void init()
                throws CoreException

Description copied from interface: ComponentLifecycle

Initialises the component.

Component initialisation includes config verification, creation of connections etc.

Specified by:

init in interface ComponentLifecycle

Throws:

CoreException - wrapping any underlying Exceptions

See Also:

ComponentLifecycle.init()

prepare

public final void prepare()
                   throws CoreException

Description copied from interface: ComponentLifecycleExtension

Prepare for initialisation.

Specified by:

prepare in interface ComponentLifecycleExtension

Throws:

CoreException

prepareConnection

protected abstract void prepareConnection()
                                   throws CoreException

Throws:

CoreException

start

public final void start()
                 throws CoreException

Description copied from interface: ComponentLifecycle

Starts the component.

Once a component is started it should be ready to process messages. In the case of AdaptrisMessageConsumer, calling start will begin message delivery.

Specified by:

start in interface ComponentLifecycle

Throws:

CoreException - wrapping any underlying Exceptions

See Also:

ComponentLifecycle.start()

close

public final void close()

Description copied from interface: ComponentLifecycle

Closes the component.

A closed component should release any connections it uses, etc. and clean up completely. Throwing a RuntimeException may cause unintended consequences

Specified by:

close in interface ComponentLifecycle

See Also:

ComponentLifecycle.close()

stop

public final void stop()

Description copied from interface: ComponentLifecycle

Stop the component

A stopped component is not expected to be ready to process messages. In the case of AdaptrisMessageConsumer, calling stop will pause message delivery. Throwing a RuntimeException may cause unintended consequences

Specified by:

stop in interface ComponentLifecycle

See Also:

ComponentLifecycle.stop()

initConnection

protected abstract void initConnection()
                                throws CoreException

Initialise the underlying connection.

Throws:

CoreException - wrapping any exception.

startConnection

protected abstract void startConnection()
                                 throws CoreException

Start the underlying connection.

Throws:

CoreException - wrapping any exception.

stopConnection

protected abstract void stopConnection()

Stop the underlying connection.

closeConnection

protected abstract void closeConnection()

Close the underlying connection.

addExceptionListener

public void addExceptionListener(StateManagedComponent c)

Description copied from interface: AdaptrisConnection

Add a component that will be notified upon exception.

Specified by:

addExceptionListener in interface AdaptrisConnection

Parameters:

c - the component that will be notified.

retrieveExceptionListeners

public java.util.Set<StateManagedComponent> retrieveExceptionListeners()

Description copied from interface: AdaptrisConnection

Return a collection of components that need to be restarted on exception.

Specified by:

retrieveExceptionListeners in interface AdaptrisConnection

Returns:

a list of Components that need to be restarted of any exceptions.

See Also:

ConnectionErrorHandler

addMessageProducer

public void addMessageProducer(AdaptrisMessageProducer producer)
                        throws CoreException

Description copied from interface: AdaptrisConnection

Adds a AdaptrisMessageProducer to this connection's internal store of message producers.

Specified by:

addMessageProducer in interface AdaptrisConnection

Parameters:

producer - the AdaptrisMessageProducer to add

Throws:

CoreException - wrapping any underlying Exceptions

See Also:

#addMessageProducer(com.adaptris.core.AdaptrisMessageProducer)

retrieveMessageProducers

public java.util.Set<AdaptrisMessageProducer> retrieveMessageProducers()

Description copied from interface: AdaptrisConnection

Returns a List of this connection's AdaptrisMessageProducers.

Specified by:

retrieveMessageProducers in interface AdaptrisConnection

Returns:

a List of this connection's AdaptrisMessageProducers

See Also:

AdaptrisConnection.retrieveMessageProducers()

addMessageConsumer

public void addMessageConsumer(AdaptrisMessageConsumer consumer)
                        throws CoreException

Description copied from interface: AdaptrisConnection

Adds a AdaptrisMessageConsumer to this connection's internal store of message consumers.

Specified by:

addMessageConsumer in interface AdaptrisConnection

Parameters:

consumer - the AdaptrisMessageConsumer to add

Throws:

CoreException - wrapping any underlying Exceptions

See Also:

#addMessageConsumer(com.adaptris.core.AdaptrisMessageConsumer)

retrieveMessageConsumers

public java.util.Set<AdaptrisMessageConsumer> retrieveMessageConsumers()

Description copied from interface: AdaptrisConnection

Returns a List of this connection's AdaptrisMessageConsumers.

Specified by:

retrieveMessageConsumers in interface AdaptrisConnection

Returns:

a List of this connection's AdaptrisMessageConsumers

See Also:

AdaptrisConnection.retrieveMessageConsumers()

setConnectionErrorHandler

public void setConnectionErrorHandler(ConnectionErrorHandler handler)

Description copied from interface: AdaptrisConnection

Sets the ConnectionErrorHandler to use.

Specified by:

setConnectionErrorHandler in interface AdaptrisConnection

See Also:

#setConnectionErrorHandler(com.adaptris.core.ConnectionErrorHandler)

getConnectionErrorHandler

public ConnectionErrorHandler getConnectionErrorHandler()

Description copied from interface: AdaptrisConnection

Returns the configured ConnectionErrorHandler.

Specified by:

getConnectionErrorHandler in interface AdaptrisConnection

See Also:

AdaptrisConnection.getConnectionErrorHandler()

connectionErrorHandler

public ConnectionErrorHandler connectionErrorHandler()

Description copied from interface: AdaptrisConnection

Returns the currently active ConnectionErrorHandler

Specified by:

connectionErrorHandler in interface AdaptrisConnection

Returns:

the active ConnectionErrorHandler, which may not be the same as the configured...

getWorkersFirstOnShutdown

public java.lang.Boolean getWorkersFirstOnShutdown()

Returns:

the workerLifecycleFirstOnShutdown

workersFirstOnShutdown

public boolean workersFirstOnShutdown()

Returns:

the workerLifecycleFirstOnShutdown

setWorkersFirstOnShutdown

public void setWorkersFirstOnShutdown(java.lang.Boolean b)

Perform consumer and producer lifecycle shutdown prior to connection shutdown.

When set to true, this method forces the AdaptrisConnection to stop and close any registered MessageConsumer and MessageProducer implementations before attempting to stop and close the underlying Connection. This is useful in cases where shutting down the Connection blocks until all attached workers are manually closed (WebsphereMQ)

When set to false, existing behaviour is preserved, and the consumers and producers are shutdown as part of the normal workflow lifecycle.

Parameters:

b - true to shutdown workers prior to connection shutdown, default is false.

retrieveConnection

public <T> T retrieveConnection(java.lang.Class<T> type)

Return the connection as represented by this connection

Specified by:

retrieveConnection in interface AdaptrisConnection

Parameters:

type - the type of connection

Returns:

the connection

getUniqueId

public java.lang.String getUniqueId()

Description copied from interface: AdaptrisComponent

Get the unique-id that is associated with this component.

Specified by:

getUniqueId in interface AdaptrisComponent

Returns:

the unique-id

setUniqueId

public void setUniqueId(java.lang.String s)

changeState

public void changeState(ComponentState s)

Description copied from interface: StateManagedComponent

Updates the state for the component ComponentState.

Specified by:

changeState in interface StateManagedComponent

requestInit

public void requestInit()
                 throws CoreException

Description copied from interface: StateManagedComponent

Request this component is init'd.

Specified by:

requestInit in interface StateManagedComponent

Throws:

CoreException - wrapping any underlying Exceptions

See Also:

StateManagedComponent.requestInit()

requestStart

public void requestStart()
                  throws CoreException

Description copied from interface: StateManagedComponent

Request this component is started.

Specified by:

requestStart in interface StateManagedComponent

Throws:

CoreException - wrapping any underlying Exceptions

See Also:

StateManagedComponent.requestStart()

requestStop

public void requestStop()

Description copied from interface: StateManagedComponent

Request this component is stopped.

Specified by:

requestStop in interface StateManagedComponent

See Also:

StateManagedComponent.requestStop()

requestClose

public void requestClose()

Description copied from interface: StateManagedComponent

Request this component is closed.

Specified by:

requestClose in interface StateManagedComponent

See Also:

StateManagedComponent.requestClose()

retrieveComponentState

public ComponentState retrieveComponentState()

Description copied from interface: StateManagedComponent

Returns the last recorde ComponentState.

Specified by:

retrieveComponentState in interface StateManagedComponent

Returns:

the current ComponentState

cloneForTesting

public AdaptrisConnection cloneForTesting()
                                   throws CoreException

Description copied from interface: AdaptrisConnection

Make a copy of this object for test purposes.

Specified by:

cloneForTesting in interface AdaptrisConnection

Returns:

a copy of this object

Throws:

CoreException - wrapping any exceptions