nl.nn.adapterframework.jdbc

Class MessageStoreListener<M>

java.lang.Object

nl.nn.adapterframework.jndi.JndiBase

nl.nn.adapterframework.jdbc.JdbcFacade

nl.nn.adapterframework.jdbc.JdbcListener<M>

nl.nn.adapterframework.jdbc.JdbcTableListener<M>

nl.nn.adapterframework.jdbc.MessageStoreListener<M>

All Implemented Interfaces:

HasPhysicalDestination, IConfigurable, IConfigurationAware, IHasProcessState<M>, IListener<M>, INamedObject, IPeekableListener<M>, IProvidesMessageBrowsers<M>, IPullingListener<M>, IScopeProvider, IXAEnabled, HasStatistics, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware

public class MessageStoreListener<M>
extends JdbcTableListener<M>

Read messages from the IBISSTORE database table previously stored by a MessageStoreSender. Example configuration:

        <Receiver
                name="03 MessageStoreReceiver"
                numThreads="4"
                transactionAttribute="Required"
                pollInterval="1"
                >
                <MessageStoreListener
                        name="03 MessageStoreListener"
                        slotId="${instance.name}/TestMessageStore"
                        statusValueInProcess="I"
                />
        </Receiver>

 

If you have a MessageStoreListener, failed messages are automatically kept in database table IBISSTORE. Messages are also kept after successful processing. The state of a message is distinguished by the TYPE field, as follows:

• M: The message is new. From a functional perspective, it is in the message store.
• E: There was an error processing the message. From a functional perspective, it is in the error store.
• A: The message was successfully processed. From a functional perspective, it is in the message log.

Another way to say this is that a MessageStoreListener acts as a message log and as an error store. If you have it, you do not need to add a JdbcErrorStorage or JdbcMessageLog within the same receiver.

See /IAF_util/IAF_DatabaseChangelog.xml for the structure of table IBISSTORE.

Author:

Jaco de Groot

Nested Class Summary

Nested classes/interfaces inherited from class nl.nn.adapterframework.jdbc.JdbcListener

JdbcListener.MessageFieldType

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

HasStatistics.Action

Field Summary

Fields inherited from class nl.nn.adapterframework.jdbc.JdbcListener

connection

Fields inherited from class nl.nn.adapterframework.jndi.JndiBase

log

Constructor Summary

Constructors

Constructor and Description
MessageStoreListener()

Method Summary

Modifier and Type	Method and Description
protected IMessageBrowser<M>	augmentMessageBrowser(IMessageBrowser<M> browser)
void	configure() configure() is called once at startup of the framework in the configure() method of the owner of this listener.
Message	extractMessage(RawMessageWrapper<M> rawMessage, Map<String,Object> context) Extracts data from message obtained from IPullingListener.getRawMessage(Map) or IPushingListener.wrapRawMessage(Object, PipeLineSession).
void	extractSessionKeyList()
IMessageBrowser<M>	getMessageBrowser(ProcessState state) returns a browser of messages that are in ProcessState 'state', and are stored in a storage managed by the listener itself (as opposed to a storage configured as a messageLog or errorStorage in the configuration).
String	getSelectCondition()
void	setBlobSmartGet(boolean b) Controls automatically whether blobdata is stored compressed and/or serialized in the database.
void	setCommentField(String commentField) (optional) Field used to store the reason of the last change of the statusField
void	setCorrelationIdField(String fieldname) Field containing the correlationId
void	setKeyField(String fieldname) Primary key field of the table, used to identify messages.
void	setMessageField(String fieldname) Field containing the message data
void	setMessageFieldType(JdbcListener.MessageFieldType fieldtype) Type of the field containing the message data
void	setMessageIdField(String fieldname) Field containing the message Id
void	setMoveToMessageLog(boolean moveToMessageLog) Move to messageLog after processing, as the message is already stored in the ibisstore only some fields need to be updated.
void	setSessionKeys(String sessionKeys) Comma separated list of sessionKey's to be read together with the message.
void	setSlotId(String slotId) Identifier for this service
void	setStatusField(String fieldname) Field containing the status of the message.
void	setStatusValueAvailable(String string) Value of statusField indicating row is available to be processed.
void	setStatusValueError(String string) Value of statusField indicating the processing of the row resulted in an error
void	setStatusValueHold(String string) Value of status field indicating message is on Hold, temporarily.
void	setStatusValueInProcess(String string) Value of status field indicating is being processed.
void	setStatusValueProcessed(String string) Value of status field indicating row is processed OK
void	setTableName(String string) Name of the table to be used
void	setTimestampField(String fieldname) (optional) Field used to store the date and time of the last change of the statusField

