nl.nn.adapterframework.jdbc

Class JdbcTableListener<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>

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

Direct Known Subclasses:

MessageStoreListener

public class JdbcTableListener<M>
extends JdbcListener<M>
implements IProvidesMessageBrowsers<M>

Database Listener that operates on a table having at least a key and a status field.

Since:

4.7

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, CORRELATION_ID_KEY, STORAGE_KEY_KEY

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

log

Constructor Summary

Constructors

Constructor and Description
JdbcTableListener()

Method Summary

Modifier and Type	Method and Description
protected M	changeProcessState(Connection connection, M rawMessage, ProcessState toState, String reason)
void	configure() configure() is called once at startup of the framework in the configure() method of the owner of this listener.
protected String	createUpdateStatusQuery(String fieldValue, String additionalSetClause)
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	getPhysicalDestinationName() Returns the name and location of the database that this objects operates on.
String	getStatusValue(ProcessState state)
IMessageBrowser.StorageType	getStorageType(ProcessState state)
void	setCommentField(String commentField) (optional) Field used to store the reason of the last change of the statusField
void	setMaxCommentLength(int maxCommentLength) (optional) Maximum length of strings to be stored in commentField, or -1 for unlimited
void	setOrderField(String string) (optional) Comma separated list of fields determining the order in which messages are processed
void	setSelectCondition(String string) Additional condition for a row to belong to this TableListener.
void	setStatusField(String fieldname) Field containing the status of the message.
void	setStatusValueAvailable(String string) (optional) 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	setTableAlias(String string) Alias of the table, that can be used in selectCondition
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.JdbcListener

afterMessageProcessed, changeProcessState, close, closeThread, convertQuery, execute, extractMessage, extractRawMessage, getIdFromRawMessage, getKeyFromRawMessage, getRawMessage, getRawMessage, getUpdateStatusQuery, hasRawMessageAvailable, hasRawMessageAvailable, knownProcessStates, open, openThread, setBlobCharset, setBlobsCompressed, setBlobSmartGet, setCorrelationIdField, setKeyField, setMessageField, setMessageFieldType, setMessageIdField, 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

JdbcTableListener

public JdbcTableListener()

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 JdbcListener<M>

Throws:

ConfigurationException

createUpdateStatusQuery

protected String createUpdateStatusQuery(String fieldValue,
                                         String additionalSetClause)

changeProcessState

protected M changeProcessState(Connection connection,
                               M rawMessage,
                               ProcessState toState,
                               String reason)
                        throws ListenerException

Overrides:

changeProcessState in class JdbcListener<M>

Throws:

ListenerException

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>

getStatusValue

public String getStatusValue(ProcessState state)

getStorageType

public IMessageBrowser.StorageType getStorageType(ProcessState state)

getPhysicalDestinationName

public String getPhysicalDestinationName()

Description copied from class: JdbcFacade

Returns the name and location of the database that this objects operates on.

Specified by:

getPhysicalDestinationName in interface HasPhysicalDestination

Overrides:

getPhysicalDestinationName in class JdbcFacade

See Also:

HasPhysicalDestination.getPhysicalDestinationName()

setTableName

public void setTableName(String string)

Name of the table to be used

setTableAlias

public void setTableAlias(String string)

Alias of the table, that can be used in selectCondition

Default value

t

setStatusField

public void setStatusField(String fieldname)

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.

setOrderField

public void setOrderField(String string)

(optional) Comma separated list of fields determining the order in which messages are processed

setTimestampField

public void setTimestampField(String fieldname)

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

setCommentField

public void setCommentField(String commentField)

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

setMaxCommentLength

public void setMaxCommentLength(int maxCommentLength)

(optional) Maximum length of strings to be stored in commentField, or -1 for unlimited

Default value

1000

setStatusValueAvailable

public void setStatusValueAvailable(String string)

(optional) Value of statusField indicating row is available to be processed. If not specified, any row not having any of the other status values is considered available.

setStatusValueError

public void setStatusValueError(String string)

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

setStatusValueProcessed

public void setStatusValueProcessed(String string)

Value of status field indicating row is processed OK

setStatusValueInProcess

public void setStatusValueInProcess(String string)

Value of status field indicating is being processed. Can be left emtpy if database has SKIP LOCKED functionality and the Receiver can be (and is) set to Required or RequiresNew.

setStatusValueHold

public void setStatusValueHold(String string)

Value of status field indicating message is on Hold, temporarily

setSelectCondition

public void setSelectCondition(String string)

Additional condition for a row to belong to this TableListener. Impacts all process states