flux

Interface DatabaseActionInfo

All Superinterfaces:

Action, java.lang.Cloneable, RuntimeDataMap, java.io.Serializable

All Known Subinterfaces:

DatabaseConditionAction, DatabaseConditionTrigger, DatabaseQueryAction, DatabaseQueryCollectionAction, DatabaseStoredProcedureAction, DatabaseUpdateAction

public interface DatabaseActionInfo
extends Action

Abstract interface that defines methods to provide database actions with information about how to connect to a database. By default, the database connection from the flow context is used. Alternately, a data source or JDBC connection information to a different database can be specified.

Author:

Copyright 2000-2025 Flux Corporation. All rights reserved.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDataSource() Returns the name of an application server's data source used to retrieve database connections.
java.lang.String	getDataSourceInitialContextFactory() Returns the initial context factory used to lookup an application server's data source for retrieving database connections.
java.lang.String	getDataSourceInitialContextPassword() Returns the password used to access an application server.
java.lang.String	getDataSourceInitialContextProviderUrl() Returns the network location used to lookup an application server's data source for retrieving database connections.
java.lang.String	getDataSourceInitialContextUsername() Returns the username used to access an application server.
java.lang.String	getDataSourcePassword() Returns the password used to access a data source in an application server.
java.lang.String	getDataSourceUsername() Returns the username used to access a data source in an application server.
java.lang.String	getJdbcDriver() Returns the JDBC driver class name that is used to lookup direct connections to a database.
java.lang.String	getJdbcPassword() Returns the password that is used to lookup direct connections to a database.
java.lang.String	getJdbcUrl() Returns the network location of a database for looking up direct connections to a database.
java.lang.String	getJdbcUsername() Returns the username that is used to lookup direct connections to a database.
boolean	isBuiltinDatabaseConnectionUsed() Indicates whether the database connection from the flow context, and thus the engine that is running this action, is used.
void	setBuiltinDatabaseConnectionUsed(boolean enabled) Sets whether the database connection from the flow context, and thus the engine that is running this action, is used.
void	setDataSource(java.lang.String dataSource) Sets the name of an application server's data source used to retrieve database connections.
void	setDataSourceInitialContextFactory(java.lang.String initialContextFactory) Sets the initial context factory used to lookup an application server's data source for retrieving database connections.
void	setDataSourceInitialContextPassword(java.lang.String initialContextPassword) Sets the password used to access an application server.
void	setDataSourceInitialContextProviderUrl(java.lang.String providerUrl) Sets the network location used to lookup an application server's data source for retrieving database connections.
void	setDataSourceInitialContextUsername(java.lang.String initialContextUsername) Sets the username used to access an application server.
void	setDataSourcePassword(java.lang.String password) Sets the password used to access a data source in an application server.
void	setDataSourceUsername(java.lang.String username) Sets the username used to access a data source in an application server.
void	setJdbcDriver(java.lang.String driver) Sets the JDBC driver class name that is used to lookup direct connections to a database.
void	setJdbcPassword(java.lang.String jdbcPassword) Sets the password that is used to lookup direct connections to a database.
void	setJdbcUrl(java.lang.String url) Sets the network location of the database for looking up direct connections to a database.
void	setJdbcUsername(java.lang.String jdbcUsername) Sets the username that is used to lookup direct connections to a database.

Methods inherited from interface flux.Action

addFlow, addFlow, addSignalFlow, clone, execute, getDescription, getFlows, getHiddenVariableNames, getJoinExpression, getName, getPostscript, getPostscriptLanguage, getPrescript, getPrescriptLanguage, getResultInfo, getSignalsToMonitor, getTimeoutBusinessInterval, getTimeoutBusinessIntervalNamespace, getTimeoutExpression, getVariableManager, isEndOfRun, isJoinPoint, isSkippable, isStartAction, isStartOfRun, isTransactionBreak, removeFlow, reset, setDescription, setElseFlow, setEndOfRun, setErrorFlow, setErrorFlowWithoutRollback, setErrorFlowWithRollback, setJoinExpression, setJoinPoint, setName, setPostscript, setPostscriptLanguage, setPrescript, setPrescriptLanguage, setSignalsToMonitor, setSkippable, setStartAction, setStartOfRun, setTimeoutBusinessInterval, setTimeoutBusinessIntervalNamespace, setTimeoutExpression, setTimeoutFlow, setTransactionBreak, verify, verifyOnClient

Methods inherited from interface flux.runtimedatamap.RuntimeDataMap

getRuntimeDataMap, setRuntimeDataMap

Method Detail

getDataSource

java.lang.String getDataSource()

Returns the name of an application server's data source used to retrieve database connections.

Returns:

An application server's data source used to retrieve database connections.

getDataSourceInitialContextFactory

