Class StoredProcExecutorSpec

java.lang.Object

org.springframework.integration.dsl.IntegrationComponentSpec<StoredProcExecutorSpec, StoredProcExecutor>

org.springframework.integration.jdbc.dsl.StoredProcExecutorSpec

All Implemented Interfaces:

DisposableBean, FactoryBean<StoredProcExecutor>, InitializingBean, Lifecycle, Phased, SmartLifecycle

public class StoredProcExecutorSpec
extends IntegrationComponentSpec<StoredProcExecutorSpec, StoredProcExecutor>

A StoredProcExecutor configurer.

Since:

7.0

Author:

Jiandong Ma, Artem Bilan

Field Summary

Fields inherited from class org.springframework.integration.dsl.IntegrationComponentSpec

logger, PARSER, target

Fields inherited from interface org.springframework.beans.factory.FactoryBean

OBJECT_TYPE_ATTRIBUTE

Fields inherited from interface org.springframework.context.SmartLifecycle

DEFAULT_PHASE

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	StoredProcExecutorSpec(DataSource dataSource)

Method Summary

Modifier and Type	Method	Description
StoredProcExecutorSpec	ignoreColumnMetaData(boolean ignoreColumnMetaData)
StoredProcExecutorSpec	isFunction(boolean isFunction)
StoredProcExecutorSpec	jdbcCallOperationsCacheSize(int jdbcCallOperationsCacheSize)
StoredProcExecutorSpec	procedureParameter(ProcedureParameter procedureParameter)	Add a ProcedureParameter parameter to the target StoredProcExecutor.
StoredProcExecutorSpec	procedureParameters(List<ProcedureParameter> procedureParameters)
StoredProcExecutorSpec	returningResultSetRowMapper(String returningResultName, RowMapper<?> rowMapper)	Add a RowMapper for specific returning result from stored procedure execution.
StoredProcExecutorSpec	returningResultSetRowMappers(Map<String, RowMapper<?>> returningResultSetRowMappers)
StoredProcExecutorSpec	returnValueRequired(boolean returnValueRequired)
StoredProcExecutorSpec	skipUndeclaredResults(boolean skipUndeclaredResults)
StoredProcExecutorSpec	sqlParameter(SqlParameter sqlParameter)	Add an SqlParameter to the target StoredProcExecutor.
StoredProcExecutorSpec	sqlParameters(List<SqlParameter> sqlParameters)
StoredProcExecutorSpec	sqlParameterSourceFactory(SqlParameterSourceFactory sqlParameterSourceFactory)
StoredProcExecutorSpec	storedProcedureName(String storedProcedureName)
StoredProcExecutorSpec	storedProcedureNameExpression(Expression storedProcedureNameExpression)
StoredProcExecutorSpec	usePayloadAsParameterSource(boolean usePayloadAsParameterSource)

Methods inherited from class org.springframework.integration.dsl.IntegrationComponentSpec

_this, afterPropertiesSet, destroy, doGet, getId, getObject, getObjectType, getPhase, id, isAutoStartup, isRunning, start, stop, stop

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.beans.factory.FactoryBean

isSingleton

Methods inherited from interface org.springframework.context.SmartLifecycle

isPauseable

Constructor Details

StoredProcExecutorSpec

protected StoredProcExecutorSpec(DataSource dataSource)

Method Details

ignoreColumnMetaData

public StoredProcExecutorSpec ignoreColumnMetaData(boolean ignoreColumnMetaData)

Parameters:

ignoreColumnMetaData - the ignoreColumnMetaData

Returns:

the storedProcExecutor

See Also:

• StoredProcExecutor.setIgnoreColumnMetaData(boolean)

procedureParameter

public StoredProcExecutorSpec procedureParameter(ProcedureParameter procedureParameter)

Add a ProcedureParameter parameter to the target StoredProcExecutor. This method can be called several times adding a new parameter each time.

Parameters:

procedureParameter - the stored procedure parameter to add

Returns:

the storedProcExecutor spec

See Also:

• StoredProcExecutor.setProcedureParameters(List)

procedureParameters

public StoredProcExecutorSpec procedureParameters(List<ProcedureParameter> procedureParameters)

