Class JdbcListener

java.lang.Object

org.frankframework.jdbc.JdbcFacade

org.frankframework.jdbc.AbstractJdbcListener

org.frankframework.jdbc.JdbcListener

All Implemented Interfaces:

FrankElement, HasApplicationContext, HasName, HasPhysicalDestination, IConfigurable, IHasProcessState<Serializable>, IListener<Serializable>, IPeekableListener<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:

JdbcQueryListener, JdbcTableListener

public class JdbcListener
extends AbstractJdbcListener
implements IPeekableListener<Serializable>, IHasProcessState<Serializable>, IRedeliveringListener<Serializable>

JdbcListener base class.

Since:

4.7

Author:

Gerrit van Brakel

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
JdbcListener()

Method Summary

Modifier and Type	Method	Description
void	afterMessageProcessed(PipeLineResult processResult, RawMessageWrapper<Serializable> rawMessage, PipeLineSession pipeLineSession)	Called to perform actions (like committing or sending a reply) after a message has been processed by the Pipeline.
protected @Nullable RawMessageWrapper<Serializable>	changeProcessState(Connection connection, RawMessageWrapper<Serializable> rawMessage, ProcessState toState, String reason)
@Nullable RawMessageWrapper<Serializable>	changeProcessState(RawMessageWrapper<Serializable> rawMessage, ProcessState toState, String reason)	Change the processState of the message to the specified state, if that state is supported.
void	configure()	Configure this component.
protected @NonNull String	getKeyFromRawMessage(RawMessageWrapper<Serializable> rawMessage)	Get the storage-key for the Message from the RawMessageWrapper.
protected @Nullable RawMessageWrapper<Serializable>	getRawMessage(Connection conn, Map<String,Object> threadContext)
@Nullable RawMessageWrapper<Serializable>	getRawMessage(@NonNull Map<String,Object> threadContext)	Retrieves messages from queue or other channel, but does no processing on it.
String	getUpdateStatusQuery(ProcessState state)
Set<ProcessState>	knownProcessStates()	Provides the set of ProcessStates used by this listener.
boolean	messageWillBeRedeliveredOnExitStateError()
void	setMessageFieldType(@NonNull String ignored)	Deprecated, for removal: This API element is subject to removal in a future version. No longer needed, automatically determined
protected void	setUpdateStatusQuery(ProcessState state, String query)
Map<ProcessState, Set<ProcessState>>	targetProcessStates()	Provides the set of ProcessStates that a message in the specified state can be moved to, e.g. from a MessageBrowser for that state.

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, getPhysicalDestinationName, isRunning, setAuthAlias, setBlobCharset, setBlobsCompressed, setBlobSmartGet, setDatasourceName, setDbmsSupportFactory, setName, setPassword, setSqlDialect, setUsername, start, 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 IListener

extractMessage, start, 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

JdbcListener

public JdbcListener()

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 AbstractJdbcListener

Throws:

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

messageWillBeRedeliveredOnExitStateError

public boolean messageWillBeRedeliveredOnExitStateError()

Specified by:

messageWillBeRedeliveredOnExitStateError in interface IRedeliveringListener<Serializable>

getRawMessage

public @Nullable RawMessageWrapper<Serializable> getRawMessage(@NonNull Map<String,Object> threadContext)
                                                        throws ListenerException

Description copied from interface: IPullingListener

Retrieves messages from queue or other channel, but does no processing on it. Multiple objects may try to call this method at the same time, from different threads. Implementations of this method should therefore be thread-safe, or synchronized.

Any thread-specific properties should be stored in and retrieved from the threadContext.

If the returned object is an instance of MessageWrapper then the

invalid reference

org.frankframework.receivers.Receiver#processRawMessage(IListener, RawMessageWrapper, PipeLineSession, boolean)

will not call IListener.extractMessage(RawMessageWrapper, Map) but directly access the enclosed Message and the

invalid reference

RawMessageWrapper#getContext()

.

Specified by:

getRawMessage in interface IPullingListener<Serializable>

Throws:

ListenerException

getRawMessage

protected @Nullable RawMessageWrapper<Serializable> getRawMessage(Connection conn,
 Map<String,Object> threadContext)
                                                           throws ListenerException

Throws:

ListenerException

getKeyFromRawMessage

protected @NonNull String getKeyFromRawMessage(RawMessageWrapper<Serializable> rawMessage)

Get the storage-key for the Message from the RawMessageWrapper. Throw an exception if not found, key-field is mandatory for state-changing listeners.

afterMessageProcessed

public void afterMessageProcessed(PipeLineResult processResult,
 RawMessageWrapper<Serializable> rawMessage,
 PipeLineSession pipeLineSession)

Description copied from interface: IListener

Called to perform actions (like committing or sending a reply) after a message has been processed by the Pipeline.

Specified by:

afterMessageProcessed in interface IListener<Serializable>

knownProcessStates

public Set<ProcessState> knownProcessStates()

Description copied from interface: IHasProcessState

Provides the set of ProcessStates used by this listener.

Specified by:

knownProcessStates in interface IHasProcessState<Serializable>

targetProcessStates

public Map<ProcessState, Set<ProcessState>> targetProcessStates()

Description copied from interface: IHasProcessState

Provides the set of ProcessStates that a message in the specified state can be moved to, e.g. from a MessageBrowser for that state.

Specified by:

targetProcessStates in interface IHasProcessState<Serializable>

changeProcessState

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

Description copied from interface: IHasProcessState

Change the processState of the message to the specified state, if that state is supported. If it is not supported, nothing changes, and false is returned.

Specified by:

changeProcessState in interface IHasProcessState<Serializable>

Returns:

the moved message, or null if no message was moved.

Throws:

ListenerException

changeProcessState

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

Throws:

ListenerException

setUpdateStatusQuery

protected void setUpdateStatusQuery(ProcessState state,
 String query)

getUpdateStatusQuery

public String getUpdateStatusQuery(ProcessState state)

setMessageFieldType

@Deprecated(forRemoval=true,
            since="10.4")
@ConfigurationWarning("It is no longer necessary to configure this")
public void setMessageFieldType(@NonNull String ignored)

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

No longer needed, automatically determined

Type of the field containing the message data - no longer needed as the listener will now automatically determine the message field type