Methods inherited from class nl.nn.adapterframework.jdbc.JdbcTableListener

changeProcessState, createUpdateStatusQuery, getPhysicalDestinationName, getStatusValue, getStorageType, setMaxCommentLength, setOrderField, setSelectCondition, setTableAlias

Methods inherited from class nl.nn.adapterframework.jdbc.JdbcListener

afterMessageProcessed, changeProcessState, close, closeThread, convertQuery, execute, extractRawMessage, getKeyFromRawMessage, getRawMessage, getRawMessage, getUpdateStatusQuery, hasRawMessageAvailable, hasRawMessageAvailable, knownProcessStates, open, openThread, setBlobCharset, setBlobsCompressed, setPeekQuery, setPeekUntransacted, setSelectQuery, setSqlDialect, setTrace, setUpdateStatusQuery, targetProcessStates

Methods inherited from class nl.nn.adapterframework.jdbc.JdbcFacade

getAuthAlias, getConnection, getConnectionWithTimeout, getDatasource, getDatasourceInfo, getDatasourceName, getDbmsSupport, getLogPrefix, getPassword, getUsername, isConnectionsArePooled, isTransacted, iterateOverStatistics, setAuthAlias, setConnectionsArePooled, setDatasourceName, setDbmsSupportFactory, setJmsRealm, setPassword, setTransacted, setUsername

Methods inherited from class nl.nn.adapterframework.jndi.JndiBase

getContext, getJndiEnv, setAuthentication, setCredentials, setInitialContextFactoryName, setJndiAuthAlias, setJndiContextPrefix, setJndiProperties, setName, setPrincipal, setProviderURL, setSecurityProtocol, setUrlPkgPrefixes, toString

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

changeProcessState, knownProcessStates, targetProcessStates

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

isPeekUntransacted

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

getName, setName

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

getApplicationContext, getName

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

getConfigurationClassLoader

Methods inherited from interface org.springframework.context.ApplicationContextAware

setApplicationContext

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

getDomain

Constructor Detail

MessageStoreListener

public MessageStoreListener()

Method Detail

configure

public void configure()
               throws ConfigurationException

Description copied from interface: IListener

configure() is called once at startup of the framework in the configure() method of the owner of this listener. Purpose of this method is to reduce creating connections to databases etc. in the IPullingListener.getRawMessage(Map) method. As much as possible class-instantiating should take place in the configure() or open() method, to improve performance.

Specified by:

configure in interface IConfigurable

Specified by:

configure in interface IListener<M>

Overrides:

configure in class JdbcTableListener<M>

Throws:

ConfigurationException

extractSessionKeyList

public void extractSessionKeyList()

extractMessage

public Message extractMessage(@Nonnull
                              RawMessageWrapper<M> rawMessage,
                              @Nonnull
                              Map<String,Object> context)
                       throws ListenerException

Description copied from interface: IListener

Extracts data from message obtained from IPullingListener.getRawMessage(Map) or IPushingListener.wrapRawMessage(Object, PipeLineSession). May also extract other parameters from the message and put those into the context.

Specified by:

extractMessage in interface IListener<M>

Overrides:

extractMessage in class JdbcListener<M>

Parameters:

rawMessage - The RawMessageWrapper from which to extract the Message.

context - Context to populate. Either a PipeLineSession or a Map threadContext depending on caller.

Returns:

input Message for adapter.

Throws:

ListenerException

augmentMessageBrowser

protected IMessageBrowser<M> augmentMessageBrowser(IMessageBrowser<M> browser)

getMessageBrowser

public IMessageBrowser<M> getMessageBrowser(ProcessState state)

Description copied from interface: IProvidesMessageBrowsers

returns a browser of messages that are in ProcessState 'state', and are stored in a storage managed by the listener itself (as opposed to a storage configured as a messageLog or errorStorage in the configuration).

Specified by:

getMessageBrowser in interface IProvidesMessageBrowsers<M>

Overrides:

getMessageBrowser in class JdbcTableListener<M>

getSelectCondition

public String getSelectCondition()

setSlotId

public void setSlotId(String slotId)