Parameters:

procedureParameters - the procedureParameters

Returns:

the storedProcExecutor

See Also:

• StoredProcExecutor.setProcedureParameters(List)

sqlParameter

public StoredProcExecutorSpec sqlParameter(SqlParameter sqlParameter)

Add an SqlParameter to the target StoredProcExecutor. This method can be called several times adding a new parameter each time.

Parameters:

sqlParameter - the SqlParameter to add

Returns:

the storedProcExecutor

See Also:

• StoredProcExecutor.setSqlParameters(List)

sqlParameters

public StoredProcExecutorSpec sqlParameters(List<SqlParameter> sqlParameters)

Parameters:

sqlParameters - the sqlParameters

Returns:

the storedProcExecutor

See Also:

• StoredProcExecutor.setSqlParameters(List)

sqlParameterSourceFactory

public StoredProcExecutorSpec sqlParameterSourceFactory(SqlParameterSourceFactory sqlParameterSourceFactory)

Parameters:

sqlParameterSourceFactory - the sqlParameterSourceFactory

Returns:

the storedProcExecutor

See Also:

• StoredProcExecutor.setSqlParameterSourceFactory(SqlParameterSourceFactory)

storedProcedureName

public StoredProcExecutorSpec storedProcedureName(String storedProcedureName)

Parameters:

storedProcedureName - the storedProcedureName

Returns:

the storedProcExecutor

See Also:

• StoredProcExecutor.setStoredProcedureName(String)

storedProcedureNameExpression

public StoredProcExecutorSpec storedProcedureNameExpression(Expression storedProcedureNameExpression)

Parameters:

storedProcedureNameExpression - the storedProcedureNameExpression

Returns:

the storedProcExecutor

See Also:

• StoredProcExecutor.setStoredProcedureNameExpression(Expression)

usePayloadAsParameterSource

public StoredProcExecutorSpec usePayloadAsParameterSource(boolean usePayloadAsParameterSource)

Parameters:

usePayloadAsParameterSource - the usePayloadAsParameterSource

Returns:

the storedProcExecutor

See Also:

• StoredProcExecutor.setUsePayloadAsParameterSource(boolean)

isFunction

public StoredProcExecutorSpec isFunction(boolean isFunction)

Parameters:

isFunction - the isFunction

Returns:

the storedProcExecutor

See Also:

• StoredProcExecutor.setIsFunction(boolean)

returnValueRequired

public StoredProcExecutorSpec returnValueRequired(boolean returnValueRequired)

Parameters:

returnValueRequired - the returnValueRequired

Returns:

the storedProcExecutor

See Also:

• StoredProcExecutor.setReturnValueRequired(boolean)

skipUndeclaredResults

public StoredProcExecutorSpec skipUndeclaredResults(boolean skipUndeclaredResults)

Parameters:

skipUndeclaredResults - the skipUndeclaredResults

Returns:

the storedProcExecutor

See Also:

• StoredProcExecutor.setSkipUndeclaredResults(boolean)

returningResultSetRowMapper

public StoredProcExecutorSpec returningResultSetRowMapper(String returningResultName,
 RowMapper<?> rowMapper)

Add a RowMapper for specific returning result from stored procedure execution.

Parameters:

returningResultName - the name of procedure output parameter for returning result

rowMapper - the RowMapper for returning result

Returns:

the storedProcExecutor

See Also:

• StoredProcExecutor.setReturningResultSetRowMappers(Map)

returningResultSetRowMappers

public StoredProcExecutorSpec returningResultSetRowMappers(Map<String, RowMapper<?>> returningResultSetRowMappers)

Parameters:

returningResultSetRowMappers - the returningResultSetRowMappers

Returns:

the storedProcExecutor

See Also:

• StoredProcExecutor.setReturningResultSetRowMappers(Map)

jdbcCallOperationsCacheSize

public StoredProcExecutorSpec jdbcCallOperationsCacheSize(int jdbcCallOperationsCacheSize)

Parameters:

jdbcCallOperationsCacheSize - the jdbcCallOperationsCacheSize

Returns:

the storedProcExecutor

See Also:

• StoredProcExecutor.setJdbcCallOperationsCacheSize(int)