nl.nn.adapterframework.core

Class Adapter

java.lang.Object

nl.nn.adapterframework.core.Adapter

All Implemented Interfaces:

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

@Category(value="Basic")
public class Adapter
extends Object
implements IAdapter, org.springframework.beans.factory.NamedBean

An Adapter receives a specific type of messages and processes them. It has Receivers that receive the messages and a PipeLine that transforms the incoming messages. Each adapter is part of a Configuration.
If an adapter can receive its messages through multiple channels (e.g. RESTful HTTP requests, incoming files, etc), each channel appears as a separate Receiver nested in the adapter. Each Receiver is also responsible for dealing with the result of its received messages; the result is the output of the PipeLine. The result consists of the transformed message and a state. The Frank!Framework distinguishes between exit states SUCCESS and ERROR. There is also a state REJECTED for messages that are not accepted by the Frank!Framework and that are not processed by the PipeLine. If the exit state is ERROR, the result message may not be usable by the calling system. This can be fixed by adding an errorMessageFormatter that formats the result message if the state is ERROR.

Adapters gather statistics about the messages they process.
Adapters can process messages in parallel. They are thread-safe.

Author:

Johan Verrips

Nested Class Summary

Nested classes/interfaces inherited from interface nl.nn.adapterframework.statistics.HasStatistics

HasStatistics.Action

Field Summary

Fields

Modifier and Type	Field and Description
protected org.apache.logging.log4j.Logger	msgLog
static String	PROCESS_STATE_ERROR
static String	PROCESS_STATE_OK

Constructor Summary

Constructors

Constructor and Description
Adapter()

Method Summary

Modifier and Type	Method and Description
protected void	addErrorMessageToMessageKeeper(String msg, Throwable t) sends a warning to the log and to the messagekeeper of the adapter
boolean	configurationSucceeded()
void	configure() Instruct the adapter to configure itself.
void	configureReceiver(Receiver<?> receiver)
Message	formatErrorMessage(String errorMessage, Throwable t, Message originalMessage, String messageID, INamedObject objectInError, long receivedTime)
String	getBeanName()
long	getLastExitIsTimeoutDate(String pipeName)
String	getLastMessageDate() retrieve the date and time of the last message.
String	getLastMessageDate(String dateFormat)
Date	getLastMessageDateDate()
MessageKeeper	getMessageKeeper() the MessageKeeper is for keeping the last messageKeeperSize messages available, for instance for displaying it in the webcontrol
String	getName()
long	getNumOfMessagesInError() The number of messages for which processing ended unsuccessfully.
int	getNumOfMessagesInProcess()
long	getNumOfMessagesProcessed() Total of messages processed
long[]	getNumOfMessagesStartProcessingByHour()
PipeLine	getPipeLine()
Receiver<?>	getReceiverByName(String receiverName)
Receiver<?>	getReceiverByNameAndListener(String receiverName, Class<?> listenerClass)
Iterable<Receiver<?>>	getReceivers()
RunState	getRunState() returns the runstate of the object.
String	getRunStateAsString()
StatisticsKeeper	getStatsMessageProcessingDuration() Return the total processing duration as a StatisticsKeeper
String	getStatsUpSince() return the date and time since active Creation date: (19-02-2003 12:16:53)
String	getStatsUpSince(String dateFormat)
Date	getStatsUpSinceDate()
void	iterateOverStatistics(StatisticsKeeperIterationHandler hski, Object data, HasStatistics.Action action)
void	logToMessageLogWithMessageContentsOrSize(org.apache.logging.log4j.Level level, String logMessage, String dataPrefix, Message data)
PipeLineResult	processMessage(String messageId, Message message, PipeLineSession pipeLineSession)
PipeLineResult	processMessageWithExceptions(String messageId, Message message, PipeLineSession pipeLineSession)
void	registerReceiver(Receiver<?> receiver) Receives incoming messages.
void	setAutoStart(boolean autoStart) AutoStart indicates that the adapter should be started when the configuration is started.
void	setConfiguration(Configuration configuration) the configuration this adapter belongs to
void	setDescription(String description) some functional description of the Adapter
void	setErrorMessageFormatter(IErrorMessageFormatter errorMessageFormatter) Formatter for errors that can occur in this adapter.
void	setLastExitState(String pipeName, long lastExitStateDate, String lastExitState)
void	setMessageKeeperSize(int size) number of message displayed in ibisconsole
void	setMsgLogHidden(boolean b) If set to true, the length of the message is shown in the msg log instead of the content of the message
void	setMsgLogLevel(nl.nn.adapterframework.core.Adapter.MessageLogLevel level) Defines behaviour for logging messages.
void	setName(String name) name of the adapter
void	setPipeLine(PipeLine pipeline) The PipeLine.
void	setReplaceNullMessage(boolean b) If true a null message is replaced by an empty message
void	setRequestReplyLogging(boolean requestReplyLogging) Deprecated.
void	setTargetDesignDocument(String string)
void	startRunning() Start the adapter.
void	stopRunning() Stop the Adapter and close all elements like receivers, Pipeline, pipes etc.
String	toString()
void	waitForNoMessagesInProcess()
protected void	warn(String msg) sends a warning to the log and to the messagekeeper of the adapter

