Channel (Base Interlok)

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

All Implemented Interfaces:

AdaptrisComponent, ComponentLifecycle, ComponentLifecycleExtension, ConfigComment, EventHandlerAware, StateManagedComponent, StateManagedComponentContainer
```
@ComponentProfile(summary="Channels bind two connections together for workflows to do their work",
                  tag="base")
public class Channel
extends java.lang.Object
implements ComponentLifecycleExtension, StateManagedComponentContainer, EventHandlerAware, ConfigComment
```
Links two AdaptrisConnection implementations and has a WorkflowList

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

Field Summary

Fields
Modifier and Type	Field and Description
`protected EventHandler`	`eventHandler`
`protected org.slf4j.Logger`	`log`
`protected java.util.Date`	`startTime`
`protected java.util.Date`	`stopTime`

Constructor Summary

Constructors
Constructor and Description

Channel()
Creates a new instance.

Channel(java.lang.String uid)

Constructors
Constructor and Description
`Channel()` Creates a new instance.
`Channel(java.lang.String uid)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`changeState(ComponentState s)` Updates the state for the component `ComponentState`.
`void`	`close()` Closes the component.
`java.lang.Boolean`	`getAutoStart()`
`java.lang.String`	`getComments()`
`AdaptrisConnection`	`getConsumeConnection()` Returns the `AdaptrisConnection` used for consuming.
`ProcessingExceptionHandler`	`getMessageErrorHandler()` Returns the `MessageErrorHandler` to use.
`AdaptrisConnection`	`getProduceConnection()` Returns the `AdaptrisConnection` used for producing.
`java.lang.String`	`getUniqueId()` Get the unique id of this channel.
`WorkflowList`	`getWorkflowList()` Returns the `WorkflowList` to use.
`boolean`	`hasUniqueId()` Check if this channel has a unique Id.
`void`	`init()` Initialises the component.
`boolean`	`isAvailable()` Returns `true` if this `Channel` is available.
`java.util.Date`	`lastStartTime()` Get the last time this channel was started
`java.util.Date`	`lastStopTime()` Get the last time this channel was stopped.
`void`	`prepare()` Prepare for initialisation.
`void`	`registerActiveMsgErrorHandler(ProcessingExceptionHandler m)` Register the active `MessageErrorHandler` for this Channel.
`void`	`registerEventHandler(EventHandler eh)` Register the current event handler against this component.
`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.
`ProcessingExceptionHandler`	`retrieveActiveMsgErrorHandler()` Return the active `MessageErrorHandler` for this Channel.
`ComponentState`	`retrieveComponentState()` This method is not `synchronized` and returns the 'last recorded' state of this object.
`void`	`setAutoStart(java.lang.Boolean autoStart)` Specify whether or not to auto-start the channel.
`void`	`setComments(java.lang.String s)`
`void`	`setConsumeConnection(AdaptrisConnection connection)` Sets the `AdaptrisConnection` to use for consuming.
`void`	`setMessageErrorHandler(ProcessingExceptionHandler errorHandler)` Sets the `MessageErrorHandler` to use.
`void`	`setProduceConnection(AdaptrisConnection connection)` Sets the `AdaptrisConnection` to use for producing.
`void`	`setUniqueId(java.lang.String string)` Set the unique id of this channel.
`void`	`setWorkflowList(WorkflowList workflows)` Sets the `WorkflowList` to use.
`boolean`	`shouldStart()`
`void`	`start()` Starts the component.
`void`	`stop()` Stop the component
`void`	`toggleAvailability(boolean b)` Set whether this `Channel` is available.

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
```
  - eventHandler
```
protected transient EventHandler eventHandler
```
  - startTime
```
protected transient java.util.Date startTime
```
  - stopTime
```
protected transient java.util.Date stopTime
```
- Constructor Detail
  - Channel
```
public Channel()
```
    Creates a new instance.
  - Channel
```
public Channel(java.lang.String uid)
```
- Method Detail
  - prepare
```
public void prepare()
             throws CoreException
