Package org.frankframework.jdbc

Class JdbcQueryListener

java.lang.Object

org.frankframework.jndi.JndiBase

org.frankframework.jdbc.JdbcFacade

org.frankframework.jdbc.JdbcListener

org.frankframework.jdbc.JdbcQueryListener

All Implemented Interfaces:

HasPhysicalDestination, IConfigurable, IConfigurationAware, IHasProcessState, IListener, INamedObject, IPeekableListener, IPullingListener, IScopeProvider, IXAEnabled, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware

@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

connection

Fields inherited from class org.frankframework.jndi.JndiBase

log

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() is called once at startup of the framework in the configure() method of the owner of this listener.
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

afterMessageProcessed, changeProcessState, changeProcessState, closeThread, convertQuery, execute, extractMessage, extractRawMessage, getBlobCharset, getCorrelationIdField, getKeyField, getKeyFromRawMessage, getMessageField, getMessageFieldType, getMessageIdField, getPeekQuery, getRawMessage, getRawMessage, getSelectQuery, getSqlDialect, getUpdateStatusQuery, hasRawMessageAvailable, hasRawMessageAvailable, isBlobsCompressed, isBlobSmartGet, isPeekUntransacted, isTrace, knownProcessStates, openThread, setBlobCharset, setBlobsCompressed, setBlobSmartGet, setCorrelationIdField, setKeyField, setMessageField, setMessageFieldType, setMessageIdField, setPeekQuery, setPeekUntransacted, setSqlDialect, setTrace, setUpdateStatusQuery, start, stop, targetProcessStates

Methods inherited from class org.frankframework.jdbc.JdbcFacade

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

Methods inherited from class org.frankframework.jndi.JndiBase

getApplicationContext, getAuthentication, getConfigurationClassLoader, getContext, getCredentials, getInitialContextFactoryName, getJmsRealmName, getJndiAuthAlias, getJndiContextPrefix, getJndiEnv, getJndiProperties, getName, getPrincipal, getProviderURL, getSecurityProtocol, getUrlPkgPrefixes, setApplicationContext, 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 org.springframework.context.ApplicationContextAware

setApplicationContext

Methods inherited from interface org.frankframework.core.IConfigurationAware

getApplicationContext, getName

Methods inherited from interface org.frankframework.core.INamedObject

getName, setName

Methods inherited from interface org.frankframework.core.IScopeProvider

getConfigurationClassLoader

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: 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 IListener.start() method, to improve performance.

Specified by:

configure in interface IConfigurable

Specified by:

configure in interface IListener

Overrides:

configure in class JdbcListener

Throws:

ConfigurationException

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