Package adams.flow.standalone

Class AbstractDatabaseConnection

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.flow.core.AbstractActor

adams.flow.standalone.AbstractStandalone

adams.flow.standalone.AbstractDatabaseConnection

All Implemented Interfaces:

AdditionalInformationHandler, CleanUpHandler, Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, PasswordPrompter, PasswordSupporter, QuickInfoSupporter, ShallowCopySupporter<Actor>, SizeOfHandler, Stoppable, StoppableWithFeedback, VariablesInspectionHandler, VariableChangeListener, Actor, ErrorHandler, InteractiveActor, OptionalPasswordPrompt, StopModeSupporter, Serializable, Comparable

Direct Known Subclasses:

DatabaseConnection

public abstract class AbstractDatabaseConnection
extends AbstractStandalone
implements OptionalPasswordPrompt, PasswordPrompter

Ancestor for standalone actors providing a database connection different from the system-wide one.

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected BasePassword	m_ActualPassword	the actual SMTP password to use.
protected boolean	m_CloseConnection	whether to close the connection when the flow wraps up.
protected AbstractDatabaseConnection	m_Connection	the database connection in use.
protected String	m_CustomStopMessage	the custom stop message to use if flow gets stopped due to cancelation.
protected AbstractDataTypeSetup	m_DataTypeSetup	the data type setup to apply.
protected BasePassword	m_Password	database password.
protected boolean	m_PromptForPassword	whether to prompt the user for a password if none provided.
protected boolean	m_StopFlowIfCanceled	whether to stop the flow if canceled.
protected StopMode	m_StopMode	how to perform the stop.
protected JdbcUrl	m_URL	the URL to connect to the database.
protected String	m_User	database username.

Fields inherited from class adams.flow.core.AbstractActor

m_Annotations, m_BackupState, m_DetectedObjectVariables, m_DetectedVariables, m_ErrorHandler, m_Executed, m_Executing, m_ExecutionListeningSupporter, m_FullName, m_LoggingPrefix, m_Name, m_Parent, m_ScopeHandler, m_Self, m_Silent, m_Skip, m_StopFlowOnError, m_StopMessage, m_Stopped, m_StorageHandler, m_VariablesUpdated

Fields inherited from class adams.core.option.AbstractOptionHandler

m_OptionManager

Fields inherited from class adams.core.logging.LoggingObject

m_Logger, m_LoggingIsEnabled, m_LoggingLevel

Fields inherited from interface adams.flow.core.Actor

FILE_EXTENSION, FILE_EXTENSION_GZ

Fields inherited from interface adams.flow.core.InteractiveActor

INTERACTION_CANCELED

Constructor Summary

Constructors

Constructor	Description
AbstractDatabaseConnection()

Method Summary

