com.adaptris.core

Class SharedConnection

java.lang.Object

com.adaptris.core.SharedComponent

com.adaptris.core.SharedConnection

All Implemented Interfaces:

AdaptrisComponent, AdaptrisConnection, ComponentLifecycle, ComponentLifecycleExtension, JndiBindable, StateManagedComponent

@ComponentProfile(summary="A Connection that refers to another connection configured elsewhere",
                  tag="connections,base")
public class SharedConnection
extends SharedComponent
implements AdaptrisConnection

A connection instance that references a connection made available via SharedComponentList.

In the adapter configuration file this class is aliased as shared-connection which is the preferred alternative to the fully qualified classname when building your configuration.

Constructor Summary

Constructors

Constructor and Description
SharedConnection()
SharedConnection(java.lang.String lookupName)

Method Summary

Modifier and Type	Method and Description
void	addExceptionListener(StateManagedComponent comp) 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 newState) Updates the state for the component ComponentState.
AdaptrisConnection	cloneForTesting() Make a copy of this object for test purposes.
void	close() Closes the component.
ConnectionErrorHandler	connectionErrorHandler() Returns the currently active ConnectionErrorHandler
ConnectionErrorHandler	getConnectionErrorHandler() Returns the configured ConnectionErrorHandler.
java.lang.String	getLookupName() Returns the exact name to bind this object to our Context.
java.lang.String	getUniqueId() Get the unique-id that is associated with this component.
void	init() Initialises the component.
void	prepare() Prepare for initialisation.
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	setLookupName(java.lang.String jndiName) Set the unique-id of the connection that we will lookup.
void	start() Starts the component.
void	stop() Stop the component

Methods inherited from class com.adaptris.core.SharedComponent

triggerJndiLookup

Methods inherited from class java.lang.Object

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

Constructor Detail

SharedConnection

public SharedConnection()

SharedConnection

public SharedConnection(java.lang.String lookupName)

Method Detail

init

public 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

start

public 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

stop

public 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

close

public 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

changeState

public void changeState(ComponentState newState)

Description copied from interface: StateManagedComponent

Updates the state for the component ComponentState.

Specified by:

changeState in interface StateManagedComponent

retrieveComponentState

public ComponentState retrieveComponentState()

Description copied from interface: StateManagedComponent

Returns the last recorde ComponentState.

Specified by:

retrieveComponentState in interface StateManagedComponent

Returns:

the current ComponentState

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

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

requestStop

public void requestStop()

Description copied from interface: StateManagedComponent

Request this component is stopped.

Specified by:

requestStop in interface StateManagedComponent

requestClose

public void requestClose()

Description copied from interface: StateManagedComponent

Request this component is closed.

Specified by:

requestClose in interface StateManagedComponent

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

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

addExceptionListener

public void addExceptionListener(StateManagedComponent comp)

Description copied from interface: AdaptrisConnection

Add a component that will be notified upon exception.

Specified by:

addExceptionListener in interface AdaptrisConnection

Parameters:

comp - the component that will be notified.

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

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

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

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

setConnectionErrorHandler

public void setConnectionErrorHandler(ConnectionErrorHandler handler)

Description copied from interface: AdaptrisConnection

Sets the ConnectionErrorHandler to use.

Specified by:

setConnectionErrorHandler in interface AdaptrisConnection

getConnectionErrorHandler

public ConnectionErrorHandler getConnectionErrorHandler()

Description copied from interface: AdaptrisConnection

Returns the configured ConnectionErrorHandler.

Specified by:

getConnectionErrorHandler in interface AdaptrisConnection

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

retrieveConnection

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

Description copied from interface: AdaptrisConnection

Return the connection as represented by this connection

Specified by:

retrieveConnection in interface AdaptrisConnection

Parameters:

type - the type of connection

Returns:

the connection

getLookupName

public java.lang.String getLookupName()

Description copied from interface: JndiBindable

Returns the exact name to bind this object to our Context.

Specifying a lookupName will not be modified at all when binding to jndi. Therefore you may want to prepend your own chosen subcontexts in this name e.g. "comp/env/"

Specified by:

getLookupName in interface JndiBindable

Returns:

the lookup name.

setLookupName

public void setLookupName(java.lang.String jndiName)

Set the unique-id of the connection that we will lookup.

Parameters:

jndiName - the name

prepare

public void prepare()
             throws CoreException

Description copied from interface: ComponentLifecycleExtension

Prepare for initialisation.

Specified by:

prepare in interface ComponentLifecycleExtension

Throws:

CoreException

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