Package org.frankframework.jdbc

Class JdbcQueryListener

java.lang.Object

org.frankframework.jdbc.JdbcFacade

org.frankframework.jdbc.JdbcListener

org.frankframework.jdbc.JdbcQueryListener

All Implemented Interfaces:

FrankElement, HasApplicationContext, HasName, HasPhysicalDestination, IConfigurable, IHasProcessState, IListener, IPeekableListener, IPullingListener, IScopeProvider, IXAEnabled, NameAware, ConfigurableLifecycle, ReceiverAware, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware, org.springframework.context.Lifecycle, org.springframework.context.Phased, org.springframework.context.SmartLifecycle

@Deprecated(forRemoval=true,
            since="7.6.0")
@ConfigurationWarning("Please replace with JdbcTableListener for ease of configuration and improved manageability")
public class JdbcQueryListener
extends JdbcListener

Deprecated, for removal: This API element is subject to removal in a future version.

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 org.frankframework.jdbc.JdbcListener

JdbcListener.MessageFieldType

Field Summary

Fields inherited from class org.frankframework.jdbc.JdbcListener

ADDITIONAL_QUERY_FIELDS_KEY, connection

Fields inherited from class org.frankframework.jdbc.JdbcFacade

log

Fields inherited from interface org.springframework.context.SmartLifecycle

DEFAULT_PHASE

Constructor Summary

Constructors

Constructor	Description
JdbcQueryListener()	Deprecated, for removal: This API element is subject to removal in a future version.

Method Summary

Modifier and Type	Method	Description
void	configure()	Deprecated, for removal: This API element is subject to removal in a future version. Configure this component.
void	setRevertInProcessStatusQuery(String query)	Deprecated, for removal: This API element is subject to removal in a future version. SQL statement to set the status of a row to 'available'.
void	setSelectQuery(String string)	Deprecated, for removal: This API element is subject to removal in a future version. Query that returns a row to be processed.
void	setUpdateStatusToErrorQuery(String query)	Deprecated, for removal: This API element is subject to removal in a future version. SQL statement to set the status of a row to 'error'.
void	setUpdateStatusToInProcessQuery(String query)	Deprecated, for removal: This API element is subject to removal in a future version. SQL statement to set the status of a row to 'in process'.
void	setUpdateStatusToProcessedQuery(String query)	Deprecated, for removal: This API element is subject to removal in a future version. SQL statement to set the status of a row to 'processed'.

Methods inherited from class org.frankframework.jdbc.JdbcListener

addAdditionalQueryFieldsToSession, addAdditionalValuesToMessageWrapper, afterMessageProcessed, changeProcessState, changeProcessState, closeThread, convertQuery, execute, extractMessage, extractRawMessage, getKeyFromRawMessage, getRawMessage, getRawMessage, getUpdateStatusQuery, hasRawMessageAvailable, hasRawMessageAvailable, knownProcessStates, openThread, setAdditionalFields, setBlobCharset, setBlobsCompressed, setBlobSmartGet, setCorrelationIdField, setKeyField, setMessageField, setMessageFieldType, setMessageIdField, setPeekQuery, setPeekUntransacted, setSqlDialect, setUpdateStatusQuery, start, stop, targetProcessStates

Methods inherited from class org.frankframework.jdbc.JdbcFacade

getConnection, getConnectionWithTimeout, getDatasource, getDatasourceName, getDbmsSupport, getLogPrefix, getPassword, getPhysicalDestinationName, isConnectionsArePooled, isRunning, isTransacted, setAuthAlias, setConnectionsArePooled, setDatasourceName, setDbmsSupportFactory, setName, setPassword, setTransacted, setUsername

Methods inherited from class java.lang.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 org.frankframework.lifecycle.ConfigurableLifecycle

getPhase, isAutoStartup, isConfigured

Methods inherited from interface org.frankframework.core.FrankElement

addConfigWarning

Methods inherited from interface org.frankframework.core.HasApplicationContext

getApplicationContext, getConfigurationClassLoader

Methods inherited from interface org.frankframework.core.HasName

getName

Methods inherited from interface org.frankframework.core.IPeekableListener

isPeekUntransacted

Methods inherited from interface org.frankframework.core.NameAware

setName

Methods inherited from interface org.frankframework.receivers.ReceiverAware

getReceiver, setReceiver

Methods inherited from interface org.springframework.context.SmartLifecycle

stop

Constructor Details

JdbcQueryListener

public JdbcQueryListener()

Deprecated, for removal: This API element is subject to removal in a future version.

Method Details

configure

public void configure()
               throws ConfigurationException

Deprecated, for removal: This API element is subject to removal in a future version.

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.

setSelectQuery

public void setSelectQuery(String string)

Deprecated, for removal: This API element is subject to removal in a future version.

Query that returns a row to be processed. Must contain a key field and optionally a message field.

Overrides:

setSelectQuery in class JdbcListener

setUpdateStatusToProcessedQuery

public void setUpdateStatusToProcessedQuery(String query)

Deprecated, for removal: This API element is subject to removal in a future version.

SQL statement to set the status of a row to 'processed'. Must contain one parameter, that is set to the value of the key

setUpdateStatusToErrorQuery

public void setUpdateStatusToErrorQuery(String query)

Deprecated, for removal: This API element is subject to removal in a future version.

SQL statement to set the status of a row to 'error'. Must contain one parameter, that is set to the value of the key

Default value

same as updateStatusToProcessedQuery

setUpdateStatusToInProcessQuery

public void setUpdateStatusToInProcessQuery(String query)

Deprecated, for removal: This API element is subject to removal in a future version.

SQL statement to set the status of a row to 'in process'. Must contain one parameter, that is set to the value of the key. Can be left emtpy if database has SKIP LOCKED functionality and the Receiver can be (and is) set to Required or RequiresNew.

setRevertInProcessStatusQuery

public void setRevertInProcessStatusQuery(String query)

Deprecated, for removal: This API element is subject to removal in a future version.

SQL statement to set the status of a row to 'available'. Must contain one parameter, that is set to the value of the key. Only used in rollbacks, when updateStatusToInProcessQuery is specified