Modifier and Type	Method	Description
String	closeConnectionTipText()	Returns the tip text for this property.
String	customStopMessageTipText()	Returns the tip text for this property.
String	dataTypeSetupTipText()	Returns the tip text for this property.
void	defineOptions()	Adds options to the internal list of options.
protected String	doExecute()	Executes the actor.
String	doInteract()	Performs the interaction with the user.
String	doInteractHeadless()	Performs the interaction with the user in a headless environment.
boolean	getCloseConnection()	Returns whether to close the connection once the flow wraps up.
AbstractDatabaseConnection	getConnection()	Returns the database connection in use.
String	getCustomStopMessage()	Returns the custom message to use when stopping the flow.
AbstractDataTypeSetup	getDataTypeSetup()	Returns the data type setup to apply to the connection.
BasePassword	getPassword()	Returns the database password.
boolean	getPromptForPassword()	Returns whether to prompt for a password if none currently provided.
String	getQuickInfo()	Returns a quick info about the actor, which will be displayed in the GUI.
String	getResolvedURL()	Expands variables and placeholders.
boolean	getStopFlowIfCanceled()	Returns whether to stop the flow if dialog canceled.
StopMode	getStopMode()	Returns the stop mode.
JdbcUrl	getURL()	Returns the database URL.
String	getUser()	Returns the database user.
String	passwordTipText()	Returns the tip text for this property.
String	promptForPasswordTipText()	Returns the tip text for this property.
protected abstract AbstractDatabaseConnection	retrieveConnection()	Returns the database connection in use.
void	setCloseConnection(boolean value)	Sets whether to close the connection once the flow wraps up.
void	setCustomStopMessage(String value)	Sets the custom message to use when stopping the flow.
void	setDataTypeSetup(AbstractDataTypeSetup value)	Sets the data type setup to apply to the connection.
void	setPassword(BasePassword value)	Sets the database password.
void	setPromptForPassword(boolean value)	Sets whether to prompt for a password if none currently provided.
void	setStopFlowIfCanceled(boolean value)	Sets whether to stop the flow if dialog canceled.
void	setStopMode(StopMode value)	Sets the stop mode.
void	setURL(JdbcUrl value)	Sets the database URL.
void	setUser(String value)	Sets the database user.
String	stopFlowIfCanceledTipText()	Returns the tip text for this property.
String	stopModeTipText()	Returns the tip text for this property.
boolean	supportsHeadlessInteraction()	Returns whether headless interaction is supported.
String	URLTipText()	Returns the tip text for this property.
String	userTipText()	Returns the tip text for this property.
void	wrapUp()	Cleans up after the execution has finished.

Methods inherited from class adams.flow.standalone.AbstractStandalone

preExecute

Methods inherited from class adams.flow.core.AbstractActor

annotationsTipText, backupState, canInspectOptions, canPerformSetUpCheck, cleanUp, compareTo, configureLogger, destroy, equals, execute, finalUpdateVariables, findVariables, findVariables, forceVariables, forCommandLine, forName, forName, getAdditionalInformation, getAnnotations, getDefaultName, getDetectedVariables, getErrorHandler, getFlowActors, getFlowExecutionListeningSupporter, getFullName, getName, getNextSibling, getParent, getParentComponent, getPreviousSibling, getRoot, getScopeHandler, getSilent, getSkip, getStopFlowOnError, getStopMessage, getStorageHandler, getVariables, handleError, handleException, hasErrorHandler, hasStopMessage, index, initialize, isBackedUp, isExecuted, isExecuting, isFinished, isHeadless, isStopped, nameTipText, performSetUpChecks, performVariableChecks, postExecute, pruneBackup, pruneBackup, reset, restoreState, setAnnotations, setErrorHandler, setName, setParent, setSilent, setSkip, setStopFlowOnError, setUp, setVariables, shallowCopy, shallowCopy, silentTipText, sizeOf, skipTipText, stopExecution, stopExecution, stopFlowOnErrorTipText, updateDetectedVariables, updatePrefix, updateVariables, variableChanged

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, finishInit, getDefaultLoggingLevel, getOptionManager, globalInfo, loggingLevelTipText, newOptionManager, setLoggingLevel, toCommandLine, toString

Methods inherited from class adams.core.logging.LoggingObject

getLogger, getLoggingLevel, initializeLogging, isLoggingEnabled

Methods inherited from class java.lang.Object

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

Methods inherited from interface adams.flow.core.Actor

cleanUp, compareTo, destroy, equals, execute, findVariables, getAnnotations, getDefaultName, getDetectedVariables, getErrorHandler, getFlowExecutionListeningSupporter, getFullName, getName, getNextSibling, getParent, getParentComponent, getPreviousSibling, getRoot, getScopeHandler, getSilent, getSkip, getStopFlowOnError, getStopMessage, getStorageHandler, getVariables, handleError, hasErrorHandler, hasStopMessage, index, isExecuted, isFinished, isHeadless, isStopped, setAnnotations, setErrorHandler, setName, setParent, setSilent, setSkip, setStopFlowOnError, setUp, setVariables, shallowCopy, shallowCopy, sizeOf, stopExecution, stopExecution, toCommandLine, variableChanged

