org.opends.quicksetup

Class CliUserInteraction

java.lang.Object

com.forgerock.opendj.cli.ConsoleApplication

org.opends.quicksetup.CliUserInteraction

All Implemented Interfaces:

UserInteraction

public class CliUserInteraction
extends com.forgerock.opendj.cli.ConsoleApplication
implements UserInteraction

Supports user interactions for a command line driven application.

Nested Class Summary

Nested classes/interfaces inherited from class com.forgerock.opendj.cli.ConsoleApplication

com.forgerock.opendj.cli.ConsoleApplication.Style

Nested classes/interfaces inherited from interface org.opends.quicksetup.UserInteraction

UserInteraction.MessageType

Constructor Summary

Constructors

Constructor and Description
CliUserInteraction(UserData ud) Creates an instance that will use standard streams for interaction and with the provided CLI arguments.

Method Summary

Methods

Modifier and Type	Method and Description
Object	confirm(LocalizableMessage summary, LocalizableMessage details, LocalizableMessage fineDetails, LocalizableMessage title, UserInteraction.MessageType type, LocalizableMessage[] options, LocalizableMessage def, LocalizableMessage viewDetailsOption) Present a list of choices to the user and wait for them to select one of them.
Object	confirm(LocalizableMessage summary, LocalizableMessage details, LocalizableMessage title, UserInteraction.MessageType type, LocalizableMessage[] options, LocalizableMessage def) Present a list of choices to the user and wait for them to select one of them.
String	createUnorderedList(List<?> list) Creates a list appropriate for the presentation implementation.
boolean	isAdvancedMode()
boolean	isCLI() Tells whether the interaction is command-line based.
boolean	isForceOnError() Indicates whether or not the CLI based user has requested to continue when a non critical error occurs.
boolean	isInteractive() Indicates whether or not the CLI user has requested interactive behavior.
boolean	isMenuDrivenMode()
boolean	isQuiet()
boolean	isScriptFriendly()
boolean	isVerbose()

Methods inherited from class com.forgerock.opendj.cli.ConsoleApplication

askConfirmation, askPort, confirmAction, errPrint, errPrintln, errPrintln, errPrintln, errPrintVerboseMessage, getErrorStream, getErrStream, getInputStream, getOutputStream, pressReturnToContinue, print, println, println, println, println, printProgressBar, printVerboseMessage, readInput, readInput, readLineOfInput, readPassword, readPassword, readPort, readValidatedInput, readValidatedInput

Methods inherited from class java.lang.Object

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

Constructor Detail

CliUserInteraction

public CliUserInteraction(UserData ud)

Creates an instance that will use standard streams for interaction and with the provided CLI arguments.

Parameters:

ud - The CLI arguments.

Method Detail

confirm

public Object confirm(LocalizableMessage summary,
             LocalizableMessage details,
             LocalizableMessage title,
             UserInteraction.MessageType type,
             LocalizableMessage[] options,
             LocalizableMessage def)

Present a list of choices to the user and wait for them to select one of them.

Specified by:

confirm in interface UserInteraction

Parameters:

summary - text to present to the user. This is usually just a string bug For GUI applications can be a component that will appear inside a dialog

details - more details of the message

title - of the prompt if any

type - of message

options - set of options to give the user

def - the default option from options

Returns:

Object that is the same value as the user selection from the options parameter.

confirm

public Object confirm(LocalizableMessage summary,
             LocalizableMessage details,
             LocalizableMessage fineDetails,
             LocalizableMessage title,
             UserInteraction.MessageType type,
             LocalizableMessage[] options,
             LocalizableMessage def,
             LocalizableMessage viewDetailsOption)

Present a list of choices to the user and wait for them to select one of them.

Specified by:

confirm in interface UserInteraction

Parameters:

summary - text to present to the user. This is usually just a string bug For GUI applications can be a component that will appear inside a dialog

details - more details of the message

fineDetails - even finer details. This text may be rendered in such a way that the user needs to take some sort of action to see this text

title - of the prompt if any

type - of message

options - set of options to give the user

def - the default option from options

viewDetailsOption - name of the option to be used for showing the details. If null a default will be used.

Returns:

Object that is the same value as the user selection from the options parameter.

createUnorderedList

public String createUnorderedList(List<?> list)

Creates a list appropriate for the presentation implementation.

Specified by:

createUnorderedList in interface UserInteraction

Parameters:

list - to format

Returns:

String representing the list

isAdvancedMode

public boolean isAdvancedMode()

Overrides:

isAdvancedMode in class com.forgerock.opendj.cli.ConsoleApplication

isInteractive

public boolean isInteractive()

Indicates whether or not the CLI user has requested interactive behavior.

Specified by:

isInteractive in interface UserInteraction

Overrides:

isInteractive in class com.forgerock.opendj.cli.ConsoleApplication

Returns:

true if the CLI user has requested interactive behavior.

isMenuDrivenMode

public boolean isMenuDrivenMode()

Overrides:

isMenuDrivenMode in class com.forgerock.opendj.cli.ConsoleApplication

isQuiet

public boolean isQuiet()

Overrides:

isQuiet in class com.forgerock.opendj.cli.ConsoleApplication

isScriptFriendly

public boolean isScriptFriendly()

Overrides:

isScriptFriendly in class com.forgerock.opendj.cli.ConsoleApplication

isVerbose

public boolean isVerbose()

Overrides:

isVerbose in class com.forgerock.opendj.cli.ConsoleApplication

isCLI

public boolean isCLI()

Tells whether the interaction is command-line based.

Specified by:

isCLI in interface UserInteraction

Returns:

true if the user interaction is command-line based and false otherwise.

isForceOnError

public boolean isForceOnError()

Indicates whether or not the CLI based user has requested to continue when a non critical error occurs.

Specified by:

isForceOnError in interface UserInteraction

Returns:

boolean where true indicates to continue if there is a non critical error.