Methods inherited from class java.lang.Object

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

Methods inherited from interface nl.nn.adapterframework.core.IAdapter

getConfiguration, getDescription, isAutoStart

Methods inherited from interface nl.nn.adapterframework.core.IConfigurationAware

getApplicationContext

Methods inherited from interface nl.nn.adapterframework.core.IScopeProvider

getConfigurationClassLoader

Methods inherited from interface org.springframework.context.ApplicationContextAware

setApplicationContext

Field Detail

msgLog

protected org.apache.logging.log4j.Logger msgLog

PROCESS_STATE_OK

public static final String PROCESS_STATE_OK

See Also:

Constant Field Values

PROCESS_STATE_ERROR

public static final String PROCESS_STATE_ERROR

See Also:

Constant Field Values

Constructor Detail

Adapter

public Adapter()

Method Detail

configure

public void configure()
               throws ConfigurationException

Description copied from interface: IAdapter

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 IAdapter

Specified by:

configure in interface IConfigurable

Throws:

ConfigurationException

See Also:

AbstractPipe.configure(), PipeLine.configure()

configureReceiver

public void configureReceiver(Receiver<?> receiver)
                       throws ConfigurationException

Throws:

ConfigurationException

configurationSucceeded

public boolean configurationSucceeded()

warn

protected void warn(String msg)

sends a warning to the log and to the messagekeeper of the adapter

addErrorMessageToMessageKeeper

protected void addErrorMessageToMessageKeeper(String msg,
                                              Throwable t)

sends a warning to the log and to the messagekeeper of the adapter

setLastExitState

public void setLastExitState(String pipeName,
                             long lastExitStateDate,
                             String lastExitState)

getLastExitIsTimeoutDate

public long getLastExitIsTimeoutDate(String pipeName)

formatErrorMessage

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

Specified by:

formatErrorMessage in interface IAdapter

getLastMessageDate

@JmxAttribute(description="The date/time of the last processed message")
public String getLastMessageDate()

retrieve the date and time of the last message.

getLastMessageDate

public String getLastMessageDate(String dateFormat)

getLastMessageDateDate

public Date getLastMessageDateDate()

getMessageKeeper

public MessageKeeper getMessageKeeper()

the MessageKeeper is for keeping the last messageKeeperSize messages available, for instance for displaying it in the webcontrol

Specified by:

getMessageKeeper in interface IAdapter

See Also:

MessageKeeper

iterateOverStatistics

public void iterateOverStatistics(StatisticsKeeperIterationHandler hski,
                                  Object data,
                                  HasStatistics.Action action)
                           throws SenderException

Specified by:

iterateOverStatistics in interface HasStatistics

Throws:

SenderException

getNumOfMessagesInError

@JmxAttribute(description="# Messages in Error")
public long getNumOfMessagesInError()

The number of messages for which processing ended unsuccessfully.

getNumOfMessagesInProcess

@JmxAttribute(description="# Messages in process")
public int getNumOfMessagesInProcess()

getNumOfMessagesStartProcessingByHour

public long[] getNumOfMessagesStartProcessingByHour()

getNumOfMessagesProcessed

@JmxAttribute(description="# Messages Processed")
public long getNumOfMessagesProcessed()

Total of messages processed

Returns:

long total messages processed

getReceiverByName

public Receiver<?> getReceiverByName(String receiverName)

Specified by:

getReceiverByName in interface IAdapter

getReceiverByNameAndListener

public Receiver<?> getReceiverByNameAndListener(String receiverName,
                                                Class<?> listenerClass)

getReceivers

public Iterable<Receiver<?>> getReceivers()

Specified by:

getReceivers in interface IAdapter

getRunState

public RunState getRunState()