Methods inherited from interface adams.core.AdditionalInformationHandler

getAdditionalInformation

Methods inherited from interface adams.core.logging.LoggingLevelHandler

getLoggingLevel, setLoggingLevel

Methods inherited from interface adams.core.logging.LoggingSupporter

getLogger, isLoggingEnabled

Methods inherited from interface adams.core.option.OptionHandler

cleanUpOptions, getOptionManager

Methods inherited from interface adams.core.VariablesInspectionHandler

canInspectOptions

Field Detail

m_URL

protected JdbcUrl m_URL

the URL to connect to the database.

m_User

protected String m_User

database username.

m_Password

protected BasePassword m_Password

database password.

m_ActualPassword

protected BasePassword m_ActualPassword

the actual SMTP password to use.

m_PromptForPassword

protected boolean m_PromptForPassword

whether to prompt the user for a password if none provided.

m_StopFlowIfCanceled

protected boolean m_StopFlowIfCanceled

whether to stop the flow if canceled.

m_CustomStopMessage

protected String m_CustomStopMessage

the custom stop message to use if flow gets stopped due to cancelation.

m_StopMode

protected StopMode m_StopMode

how to perform the stop.

m_DataTypeSetup

protected AbstractDataTypeSetup m_DataTypeSetup

the data type setup to apply.

m_CloseConnection

protected boolean m_CloseConnection

whether to close the connection when the flow wraps up.

m_Connection

protected transient AbstractDatabaseConnection m_Connection

the database connection in use.

Constructor Detail

AbstractDatabaseConnection

public AbstractDatabaseConnection()

Method Detail

defineOptions

public void defineOptions()

Adds options to the internal list of options.

Specified by:

defineOptions in interface OptionHandler

Overrides:

defineOptions in class AbstractActor

getQuickInfo

public String getQuickInfo()

Returns a quick info about the actor, which will be displayed in the GUI.

Specified by:

getQuickInfo in interface Actor

Specified by:

getQuickInfo in interface QuickInfoSupporter

Overrides:

getQuickInfo in class AbstractActor

Returns:

null if no info available, otherwise short string

setURL

public void setURL(JdbcUrl value)

Sets the database URL.

Parameters:

value - the URL

getURL

public JdbcUrl getURL()

Returns the database URL.

Returns:

the URL

URLTipText

public String URLTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the GUI or for listing the options.

getResolvedURL

public String getResolvedURL()

Expands variables and placeholders.

Returns:

the fully resolved URL

setUser

public void setUser(String value)

Sets the database user.

Parameters:

value - the user

getUser

public String getUser()

Returns the database user.

Returns:

the user

userTipText

public String userTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the GUI or for listing the options.

setPassword

public void setPassword(BasePassword value)

Sets the database password.

Specified by:

setPassword in interface PasswordSupporter

Parameters:

value - the password

getPassword

public BasePassword getPassword()

Returns the database password.

Specified by:

getPassword in interface PasswordSupporter

Returns:

the password

passwordTipText

public String passwordTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the GUI or for listing the options.

setPromptForPassword

public void setPromptForPassword(boolean value)

Sets whether to prompt for a password if none currently provided.

Specified by:

setPromptForPassword in interface OptionalPasswordPrompt

Specified by:

setPromptForPassword in interface PasswordPrompter

Parameters:

value - true if to prompt for a password

getPromptForPassword

public boolean getPromptForPassword()

Returns whether to prompt for a password if none currently provided.

Specified by:

getPromptForPassword in interface OptionalPasswordPrompt

Specified by:

getPromptForPassword in interface PasswordPrompter

Returns:

true if to prompt for a password

promptForPasswordTipText

public String promptForPasswordTipText()

Returns the tip text for this property.

Specified by:

promptForPasswordTipText in interface OptionalPasswordPrompt

Specified by:

promptForPasswordTipText in interface PasswordPrompter

Returns:

tip text for this property suitable for displaying in the GUI or for listing the options.

setDataTypeSetup

