nl.nn.adapterframework.jdbc

Class StoredProcedureQuerySender

java.lang.Object

nl.nn.adapterframework.jndi.JndiBase

nl.nn.adapterframework.jdbc.JdbcFacade

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

nl.nn.adapterframework.jdbc.JdbcQuerySenderBase<QueryExecutionContext>

nl.nn.adapterframework.jdbc.FixedQuerySender

nl.nn.adapterframework.jdbc.StoredProcedureQuerySender

All Implemented Interfaces:

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

public class StoredProcedureQuerySender
extends FixedQuerySender

StoredProcedureQuerySender is used to send stored procedure queries and retrieve the result.

The StoredProcedureQuerySender class has the following features:

• It supports setting the output parameters of the stored procedure by setting 'mode' attribute of the corresponding 'Param' to 'OUTPUT' or 'INOUT'.
• The queryType can only be 'SELECT' or 'OTHER'. Use 'SELECT' when the stored procedure returns a set of rows, use 'OTHER' if the stored procedure has one or more output parameters.

All stored procedure parameters that are not fixed, so specified in the query with a ?, should have a corresponding Parameter entry. Output parameters should have mode="OUTPUT", or mode="INOUT" depending on how the stored procedure is defined.

NOTE: See DB2XMLWriter for ResultSet!

Since:

7.9

Parameters

All parameters present are applied to the query to be executed.

Nested Class Summary

Nested classes/interfaces inherited from class nl.nn.adapterframework.jdbc.JdbcQuerySenderBase

JdbcQuerySenderBase.QueryType

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

HasStatistics.Action

Field Summary

Fields inherited from class nl.nn.adapterframework.jdbc.JdbcQuerySenderBase

UNP_END, UNP_START

Fields inherited from class nl.nn.adapterframework.jdbc.JdbcSenderBase

connection, paramList

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

log

Constructor Summary

Constructors

Constructor and Description
StoredProcedureQuerySender()

Method Summary

Modifier and Type	Method and Description
void	configure() configure() is called once at startup of the framework in the configure method of the owner of this sender.
protected Message	executeOtherQuery(Connection connection, PreparedStatement statement, String query, String resultQuery, PreparedStatement resStmt, Message message, PipeLineSession session, ParameterList parameterList)
protected PreparedStatement	prepareQueryWithColumnsReturned(Connection con, String query, String[] columnsReturned)
protected PreparedStatement	prepareQueryWithResultSet(Connection con, String query, int resultSetConcurrency)
void	setAvoidLocking(boolean avoidLocking) This feature is not supported for StoredProcedureQuerySender.
void	setBlobBase64Direction(Base64Pipe.Direction value) This feature is not supported for StoredProcedureQuerySender.
void	setBlobCharset(String string) This feature is not supported for StoredProcedureQuerySender.
void	setBlobColumn(int i) This feature is not supported for StoredProcedureQuerySender.
void	setBlobsCompressed(boolean b) This feature is not supported for StoredProcedureQuerySender.
void	setBlobSessionKey(String string) This feature is not supported for StoredProcedureQuerySender.
void	setBlobSmartGet(boolean b) This feature is not supported for StoredProcedureQuerySender.
void	setClobColumn(int i) This feature is not supported for StoredProcedureQuerySender.
void	setClobSessionKey(String string) This feature is not supported for StoredProcedureQuerySender.
void	setColumnsReturned(String string) This feature is not supported for StoredProcedureQuerySender.
void	setLockRows(boolean b) This feature is not supported for StoredProcedureQuerySender.
void	setLockWait(int i) This feature is not supported for StoredProcedureQuerySender.
void	setMaxRows(int i) This feature is not supported for StoredProcedureQuerySender.
void	setQuery(String query) A SQL statement that calls a stored procedure.
void	setQueryType(String queryType) The query type.
void	setRowIdSessionKey(String string) This feature is not supported for StoredProcedureQuerySender.
void	setStartRow(int i) This feature is not supported for StoredProcedureQuerySender.

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

canProvideOutputStream, closeBlock, closeStatementSet, getQuery, openBlock, sendMessage, sendMessage, setBatchSize

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

adjustQueryAndParameterListForNamedParameters, closeConnectionForSendMessage, convertQuery, executeOtherQuery, executePackageQuery, executeSelectQuery, executeSelectQuery, executeStatementSet, executeUpdateBlobQuery, executeUpdateClobQuery, fillParamArray, getBatchSize, getCallWithRowIdReturned, getConnectionForSendMessage, getQueryExecutionContext, getQueryTypeEnum, getResult, getResult, getResult, getReturnedColumns, getStatement, open, prepareQuery, provideOutputStream, setCloseInputstreamOnExit, setCloseOutputstreamOnExit, setIncludeFieldDefinition, setNullValue, setOutputFormat, setPackageContent, setPrettyPrint, setResultQuery, setScalar, setScalarExtended, setSqlDialect, setStreamCharset, setStreamResultToServlet, setSynchronous, setTrimSpaces, setUseNamedParams, supportsOutputStreamPassThrough

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

addParameter, close, getParameterList, getTimeout, sendMessage, setTimeout, 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.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.core.HasPhysicalDestination

getDomain

Constructor Detail

StoredProcedureQuerySender

public StoredProcedureQuerySender()

Method Detail

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 FixedQuerySender

Throws:

ConfigurationException