```
    Description copied from interface: ComponentLifecycleExtension
    
    Prepare for initialisation.
    
    Specified by:
    
    prepare in interface ComponentLifecycleExtension
    
    Throws:
    
    CoreException
  - registerEventHandler
```
public void registerEventHandler(EventHandler eh)
```
    Description copied from interface: EventHandlerAware
    
    Register the current event handler against this component.
    
    Specified by:
    
    registerEventHandler in interface EventHandlerAware
    
    Parameters:
    
    eh - the event handler currently in use.
  - changeState
```
public void changeState(ComponentState s)
```
    Description copied from interface: StateManagedComponent
    
    Updates the state for the component ComponentState.
    
    Specified by:
    
    changeState in interface StateManagedComponent
  - 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
    
    See Also:
    
    ComponentLifecycle.init()
  - 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:
    
    ComponentLifecycle.stop()
  - 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:
    
    ComponentLifecycle.close()
  - setConsumeConnection
```
public void setConsumeConnection(AdaptrisConnection connection)
```
    Sets the AdaptrisConnection to use for consuming.
    
    Parameters:
    
    connection - the AdaptrisConnection to use for consuming, may not be null
  - getConsumeConnection
```
public AdaptrisConnection getConsumeConnection()
```
    Returns the AdaptrisConnection used for consuming.
    
    Returns:
    
    the AdaptrisConnection used for consuming
  - setProduceConnection
```
public void setProduceConnection(AdaptrisConnection connection)
```
    Sets the AdaptrisConnection to use for producing.
    
    Parameters:
    
    connection - the AdaptrisConnection to use for producing, may not be null
  - getProduceConnection
```
public AdaptrisConnection getProduceConnection()
```
    Returns the AdaptrisConnection used for producing.
    
    Returns:
    
    the AdaptrisConnection used for producing
  - setWorkflowList
```
public void setWorkflowList(WorkflowList workflows)
```
    Sets the WorkflowList to use.
    
    Parameters:
    
    workflows - the WorkflowList to use, may not be null
  - getWorkflowList
```
public WorkflowList getWorkflowList()
```
    Returns the WorkflowList to use.
    
    Returns:
    
    the WorkflowList to use
  - setMessageErrorHandler
```
public void setMessageErrorHandler(ProcessingExceptionHandler errorHandler)
```
    Sets the MessageErrorHandler to use.
    
    Parameters:
    
    errorHandler - the MessageErrorHandler to use, may not be null
  - getMessageErrorHandler
```
public ProcessingExceptionHandler getMessageErrorHandler()
```
    Returns the MessageErrorHandler to use.
    
    Returns:
    
    the MessageErrorHandler to use
  - isAvailable
```
public boolean isAvailable()
```
    Returns true if this Channel is available. A Channel is available if i) it is not in the process of being rebooted or ii) it has not failed to reboot.
    
    Returns:
    
    true if this Channel is available
  - toggleAvailability
```
public void toggleAvailability(boolean b)
```
    Set whether this Channel is available.
    
    Parameters:
    
    b - whether this Channel is available
  - registerActiveMsgErrorHandler
```
public void registerActiveMsgErrorHandler(ProcessingExceptionHandler m)
```
    Register the active MessageErrorHandler for this Channel.
    
    Parameters:
    
    m - the active MessageErrorHandler
  - retrieveActiveMsgErrorHandler
```
public ProcessingExceptionHandler retrieveActiveMsgErrorHandler()
```
    Return the active MessageErrorHandler for this Channel.
    
    Returns:
    
    the active MessageErrorHandler
  - getUniqueId
```
public java.lang.String getUniqueId()
```
    Get the unique id of this channel.
    
    Specified by:
    
    getUniqueId in interface AdaptrisComponent
    
    Returns:
    
    the unique id
  - setUniqueId
```
public void setUniqueId(java.lang.String string)
```
    Set the unique id of this channel. The channel's unique id allows it to be individually controlled, either by an event or by the Adapter container.
    
    Parameters:
    
    string - the unique id
  - hasUniqueId
```
public boolean hasUniqueId()
```
    Check if this channel has a unique Id.
    
    Returns:
    
    true if the unique id is non-null and non- empty
  - 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()
```
    This method is not synchronized and returns the 'last recorded' state of this object.
    
    Specified by:
    
    retrieveComponentState in interface StateManagedComponent
    
    Returns:
    
    the current ComponentState
    
    See Also:
    
    StateManagedComponent.retrieveComponentState()
  - 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
    
    See Also:
    
    StateManagedComponentContainer.requestChildInit()
  - 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
    
    See Also:
    
    StateManagedComponentContainer.requestChildStart()
  - requestChildStop
```
public void requestChildStop()
```
    Description copied from interface: StateManagedComponentContainer
    
    Stop any independent sub components.
    
    Specified by:
    
    requestChildStop in interface StateManagedComponentContainer
    
    See Also:
    
    StateManagedComponentContainer.requestChildStop()
  - requestChildClose
```
public void requestChildClose()
```
    Description copied from interface: StateManagedComponentContainer
    
    Close any independent sub components.
    
    Specified by:
    
    requestChildClose in interface StateManagedComponentContainer
    
    See Also:
    
    StateManagedComponentContainer.requestChildClose()
  - getAutoStart
```
public java.lang.Boolean getAutoStart()
```
  - setAutoStart
```
public void setAutoStart(java.lang.Boolean autoStart)
```
    Specify whether or not to auto-start the channel.
    If auto-start is set to false, then this channel is not started. This behaviour only occurs if the channel has a non-null/empty unique-id as otherwise you will not be able to start the channel through the standard JMX controls
    
    Parameters:
    
    autoStart - default is true.
  - shouldStart
```
public boolean shouldStart()
```
  - lastStartTime
```
public java.util.Date lastStartTime()
```
    Get the last time this channel was started
    
    Returns:
    
    channel start time
  - lastStopTime
```
public java.util.Date lastStopTime()
```
    Get the last time this channel was stopped. This is set when the channel is initialised so it may have been subsequently started.
    
    Returns:
    
    channel stop time
  - setComments
```
public void setComments(java.lang.String s)
```
    Specified by:
    
    setComments in interface ConfigComment
  - getComments
```
public java.lang.String getComments()
```
    Specified by:
    
    getComments in interface ConfigComment

Class Channel

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

log

eventHandler

startTime

stopTime

Constructor Detail

Channel

Channel

Method Detail

prepare

registerEventHandler

changeState

init

start

stop

close

setConsumeConnection

getConsumeConnection

setProduceConnection

getProduceConnection

setWorkflowList

getWorkflowList

setMessageErrorHandler

getMessageErrorHandler

isAvailable

toggleAvailability

registerActiveMsgErrorHandler

retrieveActiveMsgErrorHandler

getUniqueId

setUniqueId

hasUniqueId

requestInit

requestStart

requestStop

requestClose

retrieveComponentState

requestChildInit

requestChildStart

requestChildStop

requestChildClose

getAutoStart

setAutoStart

shouldStart

lastStartTime

lastStopTime

setComments

getComments