org.azyva.dragom.execcontext.plugin

Interface UserInteractionCallbackPlugin

All Superinterfaces:

ExecContextPlugin

public interface UserInteractionCallbackPlugin
extends ExecContextPlugin

Allows interacting with the user during the execution of a job: - Providing information to the user - Requesting information from the user General parameters for jobs that are pertinent no matter the modules are meant to be provided as such, parameters. But depending on the situation, tools and plugins may require information that is too specific to be provided up front to the job by the user. In such a case an implementation of this interface can be used to request information from the user during job execution. Calls to the getInfo method are generally meant to actually prompt the user for information. But nothing prevents an implementation from gathering some information from the user up front and providing this information appropriately when getInfo is called. An implementation of this interface is meant to be set with ExecContext.setUserInteractionCallback.

Author:

David Raymond

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	UserInteractionCallbackPlugin.BracketHandle Represents a handle to an opened bracket or indentation in the output.

Method Summary

Modifier and Type	Method and Description
String	getInfo(String prompt) Obtains information from the user.
String	getInfoPassword(String prompt) Obtains sensitive information from the user which should not be echoed back.
String	getInfoWithDefault(String prompt, String defaultValue) Similar to getInfo(java.lang.String), but if the user enters nothing, the provided default value is returned.
boolean	isBatchMode()
void	provideInfo(String info) Provides information information to the user at a new indentation level.
Writer	provideInfoWithWriter(String info) Provides information to the user in a way similar to provideInfo(java.lang.String), but returns a Writer so that the caller can append additional information.
UserInteractionCallbackPlugin.BracketHandle	startBracket(String info) Provides information information to the user at a new indentation level.

Method Detail

startBracket

UserInteractionCallbackPlugin.BracketHandle startBracket(String info)

Provides information information to the user at a new indentation level.

Parameters:

info - Information.

Returns:

BracketHandle.

provideInfo

void provideInfo(String info)

Provides information information to the user at a new indentation level.

Parameters:

info - Information.

provideInfoWithWriter

Writer provideInfoWithWriter(String info)

Provides information to the user in a way similar to provideInfo(java.lang.String), but returns a Writer so that the caller can append additional information.

The caller is responsible for closing the Writer when done so that the plugin is able to associate all of the additional information with the initial call to this method. Calling close in this case should not close some underlying stream in such a way that would render the system unstable. Specifically if the Writer delegates to System.out, it must not delegate the close call. This use of close is specific to the contract with this class and does not necessarily respect the general contract of Writer.close.

No call to other methods of this plugin are allowed as long as the Writer is not closed.

Parameters:

info - See similar parameter for provideInfo.

Returns:

Writer.

getInfo

String getInfo(String prompt)

Obtains information from the user.

Only allowed if not isBatchMode().

Parameters:

prompt - Prompt.

Returns:

Information.

getInfoWithDefault

String getInfoWithDefault(String prompt,
                          String defaultValue)

Similar to getInfo(java.lang.String), but if the user enters nothing, the provided default value is returned.

Parameters:

prompt - Prompt.

defaultValue - Default value.

Returns:

Information.

getInfoPassword

String getInfoPassword(String prompt)

Obtains sensitive information from the user which should not be echoed back. Generally used for passwords.

Parameters:

prompt - Prompt.

Returns:

Information.

isBatchMode

boolean isBatchMode()

Returns:

Indicates if the plugin, which essentially is the interaction point with the user, operates in batch mode, meaning that calls to getInfo(java.lang.String) and getInfoWithDefault(java.lang.String, java.lang.String) are not allowed. Generally, caller should not worry about this and let these method fail if in batch mode. But some classes, such as DefaultCredetialStorePluginImpl, may need to know whether batch mode is enabled.