Description copied from interface: IManagable

returns the runstate of the object. Possible values are defined by RunState.

Specified by:

getRunState in interface IManagable

getRunStateAsString

@JmxAttribute(description="RunState")
public String getRunStateAsString()

getStatsMessageProcessingDuration

public StatisticsKeeper getStatsMessageProcessingDuration()

Return the total processing duration as a StatisticsKeeper

Returns:

nl.nn.adapterframework.statistics.StatisticsKeeper

See Also:

StatisticsKeeper

getStatsUpSince

@JmxAttribute(description="Up Since")
public String getStatsUpSince()

return the date and time since active Creation date: (19-02-2003 12:16:53)

Returns:

String Date

getStatsUpSince

public String getStatsUpSince(String dateFormat)

getStatsUpSinceDate

public Date getStatsUpSinceDate()

logToMessageLogWithMessageContentsOrSize

public void logToMessageLogWithMessageContentsOrSize(org.apache.logging.log4j.Level level,
                                                     String logMessage,
                                                     String dataPrefix,
                                                     Message data)

processMessage

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

Specified by:

processMessage in interface IAdapter

processMessageWithExceptions

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

Specified by:

processMessageWithExceptions in interface IAdapter

Throws:

ListenerException

registerReceiver

public void registerReceiver(Receiver<?> receiver)

Receives incoming messages. If an adapter can receive messages through multiple channels, then add a receiver for each channel.

setErrorMessageFormatter

public void setErrorMessageFormatter(IErrorMessageFormatter errorMessageFormatter)

Formatter for errors that can occur in this adapter.

setPipeLine

public void setPipeLine(PipeLine pipeline)
                 throws ConfigurationException

The PipeLine.

Specified by:

setPipeLine in interface IAdapter

Throws:

ConfigurationException

getPipeLine

public PipeLine getPipeLine()

Specified by:

getPipeLine in interface IAdapter

setConfiguration

public void setConfiguration(Configuration configuration)

the configuration this adapter belongs to

Specified by:

setConfiguration in interface IAdapter

startRunning

public void startRunning()

Start the adapter. The thread-name will be set to the adapter's name. The run method, called by t.start(), will call the startRunning method of the IReceiver. The Adapter will be a new thread, as this interface extends the Runnable interface. The actual starting is done in the run method.

Specified by:

startRunning in interface IManagable

See Also:

Receiver.startRunning()

stopRunning

public void stopRunning()

Stop the Adapter and close all elements like receivers, Pipeline, pipes etc. The adapter will call the IReceiver to stopListening

Also the PipeLine.close() method will be called, closing all registered pipes.

Specified by:

stopRunning in interface IManagable

See Also:

Receiver.stopRunning(), PipeLine.stop()

toString

public String toString()

Overrides:

toString in class Object

waitForNoMessagesInProcess

public void waitForNoMessagesInProcess()
                                throws InterruptedException

Throws:

InterruptedException

getBeanName

public String getBeanName()

Specified by:

getBeanName in interface org.springframework.beans.factory.NamedBean

setName

public void setName(String name)

name of the adapter

Specified by:

setName in interface INamedObject

getName

@JmxAttribute(description="Name of the Adapter")
public String getName()

Specified by:

getName in interface IConfigurationAware

Specified by:

getName in interface INamedObject

setDescription

public void setDescription(String description)

some functional description of the Adapter

setAutoStart

public void setAutoStart(boolean autoStart)

AutoStart indicates that the adapter should be started when the configuration is started.

Default value

true

setReplaceNullMessage

public void setReplaceNullMessage(boolean b)

If true a null message is replaced by an empty message

Default value

false

setMessageKeeperSize

public void setMessageKeeperSize(int size)

number of message displayed in ibisconsole

Default value

10

setMsgLogLevel

public void setMsgLogLevel(nl.nn.adapterframework.core.Adapter.MessageLogLevel level)
                    throws ConfigurationException

Defines behaviour for logging messages. Configuration is done in the MSG appender in log4j4ibis.properties.

Throws:

ConfigurationException

Default value

INFO, unless overridden by property msg.log.level.default

setRequestReplyLogging

@Deprecated
public void setRequestReplyLogging(boolean requestReplyLogging)

Deprecated.

setMsgLogHidden

public void setMsgLogHidden(boolean b)

If set to true, the length of the message is shown in the msg log instead of the content of the message

Default value

false

setTargetDesignDocument

public void setTargetDesignDocument(String string)