Package org.frankframework.core

Interface IAdapter

All Superinterfaces:

org.springframework.context.ApplicationContextAware, org.springframework.beans.factory.Aware, HasStatistics, IConfigurable, IConfigurationAware, IManagable, INamedObject, IScopeProvider

All Known Implementing Classes:

Adapter

public interface IAdapter
extends IManagable, HasStatistics

The Adapter is the central manager in the framework. It has knowledge of both IReceivers as well as the PipeLine and statistics. The Adapter is the class that is responsible for configuring, initializing and accessing/activating IReceivers, Pipelines, statistics etc.

Method Summary

Modifier and Type	Method	Description
void	configure()	Instruct the adapter to configure itself.
Message	formatErrorMessage(String errorMessage, Throwable t, Message originalMessage, String messageID, INamedObject objectInError, long receivedTime)
Configuration	getConfiguration()
String	getDescription()
MessageKeeper	getMessageKeeper()	The messagekeeper is used to keep the last x messages, relevant to display in the web-functions.
PipeLine	getPipeLine()
Receiver<?>	getReceiverByName(String receiverName)
Iterable<Receiver<?>>	getReceivers()
boolean	isAutoStart()
PipeLineResult	processMessage(String messageId, Message message, PipeLineSession pipeLineSession)
PipeLineResult	processMessageWithExceptions(String messageId, Message message, PipeLineSession pipeLineSession)
void	setConfiguration(Configuration configuration)
void	setPipeLine(PipeLine pipeline)

Methods inherited from interface org.springframework.context.ApplicationContextAware

setApplicationContext

Methods inherited from interface org.frankframework.statistics.HasStatistics

getAdapter

Methods inherited from interface org.frankframework.core.IConfigurationAware

getApplicationContext, getName

Methods inherited from interface org.frankframework.core.IManagable

getRunState, startRunning, stopRunning

Methods inherited from interface org.frankframework.core.INamedObject

getName, setName

Methods inherited from interface org.frankframework.core.IScopeProvider

getConfigurationClassLoader

Method Details

configure

void configure()
        throws ConfigurationException

Instruct the adapter to configure itself. The adapter will call the pipeline to configure itself, the pipeline will call the individual pipes to configure themselves.

Specified by:

configure in interface IConfigurable

Throws:

ConfigurationException

See Also:

• AbstractPipe.configure()
• PipeLine.configure()

getMessageKeeper

MessageKeeper getMessageKeeper()

The messagekeeper is used to keep the last x messages, relevant to display in the web-functions.

getReceiverByName

Receiver<?> getReceiverByName(String receiverName)

getReceivers

Iterable<Receiver<?>> getReceivers()

processMessage

PipeLineResult processMessage(String messageId,
 Message message,
 PipeLineSession pipeLineSession)

processMessageWithExceptions

PipeLineResult processMessageWithExceptions(String messageId,
 Message message,
 PipeLineSession pipeLineSession)
                                     throws ListenerException

Throws:

ListenerException

setPipeLine

void setPipeLine(PipeLine pipeline)
          throws ConfigurationException

Throws:

ConfigurationException

getPipeLine

PipeLine getPipeLine()

setConfiguration

void setConfiguration(Configuration configuration)

getConfiguration

Configuration getConfiguration()

isAutoStart

boolean isAutoStart()

formatErrorMessage

Message formatErrorMessage(String errorMessage,
 Throwable t,
 Message originalMessage,
 String messageID,
 INamedObject objectInError,
 long receivedTime)

getDescription

@JmxAttribute(description="Return the Adapter description")
String getDescription()