Adapter (Base Interlok)

java.lang.Object
- com.adaptris.core.Adapter

All Implemented Interfaces:

AdaptrisComponent, ComponentLifecycle, ComponentLifecycleExtension, StateManagedComponent, StateManagedComponentContainer
```
@ComponentProfile(summary="The base container for integration activity",
                  tag="base")
public final class Adapter
extends java.lang.Object
implements StateManagedComponentContainer, ComponentLifecycleExtension
```
Main class in core package. Uses other core components to consume and produce messages. Provides error and event handling capabilities. Client classes, e.g. com.adaptris.core.management.Bootstrap create and manage instances of this class.

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

Constructor Summary

Constructors
Constructor and Description

Adapter()

Constructors
Constructor and Description
`Adapter()`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`castorWorkAround()` Deprecated.
`void`	`changeState(ComponentState newState)` Updates the state for the component `ComponentState`.
`void`	`close()` Closes the component.
`ChannelList`	`getChannelList()` Returns the `ChannelList`.
`EventHandler`	`getEventHandler()` Returns the `EventHandler`.
`FailedMessageRetrier`	`getFailedMessageRetrier()` Returns the `FailedMessageRetrier` to use.
`java.lang.String`	`getHeartbeatEventImp()` Returns the class name of the heartbeat event imp to use.
`TimeInterval`	`getHeartbeatEventInterval()`
`LogHandler`	`getLogHandler()`
`MessageErrorDigester`	`getMessageErrorDigester()`
`ProcessingExceptionHandler`	`getMessageErrorHandler()` Returns the configured `MessageErrorHandler`.
`SharedComponentList`	`getSharedComponents()`
`java.lang.String`	`getStartUpEventImp()` Returns the name of the start up event class to use.
`java.lang.String`	`getUniqueId()` Returns this instances unique id.
`void`	`init()` Initialise the adapter including the `EventHandler`.
`java.util.Date`	`lastStartTime()` The last time the adapter was started
`java.util.Date`	`lastStopTime()` The last time the adapter was stopped
`LogHandler`	`logHandler()`
`void`	`prepare()` Ensures that the adapter is ready for initialisation.
`void`	`requestChildClose()` Close any independent sub components.
`void`	`requestChildInit()` Initialise any independent sub-components.
`void`	`requestChildStart()` Start any independent sub components.
`void`	`requestChildStop()` Stop any independent sub components.
`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`.
`void`	`setChannelList(ChannelList param)` Sets the `ChannelList`.
`void`	`setEventHandler(EventHandler param)` Sets the `EventHandler`.
`void`	`setFailedMessageRetrier(FailedMessageRetrier retrier)` Sets the `FailedMessageRetrier` to use.
`void`	`setHeartbeatEventImp(java.lang.String name)` Sets the class name of the heartbeat event imp to use.
`void`	`setHeartbeatEventInterval(TimeInterval interval)` Set the event between which heartbeat events are emitted.
`void`	`setLogHandler(LogHandler logHandler)`
`void`	`setMessageErrorDigester(MessageErrorDigester messageErrorDigest)`
`void`	`setMessageErrorHandler(ProcessingExceptionHandler param)` Sets the configured `ProcessingExceptionHandler` for the Adapter level.
`void`	`setSharedComponents(SharedComponentList scl)` Get the shared components that are available for injection into other managed components.
`void`	`setStartUpEventImp(java.lang.String name)` Sets the name of the start up event class to use.
`void`	`setUniqueId(java.lang.String s)` Sets this instance's unique id.
`void`	`start()` Starts the component.
`void`	`stop()` Stop the component

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Adapter
```
public Adapter()
```
- Method Detail
  - castorWorkAround
```
@Deprecated
public void castorWorkAround()
                                  throws CoreException
```
    Deprecated.
    
    Throws:
    
    CoreException
  - prepare
```
public void prepare()
             throws CoreException
```
    Ensures that the adapter is ready for initialisation.
    
    Specified by:
    
    prepare in interface ComponentLifecycleExtension
    
    Throws:
    
    CoreException - wrapping any underlying Exceptions
  - init
```
public void init()
          throws CoreException
```
    Initialise the adapter including the EventHandler. Implements method defined in AdaptrisMBean, hence public.
    
    Specified by:
    
    init in interface ComponentLifecycle
    
    Throws:
    
    CoreException - wrapping any underlying Exceptions
    
    See Also:
    
    AdaptrisComponent
  - 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
    
    See Also:
    
    ComponentLifecycle.start()
  - 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
    
    See Also:
    
    AdaptrisComponent
  - 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
    
    See Also:
    
    AdaptrisComponent
  - setChannelList
```
public void setChannelList(ChannelList param)
```
    Sets the ChannelList.
    
    Parameters:
    
    param - the ChannelList to use.
  - getChannelList
```
public ChannelList getChannelList()
```
    Returns the ChannelList.
    
    Returns:
    
    the ChannelList
  - setUniqueId
```
public void setUniqueId(java.lang.String s)
```
    Sets this instance's unique id. Unique ids are implementation-specific.
    
    Parameters:
    
    s - the unique id to set
  - getUniqueId
```
public java.lang.String getUniqueId()
```
    Returns this instances unique id.
    
    Specified by:
    
    getUniqueId in interface AdaptrisComponent
    
    Returns:
    
    this instances unique id
  - setEventHandler
```
public void setEventHandler(EventHandler param)
```
    Sets the EventHandler.
    
    Parameters:
    
    param - the EventHandler to use.
  - getEventHandler
```
public EventHandler getEventHandler()
```
    Returns the EventHandler.
    
    Returns:
    
    the EventHandler
  - setMessageErrorHandler
