Package org.frankframework.jdbc

Class SimpleJdbcListener

java.lang.Object

org.frankframework.jndi.JndiBase

org.frankframework.jdbc.JdbcFacade

org.frankframework.jdbc.SimpleJdbcListener

All Implemented Interfaces:

HasPhysicalDestination, IConfigurable, IConfigurationAware, IListener<String>, INamedObject, IPullingListener<String>, IScopeProvider, IXAEnabled, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware

public class SimpleJdbcListener
extends JdbcFacade
implements IPullingListener<String>

Database Listener that returns a count of messages available, but does not perform any locking or other management of processing messages in parallel.

Author:

Peter Leeuwenburgh

Field Summary

Fields

Modifier and Type	Field	Description
protected Connection	connection
protected static final String	KEYWORD_SELECT_COUNT

Fields inherited from class org.frankframework.jndi.JndiBase

log

Constructor Summary

Constructors

Constructor	Description
SimpleJdbcListener()

Method Summary

Modifier and Type	Method	Description
void	afterMessageProcessed(PipeLineResult processResult, RawMessageWrapper<String> rawMessage, PipeLineSession pipeLineSession)	Called to perform actions (like committing or sending a reply) after a message has been processed by the Pipeline.
void	close()	Close all resources used for listening.
void	closeThread(Map<String,Object> threadContext)	Finalizes a message receiving thread.
void	configure()	configure() is called once at startup of the framework in the configure() method of the owner of this listener.
protected void	execute(Connection conn, String query)
protected void	execute(Connection conn, String query, String parameter)
protected ResultSet	executeQuery(Connection conn, String query)
Message	extractMessage(RawMessageWrapper<String> rawMessage, Map<String,Object> context)	Extracts data from message obtained from IPullingListener.getRawMessage(Map) or IPushingListener.wrapRawMessage(Object, PipeLineSession).
protected RawMessageWrapper<String>	getRawMessage(Connection conn, Map<String,Object> threadContext)
RawMessageWrapper<String>	getRawMessage(Map<String,Object> threadContext)	Retrieves messages from queue or other channel, but does no processing on it.
String	getSelectQuery()
boolean	isTrace()
void	open()	Prepares the listener for receiving messages.
Map<String,Object>	openThread()	Prepares a thread for receiving messages.
void	setSelectQuery(String string)	count query that returns the number of available records.
void	setTrace(boolean trace)

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

Field Details

KEYWORD_SELECT_COUNT

protected static final String KEYWORD_SELECT_COUNT

See Also:

• Constant Field Values

connection

protected Connection connection

Constructor Details

SimpleJdbcListener

public SimpleJdbcListener()

Method Details

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<String>

Overrides:

configure in class JdbcFacade

Throws:

ConfigurationException

open

public void open()
          throws ListenerException

Description copied from interface: IListener

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

Specified by:

open in interface IListener<String>

Throws:

ListenerException

close

public void close()

Description copied from interface: IListener

Close all resources used for listening. Called once each time the listener is stopped.

Specified by:

close in interface IListener<String>

Overrides:

close in class JndiBase

openThread

@Nonnull
public Map<String,Object> openThread()
                              throws ListenerException

Description copied from interface: IPullingListener

Prepares a thread for receiving messages. Called once for each thread that will listen for messages.

Specified by:

openThread in interface IPullingListener<String>

Returns:

the threadContext for this thread. The threadContext is a Map in which thread-specific data can be stored. May not be null, must be a mutable map type.

Throws:

ListenerException

closeThread

public void closeThread(@Nonnull
 Map<String,Object> threadContext)
                 throws ListenerException

Description copied from interface: IPullingListener

Finalizes a message receiving thread. Called once for each thread that listens for messages, just before IListener.close() is called.

Specified by:

closeThread in interface IPullingListener<String>

Throws:

ListenerException

getRawMessage

public RawMessageWrapper<String> 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.

Specified by:

getRawMessage in interface IPullingListener<String>

Throws:

ListenerException

getRawMessage

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

Throws:

ListenerException

extractMessage

public Message extractMessage(@Nonnull
 RawMessageWrapper<String> rawMessage,
 @Nonnull
 Map<String,Object> context)

Description copied from interface: IListener

Extracts data from message obtained from IPullingListener.getRawMessage(Map) or IPushingListener.wrapRawMessage(Object, PipeLineSession). May also extract other parameters from the message and put those into the context.

Specified by:

extractMessage in interface IListener<String>

Parameters:

rawMessage - The RawMessageWrapper from which to extract the Message.

context - Context to populate. Either a PipeLineSession or a Map threadContext depending on caller.

Returns:

input Message for adapter.

executeQuery

protected ResultSet executeQuery(Connection conn,
 String query)
                          throws ListenerException

Throws:

ListenerException

afterMessageProcessed

public void afterMessageProcessed(PipeLineResult processResult,
 RawMessageWrapper<String> 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<String>

execute

protected void execute(Connection conn,
 String query)
                throws ListenerException

Throws:

ListenerException

execute

protected void execute(Connection conn,
 String query,
 String parameter)
                throws ListenerException

Throws:

ListenerException

setSelectQuery

public void setSelectQuery(String string)

count query that returns the number of available records. when there are available records the pipeline is activated

getSelectQuery

public String getSelectQuery()

isTrace

public boolean isTrace()

setTrace

public void setTrace(boolean trace)