public void setDataTypeSetup(AbstractDataTypeSetup value)

Sets the data type setup to apply to the connection.

Parameters:

value - the setup

getDataTypeSetup

public AbstractDataTypeSetup getDataTypeSetup()

Returns the data type setup to apply to the connection.

Returns:

the setup

dataTypeSetupTipText

public String dataTypeSetupTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the GUI or for listing the options.

setStopFlowIfCanceled

public void setStopFlowIfCanceled(boolean value)

Sets whether to stop the flow if dialog canceled.

Specified by:

setStopFlowIfCanceled in interface InteractiveActor

Parameters:

value - if true flow gets stopped if dialog canceled

getStopFlowIfCanceled

public boolean getStopFlowIfCanceled()

Returns whether to stop the flow if dialog canceled.

Specified by:

getStopFlowIfCanceled in interface InteractiveActor

Returns:

true if the flow gets stopped if dialog canceled

stopFlowIfCanceledTipText

public String stopFlowIfCanceledTipText()

Returns the tip text for this property.

Specified by:

stopFlowIfCanceledTipText in interface InteractiveActor

Returns:

tip text for this property suitable for displaying in the GUI or for listing the options.

setCustomStopMessage

public void setCustomStopMessage(String value)

Sets the custom message to use when stopping the flow.

Specified by:

setCustomStopMessage in interface InteractiveActor

Parameters:

value - the stop message

getCustomStopMessage

public String getCustomStopMessage()

Returns the custom message to use when stopping the flow.

Specified by:

getCustomStopMessage in interface InteractiveActor

Returns:

the stop message

customStopMessageTipText

public String customStopMessageTipText()

Returns the tip text for this property.

Specified by:

customStopMessageTipText in interface InteractiveActor

Returns:

tip text for this property suitable for displaying in the GUI or for listing the options.

setStopMode

public void setStopMode(StopMode value)

Sets the stop mode.

Specified by:

setStopMode in interface StopModeSupporter

Parameters:

value - the mode

getStopMode

public StopMode getStopMode()

Returns the stop mode.

Specified by:

getStopMode in interface StopModeSupporter

Returns:

the mode

stopModeTipText

public String stopModeTipText()

Returns the tip text for this property.

Specified by:

stopModeTipText in interface StopModeSupporter

Returns:

tip text for this property suitable for displaying in the GUI or for listing the options.

setCloseConnection

public void setCloseConnection(boolean value)

Sets whether to close the connection once the flow wraps up.

Parameters:

value - true if to close

getCloseConnection

public boolean getCloseConnection()

Returns whether to close the connection once the flow wraps up.

Returns:

true if to close

closeConnectionTipText

public String closeConnectionTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the GUI or for listing the options.

doInteract

public String doInteract()

Performs the interaction with the user.

Specified by:

doInteract in interface InteractiveActor

Returns:

true if successfully interacted

supportsHeadlessInteraction

public boolean supportsHeadlessInteraction()

Returns whether headless interaction is supported.

Specified by:

supportsHeadlessInteraction in interface InteractiveActor

Returns:

true if interaction in headless environment is possible

doInteractHeadless

public String doInteractHeadless()

Performs the interaction with the user in a headless environment.

Specified by:

doInteractHeadless in interface InteractiveActor

Returns:

true if successfully interacted

doExecute

protected String doExecute()

Executes the actor.

Specified by:

doExecute in class AbstractActor

Returns:

null if everything is fine, otherwise error message

retrieveConnection

protected abstract AbstractDatabaseConnection retrieveConnection()

Returns the database connection in use. Reconnects the database, to make sure that the database connection is the correct one.

Returns:

the connection object

getConnection

public AbstractDatabaseConnection getConnection()

Returns the database connection in use. Reconnects the database, to make sure that the database connection is the correct one.

Returns:

the connection object

wrapUp

public void wrapUp()

Cleans up after the execution has finished. Graphical output is left untouched.

Specified by:

wrapUp in interface Actor

Overrides:

wrapUp in class AbstractActor