Identifier for this service

setSessionKeys

public void setSessionKeys(String sessionKeys)

Comma separated list of sessionKey's to be read together with the message. Please note: corresponding MessageStoreSender must have the same value for this attribute

setTableName

@Default(value="IBISSTORE")
 @Optional
public void setTableName(String string)

Description copied from class: JdbcTableListener

Name of the table to be used

Overrides:

setTableName in class JdbcTableListener<M>

setKeyField

@Default(value="MESSAGEKEY")
public void setKeyField(String fieldname)

Description copied from class: JdbcListener

Primary key field of the table, used to identify messages. For optimal performance, there should be an index on this field.

Overrides:

setKeyField in class JdbcListener<M>

setMessageField

@Default(value="MESSAGE")
public void setMessageField(String fieldname)

Description copied from class: JdbcListener

Field containing the message data

Overrides:

setMessageField in class JdbcListener<M>

setMessageIdField

@Default(value="MESSAGEID")
public void setMessageIdField(String fieldname)

Description copied from class: JdbcListener

Field containing the message Id

Overrides:

setMessageIdField in class JdbcListener<M>

setCorrelationIdField

@Default(value="CORRELATIONID")
public void setCorrelationIdField(String fieldname)

Description copied from class: JdbcListener

Field containing the correlationId

Overrides:

setCorrelationIdField in class JdbcListener<M>

setMessageFieldType

@Default(value="BLOB")
public void setMessageFieldType(JdbcListener.MessageFieldType fieldtype)

Description copied from class: JdbcListener

Type of the field containing the message data

Overrides:

setMessageFieldType in class JdbcListener<M>

setBlobSmartGet

@Default(value="<code>true</code>")
public void setBlobSmartGet(boolean b)

Description copied from class: JdbcListener

Controls automatically whether blobdata is stored compressed and/or serialized in the database. N.B. When set true, then the BLOB will be converted into a string

Overrides:

setBlobSmartGet in class JdbcListener<M>

setStatusField

@Default(value="TYPE")
 @Optional
public void setStatusField(String fieldname)

Description copied from class: JdbcTableListener

Field containing the status of the message. For optimal performance, and index should exist that starts with this field, contains all fields that are used with a fixed value in the select condition, and end with the orderField.

Overrides:

setStatusField in class JdbcTableListener<M>

setTimestampField

@Default(value="MESSAGEDATE")
public void setTimestampField(String fieldname)

Description copied from class: JdbcTableListener

(optional) Field used to store the date and time of the last change of the statusField

Overrides:

setTimestampField in class JdbcTableListener<M>

setCommentField

@Default(value="COMMENTS")
public void setCommentField(String commentField)

Description copied from class: JdbcTableListener

(optional) Field used to store the reason of the last change of the statusField

Overrides:

setCommentField in class JdbcTableListener<M>

setStatusValueAvailable

public void setStatusValueAvailable(String string)

Value of statusField indicating row is available to be processed. If set empty, any row not having any of the other status values is considered available.

Overrides:

setStatusValueAvailable in class JdbcTableListener<M>

Default value

M

setStatusValueInProcess

public void setStatusValueInProcess(String string)

Value of status field indicating is being processed. Set to I if database has no SKIP LOCKED functionality, the Receiver cannot be set to Required or RequiresNew, or to support programmatic retry.

Overrides:

setStatusValueInProcess in class JdbcTableListener<M>

setStatusValueError

@Default(value="<code>E</code>")
 @Optional
public void setStatusValueError(String string)

Description copied from class: JdbcTableListener

Value of statusField indicating the processing of the row resulted in an error

Overrides:

setStatusValueError in class JdbcTableListener<M>

setStatusValueProcessed

@Default(value="<code>A</code>")
 @Optional
public void setStatusValueProcessed(String string)

Description copied from class: JdbcTableListener

Value of status field indicating row is processed OK

Overrides:

setStatusValueProcessed in class JdbcTableListener<M>

setStatusValueHold

public void setStatusValueHold(String string)

Value of status field indicating message is on Hold, temporarily. If required, suggested value is H.

Overrides:

setStatusValueHold in class JdbcTableListener<M>

setMoveToMessageLog

public void setMoveToMessageLog(boolean moveToMessageLog)

Move to messageLog after processing, as the message is already stored in the ibisstore only some fields need to be updated. When set false, messages are deleted after being processed

Default value

true