java.lang.String getDataSourceInitialContextFactory()

Returns the initial context factory used to lookup an application server's data source for retrieving database connections.

Returns:

The initial context factory used to lookup an application server's data source for retrieving database connections.

getDataSourceInitialContextPassword

java.lang.String getDataSourceInitialContextPassword()

Returns the password used to access an application server.

Returns:

The password used to access an application server.

getDataSourceInitialContextProviderUrl

java.lang.String getDataSourceInitialContextProviderUrl()

Returns the network location used to lookup an application server's data source for retrieving database connections.

Returns:

The network location used to lookup an application server's data source for retrieving database connections.

getDataSourceInitialContextUsername

java.lang.String getDataSourceInitialContextUsername()

Returns the username used to access an application server.

Returns:

The username used to access an application server.

getDataSourcePassword

java.lang.String getDataSourcePassword()

Returns the password used to access a data source in an application server.

Returns:

The password used to access a data source in an application server.

getDataSourceUsername

java.lang.String getDataSourceUsername()

Returns the username used to access a data source in an application server.

Returns:

The username used to access a data source in an application server.

getJdbcDriver

java.lang.String getJdbcDriver()

Returns the JDBC driver class name that is used to lookup direct connections to a database.

Returns:

The JDBC driver class name that is used to lookup direct connections to a database.

getJdbcPassword

java.lang.String getJdbcPassword()

Returns the password that is used to lookup direct connections to a database.

Returns:

The password that is used to lookup direct connections to a database.

getJdbcUrl

java.lang.String getJdbcUrl()

Returns the network location of a database for looking up direct connections to a database.

Returns:

The network location of the database for looking up direct connections to a database.

getJdbcUsername

java.lang.String getJdbcUsername()

Returns the username that is used to lookup direct connections to a database.

Returns:

The username that is used to lookup direct connections to a database.

isBuiltinDatabaseConnectionUsed

boolean isBuiltinDatabaseConnectionUsed()

Indicates whether the database connection from the flow context, and thus the engine that is running this action, is used.

Returns:

Whether the database connection from the flow context is used.

setBuiltinDatabaseConnectionUsed

void setBuiltinDatabaseConnectionUsed(boolean enabled)

Sets whether the database connection from the flow context, and thus the engine that is running this action, is used.

Parameters:

enabled - An indication whether the database connection from the flow context is used.

setDataSource

void setDataSource(java.lang.String dataSource)

Sets the name of an application server's data source used to retrieve database connections.

Parameters:

dataSource - An application server's data source used to retrieve database connections.

setDataSourceInitialContextFactory

void setDataSourceInitialContextFactory(java.lang.String initialContextFactory)

Sets the initial context factory used to lookup an application server's data source for retrieving database connections.

Parameters:

initialContextFactory - The initial context factory used to lookup an application server's data source for retrieving database connections.

setDataSourceInitialContextPassword

void setDataSourceInitialContextPassword(java.lang.String initialContextPassword)

Sets the password used to access an application server.

Parameters:

initialContextPassword - The password used to access an application server.

setDataSourceInitialContextProviderUrl

void setDataSourceInitialContextProviderUrl(java.lang.String providerUrl)

Sets the network location used to lookup an application server's data source for retrieving database connections.

Parameters:

providerUrl - The network location used to lookup an application server's data source for retrieving database connections.

setDataSourceInitialContextUsername

void setDataSourceInitialContextUsername(java.lang.String initialContextUsername)

Sets the username used to access an application server.

Parameters:

initialContextUsername - The username used to access an application server.

setDataSourcePassword

void setDataSourcePassword(java.lang.String password)

Sets the password used to access a data source in an application server.

Parameters:

password - The password used to access a data source in an application server.

setDataSourceUsername

void setDataSourceUsername(java.lang.String username)

Sets the username used to access a data source in an application server.

Parameters:

username - The username used to access a data source in an application server.

setJdbcDriver

void setJdbcDriver(java.lang.String driver)

Sets the JDBC driver class name that is used to lookup direct connections to a database.

Parameters:

driver - The JDBC driver class name that is used to lookup direct connections to a database.

setJdbcPassword

void setJdbcPassword(java.lang.String jdbcPassword)

Sets the password that is used to lookup direct connections to a database.

Parameters:

jdbcPassword - The password that is used to lookup direct connections to a database.

setJdbcUrl

void setJdbcUrl(java.lang.String url)

Sets the network location of the database for looking up direct connections to a database.

Parameters:

url - The network location of the database for looking up direct connections to a database.

setJdbcUsername

void setJdbcUsername(java.lang.String jdbcUsername)

Sets the username that is used to lookup direct connections to a database.

Parameters:

jdbcUsername - The username that is used to lookup direct connections to a database.