nl.nn.adapterframework.jdbc

Class JdbcSenderBase<H>

java.lang.Object

nl.nn.adapterframework.jndi.JndiBase

nl.nn.adapterframework.jdbc.JdbcFacade

nl.nn.adapterframework.jdbc.JdbcSenderBase<H>

All Implemented Interfaces:

HasPhysicalDestination, IBlockEnabledSender<H>, IConfigurable, IConfigurationAware, INamedObject, IScopeProvider, ISender, ISenderWithParameters, IWithParameters, IXAEnabled, HasStatistics, IOutputStreamingSupport, IStreamingSender, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware

Direct Known Subclasses:

JdbcQuerySenderBase

public abstract class JdbcSenderBase<H>
extends JdbcFacade
implements IBlockEnabledSender<H>, IStreamingSender

Base class for building JDBC-senders.

Since:

4.2.h

Author:

Gerrit van Brakel

Nested Class Summary

Nested classes/interfaces inherited from interface nl.nn.adapterframework.statistics.HasStatistics

HasStatistics.Action

Field Summary

Fields

Modifier and Type	Field and Description
protected Connection	connection
protected ParameterList	paramList

Fields inherited from class nl.nn.adapterframework.jndi.JndiBase

log

Constructor Summary

Constructors

Constructor and Description
JdbcSenderBase()

Method Summary

Modifier and Type	Method and Description
void	addParameter(Parameter p)
void	close() Stop/close the sender and deallocate resources.
void	configure() configure() is called once at startup of the framework in the configure method of the owner of this sender.
ParameterList	getParameterList()
int	getTimeout()
void	open() This method will be called to start the sender.
SenderResult	sendMessage(Message message, PipeLineSession session) Send a message to some destination (as configured in the Sender object).
void	setTimeout(int i) The number of seconds the driver will wait for a statement object to execute.
String	toString()

Methods inherited from class nl.nn.adapterframework.jdbc.JdbcFacade

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

Methods inherited from class nl.nn.adapterframework.jndi.JndiBase

getContext, getJndiEnv, setAuthentication, setCredentials, setInitialContextFactoryName, setJndiAuthAlias, setJndiContextPrefix, setJndiProperties, setName, setPrincipal, setProviderURL, setSecurityProtocol, setUrlPkgPrefixes

Methods inherited from class java.lang.Object

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

Methods inherited from interface nl.nn.adapterframework.core.IBlockEnabledSender

closeBlock, openBlock, sendMessage

Methods inherited from interface nl.nn.adapterframework.stream.IStreamingSender

sendMessage

Methods inherited from interface nl.nn.adapterframework.core.ISenderWithParameters

consumesSessionVariable

Methods inherited from interface nl.nn.adapterframework.core.ISender

isSynchronous, sendMessageOrThrow

Methods inherited from interface nl.nn.adapterframework.core.INamedObject

getName, setName

Methods inherited from interface nl.nn.adapterframework.core.IConfigurationAware

getApplicationContext, getName

Methods inherited from interface nl.nn.adapterframework.core.IScopeProvider

getConfigurationClassLoader

Methods inherited from interface org.springframework.context.ApplicationContextAware

setApplicationContext

Methods inherited from interface nl.nn.adapterframework.stream.IOutputStreamingSupport

provideOutputStream, supportsOutputStreamPassThrough

Methods inherited from interface nl.nn.adapterframework.core.HasPhysicalDestination

getDomain

Field Detail

connection

protected Connection connection

paramList

protected ParameterList paramList

Constructor Detail

JdbcSenderBase

public JdbcSenderBase()

Method Detail

addParameter

public void addParameter(Parameter p)

Specified by:

addParameter in interface IWithParameters

getParameterList

public ParameterList getParameterList()

Specified by:

getParameterList in interface IWithParameters

configure

public void configure()
               throws ConfigurationException

Description copied from interface: ISender

configure() is called once at startup of the framework in the configure method of the owner of this sender. Purpose of this method is to check whether the static configuration of the sender is correct. 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 ISender

Overrides:

configure in class JdbcFacade

Throws:

ConfigurationException

open

public void open()
          throws SenderException

Description copied from interface: ISender

This method will be called to start the sender. After this method is called the sendMessage method may be called. Purpose of this method is to reduce creating connections to databases etc. in the sendMessage() method.

Specified by:

open in interface ISender

Throws:

SenderException

close

public void close()

Description copied from interface: ISender

Stop/close the sender and deallocate resources.

Specified by:

close in interface ISender

Overrides:

close in class JndiBase

sendMessage

public final SenderResult sendMessage(Message message,
                                      PipeLineSession session)
                               throws SenderException,
                                      TimeoutException

Description copied from interface: ISender

Send a message to some destination (as configured in the Sender object). This method may only be called after the configure() method is called.

The following table shows the difference between synchronous and a-synchronous senders:

	synchronous	a-synchronous
ISender.isSynchronous() returns	true	false
return value of sendMessage() is	the reply-message	the messageId of the message sent
the correlationID specified with sendMessage()	may be ignored	is sent with the message
a {link TimeOutException}	may be thrown if a timeout occurs waiting for a reply	should not be expected

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.

Specified by:

sendMessage in interface ISender

Throws:

SenderException

TimeoutException

toString

public String toString()

Overrides:

toString in class JndiBase

setTimeout

public void setTimeout(int i)

The number of seconds the driver will wait for a statement object to execute. If the limit is exceeded, a TimeoutException is thrown. A value of 0 means execution time is not limited

Default value

0

getTimeout

public int getTimeout()