```
public void setMessageErrorHandler(ProcessingExceptionHandler param)
```
    Sets the configured ProcessingExceptionHandler for the Adapter level. May not be null, but need not be configured at this level.
    
    Parameters:
    
    param - the MessageErrorHandler to use
  - getMessageErrorHandler
```
public ProcessingExceptionHandler getMessageErrorHandler()
```
    Returns the configured MessageErrorHandler.
    
    Returns:
    
    the configured MessageErrorHandler
  - setStartUpEventImp
```
public void setStartUpEventImp(java.lang.String name)
```
    Sets the name of the start up event class to use. May not be null.
    
    Parameters:
    
    name - the name of the start up event class to use
  - getStartUpEventImp
```
public java.lang.String getStartUpEventImp()
```
    Returns the name of the start up event class to use.
    
    Returns:
    
    the name of the start up event class to use
  - setHeartbeatEventImp
```
public void setHeartbeatEventImp(java.lang.String name)
```
    Sets the class name of the heartbeat event imp to use.
    
    Parameters:
    
    name - the class name of the heartbeat event imp to use
  - getHeartbeatEventImp
```
public java.lang.String getHeartbeatEventImp()
```
    Returns the class name of the heartbeat event imp to use.
    
    Returns:
    
    the class name of the heartbeat event imp to use
  - setFailedMessageRetrier
```
public void setFailedMessageRetrier(FailedMessageRetrier retrier)
```
    Sets the FailedMessageRetrier to use. May not be null.
    
    Parameters:
    
    retrier - the FailedMessageRetrier to use
  - getFailedMessageRetrier
```
public FailedMessageRetrier getFailedMessageRetrier()
```
    Returns the FailedMessageRetrier to use.
    
    Returns:
    
    the FailedMessageRetrier to use
  - logHandler
```
public LogHandler logHandler()
```
  - getHeartbeatEventInterval
```
public TimeInterval getHeartbeatEventInterval()
```
  - setHeartbeatEventInterval
```
public void setHeartbeatEventInterval(TimeInterval interval)
```
    Set the event between which heartbeat events are emitted.
    
    Parameters:
    
    interval -
  - 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
  - retrieveComponentState
```
public ComponentState retrieveComponentState()
```
    Description copied from interface: StateManagedComponent
    
    Returns the last recorde ComponentState.
    
    Specified by:
    
    retrieveComponentState in interface StateManagedComponent
    
    Returns:
    
    the current ComponentState
  - changeState
```
public void changeState(ComponentState newState)
```
    Description copied from interface: StateManagedComponent
    
    Updates the state for the component ComponentState.
    
    Specified by:
    
    changeState in interface StateManagedComponent
  - requestChildInit
```
public void requestChildInit()
                      throws CoreException
```
    Description copied from interface: StateManagedComponentContainer
    
    Initialise any independent sub-components.
    
    Specified by:
    
    requestChildInit in interface StateManagedComponentContainer
    
    Throws:
    
    CoreException - wrapping any underlying Exceptions
  - requestChildStart
```
public void requestChildStart()
                       throws CoreException
```
    Description copied from interface: StateManagedComponentContainer
    
    Start any independent sub components.
    
    Specified by:
    
    requestChildStart in interface StateManagedComponentContainer
    
    Throws:
    
    CoreException - wrapping any underlying Exceptions
  - requestChildStop
```
public void requestChildStop()
```
    Description copied from interface: StateManagedComponentContainer
    
    Stop any independent sub components.
    
    Specified by:
    
    requestChildStop in interface StateManagedComponentContainer
  - requestChildClose
```
public void requestChildClose()
```
    Description copied from interface: StateManagedComponentContainer
    
    Close any independent sub components.
    
    Specified by:
    
    requestChildClose in interface StateManagedComponentContainer
  - getSharedComponents
```
public SharedComponentList getSharedComponents()
```
  - setSharedComponents
```
public void setSharedComponents(SharedComponentList scl)
```
    Get the shared components that are available for injection into other managed components.
    
    Parameters:
    
    scl - the shared components.
  - getMessageErrorDigester
```
public MessageErrorDigester getMessageErrorDigester()
```
  - setMessageErrorDigester
```
public void setMessageErrorDigester(MessageErrorDigester messageErrorDigest)
```
  - lastStartTime
```
public java.util.Date lastStartTime()
```
    The last time the adapter was started
    
    Returns:
    
    the last time the adapter was started
  - lastStopTime
```
public java.util.Date lastStopTime()
```
    The last time the adapter was stopped
    
    Returns:
    
    the last time the adapter was stopped
  - getLogHandler
```
public LogHandler getLogHandler()
```
  - setLogHandler
```
public void setLogHandler(LogHandler logHandler)
```

Class Adapter

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Adapter

Method Detail

castorWorkAround

prepare

init

start

stop

close

setChannelList

getChannelList

setUniqueId

getUniqueId

setEventHandler

getEventHandler

setMessageErrorHandler

getMessageErrorHandler

setStartUpEventImp

getStartUpEventImp

setHeartbeatEventImp

getHeartbeatEventImp

setFailedMessageRetrier

getFailedMessageRetrier

logHandler

getHeartbeatEventInterval

setHeartbeatEventInterval

requestInit

requestStart

requestStop

requestClose

retrieveComponentState

changeState

requestChildInit

requestChildStart

requestChildStop

requestChildClose

getSharedComponents

setSharedComponents

getMessageErrorDigester

setMessageErrorDigester

lastStartTime

lastStopTime

getLogHandler

setLogHandler