Package adams.flow.core

Interface OptionalPasswordPrompt

All Superinterfaces:

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

All Known Implementing Classes:

AbstractDatabaseConnection, DatabaseConnection, FTPConnection, SMBConnection, SMTPConnection, SSHConnection

public interface OptionalPasswordPrompt
extends InteractiveActor

Interface for actors that prompt the user to enter a password in case no password currently provided.

Author:

fracpete (fracpete at waikato dot ac dot nz)

Field Summary

Fields inherited from interface adams.flow.core.Actor

FILE_EXTENSION, FILE_EXTENSION_GZ

Fields inherited from interface adams.flow.core.InteractiveActor

INTERACTION_CANCELED

Method Summary

Modifier and Type	Method	Description
boolean	getPromptForPassword()	Returns whether to prompt for a password if none currently provided.
String	promptForPasswordTipText()	Returns the tip text for this property.
void	setPromptForPassword(boolean value)	Sets whether to prompt for a password if none currently provided.

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, getQuickInfo, 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, wrapUp

Methods inherited from interface adams.core.AdditionalInformationHandler

getAdditionalInformation

Methods inherited from interface adams.flow.core.InteractiveActor

customStopMessageTipText, doInteract, doInteractHeadless, getCustomStopMessage, getStopFlowIfCanceled, setCustomStopMessage, setStopFlowIfCanceled, stopFlowIfCanceledTipText, supportsHeadlessInteraction

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, defineOptions, getOptionManager

Methods inherited from interface adams.flow.core.StopModeSupporter

getStopMode, setStopMode, stopModeTipText

Methods inherited from interface adams.core.VariablesInspectionHandler

canInspectOptions

Method Detail

setPromptForPassword

void setPromptForPassword(boolean value)

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

Parameters:

value - true if to prompt for a password

getPromptForPassword

boolean getPromptForPassword()

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

Returns:

true if to prompt for a password

promptForPasswordTipText

String promptForPasswordTipText()

Returns the tip text for this property.

Returns:

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