Class JdbcTableListener

java.lang.Object

org.frankframework.jdbc.JdbcFacade

org.frankframework.jdbc.AbstractJdbcListener

org.frankframework.jdbc.JdbcListener

org.frankframework.jdbc.JdbcTableListener

All Implemented Interfaces:

FrankElement, HasApplicationContext, HasName, HasPhysicalDestination, IConfigurable, IHasProcessState<Serializable>, IListener<Serializable>, IPeekableListener<Serializable>, IProvidesMessageBrowsers<Serializable>, IPullingListener<Serializable>, IRedeliveringListener<Serializable>, IScopeProvider, NameAware, TransactionAware, ConfigurableLifecycle, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware, org.springframework.context.Lifecycle, org.springframework.context.Phased, org.springframework.context.SmartLifecycle

Direct Known Subclasses:

MessageStoreListener

public class JdbcTableListener
extends JdbcListener
implements IProvidesMessageBrowsers<Serializable>

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

Since:

4.7

Field Summary

Fields inherited from class AbstractJdbcListener

ADDITIONAL_QUERY_FIELDS_KEY, additionalFields, additionalFieldsList, correlationIdField, keyField, messageField, messageIdField, peekQuery, peekUntransacted, preparedPeekQuery, preparedSelectQuery, selectQuery, trace

Fields inherited from class JdbcFacade

log

Fields inherited from interface org.springframework.context.SmartLifecycle

DEFAULT_PHASE

Constructor Summary

Constructors

Constructor	Description
JdbcTableListener()

Method Summary

Modifier and Type	Method	Description
protected @Nullable RawMessageWrapper<Serializable>	changeProcessState(Connection connection, RawMessageWrapper<Serializable> rawMessage, ProcessState toState, String reason)
void	configure()	Configure this component.
protected String	createUpdateStatusQuery(String fieldValue, String additionalSetClause)
protected @NonNull Map<String,String>	getConfiguredColumnNames()	Get a map with all configured column names.
@Nullable IMessageBrowser<Serializable>	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).
@NonNull 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 statusField indicating message is on Hold, temporarily
void	setStatusValueInProcess(String string)	Value of statusField 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
void	start()	Prepares the listener for receiving messages.
protected void	verifyFieldNotInQuery(String fieldName, String query)

Methods inherited from class JdbcListener

afterMessageProcessed, changeProcessState, getKeyFromRawMessage, getRawMessage, getRawMessage, getUpdateStatusQuery, knownProcessStates, messageWillBeRedeliveredOnExitStateError, setMessageFieldType, setUpdateStatusQuery, targetProcessStates

Methods inherited from class AbstractJdbcListener

addAdditionalValuesToMessageWrapper, closeThread, execute, extractMessage, extractRawMessage, getColumnValueOrDefault, getMessageKeyOrNull, hasRawMessageAvailable, openThread, setAdditionalFields, setCorrelationIdField, setKeyField, setMessageField, setMessageIdField, setPeekQuery, setPeekUntransacted, setSelectQuery

Methods inherited from class JdbcFacade

convertQuery, getConnection, getConnectionWithTimeout, getDatasource, getDatasourceName, getDbmsSupport, getLogPrefix, getPassword, isRunning, setAuthAlias, setBlobCharset, setBlobsCompressed, setBlobSmartGet, setDatasourceName, setDbmsSupportFactory, setName, setPassword, setSqlDialect, setUsername, stop, withConnection, withConnection

Methods inherited from class Object

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

Methods inherited from interface org.springframework.context.ApplicationContextAware

setApplicationContext

Methods inherited from interface ConfigurableLifecycle

getPhase, isAutoStartup, isConfigured

Methods inherited from interface FrankElement

addConfigWarning

Methods inherited from interface HasApplicationContext

getApplicationContext, getConfigurationClassLoader

Methods inherited from interface HasName

getName

Methods inherited from interface IHasProcessState

changeProcessState, knownProcessStates, targetProcessStates

Methods inherited from interface IListener

extractMessage, stop

Methods inherited from interface IPeekableListener

hasRawMessageAvailable, isPeekUntransacted, setPeekUntransacted

Methods inherited from interface IPullingListener

closeThread, openThread

Methods inherited from interface NameAware

setName

Methods inherited from interface org.springframework.context.SmartLifecycle

isPauseable, stop

Constructor Details

JdbcTableListener

public JdbcTableListener()

Method Details

configure

public void configure()
               throws ConfigurationException

Description copied from interface: IConfigurable

Configure this component.

configure() is called once at startup of the framework in the configure method of the owner of this IConfigurable. Purpose of this method is to check whether the static configuration of the object is correct. As much as possible class-instantiating should take place in the configure(), to improve performance.

In the case of a container, this will propagate the configure signal to all components that apply.

Specified by:

configure in interface IConfigurable

Overrides:

configure in class JdbcListener

Throws:

ConfigurationException - in case it was not able to configure the component.

start

public void start()

Description copied from interface: IListener

Prepares the listener for receiving messages. start() is called once each time the listener is started.

Specified by:

start in interface ConfigurableLifecycle

Specified by:

start in interface IListener<Serializable>

Specified by:

start in interface org.springframework.context.Lifecycle

Overrides:

start in class JdbcFacade

getConfiguredColumnNames

protected @NonNull Map<String,String> getConfiguredColumnNames()

Get a map with all configured column names. This is used in validation of the configuration. The key is the functional name of the field and the value the column name in the database. Subclasses may potentially override this method to add more fields that the subclass defines. The returned map must be modifiable, and all column names must be in all-caps.

verifyFieldNotInQuery

protected void verifyFieldNotInQuery(String fieldName,
 String query)

createUpdateStatusQuery

protected String createUpdateStatusQuery(String fieldValue,
 String additionalSetClause)

changeProcessState

protected @Nullable RawMessageWrapper<Serializable> changeProcessState(Connection connection,
 RawMessageWrapper<Serializable> rawMessage,
 ProcessState toState,
 String reason)
                                                                throws ListenerException

Overrides:

changeProcessState in class JdbcListener

Throws:

ListenerException

getMessageBrowser

public @Nullable IMessageBrowser<Serializable> 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<Serializable>

getStatusValue

public String getStatusValue(ProcessState state)

getStorageType

public IMessageBrowser.StorageType getStorageType(ProcessState state)

getPhysicalDestinationName

public @NonNull String getPhysicalDestinationName()

Description copied from class: JdbcFacade

Returns the name and location of the database that this objects operates on. If no previous connection was made or it cannot determine the destination it returns 'unknown'

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. NB: For optimal performance, an index should exist that starts with this field, followed by 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 statusField indicating is being processed. Can be left emtpy if database has SKIP LOCKED functionality and the transactionAttribute of the Receiver can be (and is) set to Required or RequiresNew.

setStatusValueHold

public void setStatusValueHold(String string)

Value of statusField 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