prepareQueryWithResultSet

protected PreparedStatement prepareQueryWithResultSet(Connection con,
                                                      String query,
                                                      int resultSetConcurrency)
                                               throws SQLException

Overrides:

prepareQueryWithResultSet in class JdbcQuerySenderBase<QueryExecutionContext>

Throws:

SQLException

prepareQueryWithColumnsReturned

protected PreparedStatement prepareQueryWithColumnsReturned(Connection con,
                                                            String query,
                                                            String[] columnsReturned)
                                                     throws SQLException

Overrides:

prepareQueryWithColumnsReturned in class JdbcQuerySenderBase<QueryExecutionContext>

Throws:

SQLException

executeOtherQuery

protected Message executeOtherQuery(Connection connection,
                                    PreparedStatement statement,
                                    String query,
                                    String resultQuery,
                                    PreparedStatement resStmt,
                                    Message message,
                                    PipeLineSession session,
                                    ParameterList parameterList)
                             throws SenderException

Overrides:

executeOtherQuery in class JdbcQuerySenderBase<QueryExecutionContext>

Throws:

SenderException

setQuery

public void setQuery(String query)

A SQL statement that calls a stored procedure. The statement should begin with the CALL or EXEC SQL keyword depending on SQL dialect. In case of doubt, the safe choice is to always start with CALL and choose Oracle dialect.

Overrides:

setQuery in class FixedQuerySender

Parameters:

query - The SQL statement to invoke the stored procedure.

setQueryType

public void setQueryType(String queryType)

The query type. For stored procedures, valid query types are JdbcQuerySenderBase.QueryType.SELECT and JdbcQuerySenderBase.QueryType.OTHER. Use JdbcQuerySenderBase.QueryType.SELECT when your stored procedure returns a row set (not supported by Oracle and PostgreSQL). Use JdbcQuerySenderBase.QueryType.OTHER when your stored procedure returns values via OUT or INOUT parameters, or does not return anything at all.

Using any other value will be rejected.

Overrides:

setQueryType in class JdbcQuerySenderBase<QueryExecutionContext>

Parameters:

queryType - The queryType.

setColumnsReturned

public void setColumnsReturned(String string)

This feature is not supported for StoredProcedureQuerySender.

Overrides:

setColumnsReturned in class JdbcQuerySenderBase<QueryExecutionContext>

setLockRows

public void setLockRows(boolean b)

This feature is not supported for StoredProcedureQuerySender.

Overrides:

setLockRows in class JdbcQuerySenderBase<QueryExecutionContext>

setLockWait

public void setLockWait(int i)

This feature is not supported for StoredProcedureQuerySender.

Overrides:

setLockWait in class JdbcQuerySenderBase<QueryExecutionContext>

setBlobColumn

public void setBlobColumn(int i)

This feature is not supported for StoredProcedureQuerySender.

Overrides:

setBlobColumn in class JdbcQuerySenderBase<QueryExecutionContext>

setBlobSessionKey

public void setBlobSessionKey(String string)

This feature is not supported for StoredProcedureQuerySender.

Overrides:

setBlobSessionKey in class JdbcQuerySenderBase<QueryExecutionContext>

setBlobsCompressed

public void setBlobsCompressed(boolean b)

This feature is not supported for StoredProcedureQuerySender.

Overrides:

setBlobsCompressed in class JdbcQuerySenderBase<QueryExecutionContext>

setBlobBase64Direction

public void setBlobBase64Direction(Base64Pipe.Direction value)

This feature is not supported for StoredProcedureQuerySender.

Overrides:

setBlobBase64Direction in class JdbcQuerySenderBase<QueryExecutionContext>

setBlobCharset

public void setBlobCharset(String string)

This feature is not supported for StoredProcedureQuerySender.

Overrides:

setBlobCharset in class JdbcQuerySenderBase<QueryExecutionContext>

setBlobSmartGet

public void setBlobSmartGet(boolean b)

This feature is not supported for StoredProcedureQuerySender.

Overrides:

setBlobSmartGet in class JdbcQuerySenderBase<QueryExecutionContext>

setClobColumn

public void setClobColumn(int i)

This feature is not supported for StoredProcedureQuerySender.

Overrides:

setClobColumn in class JdbcQuerySenderBase<QueryExecutionContext>

setClobSessionKey

public void setClobSessionKey(String string)

This feature is not supported for StoredProcedureQuerySender.

Overrides:

setClobSessionKey in class JdbcQuerySenderBase<QueryExecutionContext>

setAvoidLocking

public void setAvoidLocking(boolean avoidLocking)

This feature is not supported for StoredProcedureQuerySender.

Overrides:

setAvoidLocking in class JdbcQuerySenderBase<QueryExecutionContext>

setMaxRows

public void setMaxRows(int i)

This feature is not supported for StoredProcedureQuerySender.

Overrides:

setMaxRows in class JdbcQuerySenderBase<QueryExecutionContext>

setStartRow

public void setStartRow(int i)

This feature is not supported for StoredProcedureQuerySender.

Overrides:

setStartRow in class JdbcQuerySenderBase<QueryExecutionContext>

setRowIdSessionKey

public void setRowIdSessionKey(String string)

This feature is not supported for StoredProcedureQuerySender.

Overrides:

setRowIdSessionKey in class JdbcQuerySenderBase<QueryExecutionContext>