Package com.sun.identity.install.tools.configurator

Class UserResponseInteraction

java.lang.Object

com.sun.identity.install.tools.configurator.BaseInteraction

com.sun.identity.install.tools.configurator.UserResponseInteraction

Direct Known Subclasses:

DisplaySummaryHandler, TaskInteraction

public abstract class UserResponseInteraction
extends BaseInteraction

Constructor Summary

Constructors

Constructor	Description
UserResponseInteraction()

Method Summary

Modifier and Type	Method	Description
protected InteractionResultStatus	confirmOnExitStatus(InteractionResultStatus status, IStateAccess state)
void	displayMessages()
String	getPromptValue(IStateAccess state)	Method that needs to be implemented by the sub-classes to return a prompt value (default value) that needs to be displayed for the user to input data.
protected abstract Map	getResultStatusMap()	Method that needs to be implemented by the sub-classes to intialize the result status Map.
InteractionResultStatus	interact(IStateAccess state)

Methods inherited from class com.sun.identity.install.tools.configurator.BaseInteraction

displayOptionsHelp, displayPromptMessage, getDisplayMessages, getPromptMessage, getUserOptions

Methods inherited from class java.lang.Object

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

Constructor Detail

UserResponseInteraction

public UserResponseInteraction()

Method Detail

getResultStatusMap

protected abstract Map getResultStatusMap()

Method that needs to be implemented by the sub-classes to intialize the result status Map. The map should be constructed with key = display item of a UserOption with value of InteractionResultStatus object that corresponds to that UserOption.

Returns:

a Map constructed with <UserOption display Item, InteractionResultStatus>.

interact

public InteractionResultStatus interact(IStateAccess state)
                                 throws InstallException

Throws:

InstallException

displayMessages

public void displayMessages()

Overrides:

displayMessages in class BaseInteraction

confirmOnExitStatus

protected InteractionResultStatus confirmOnExitStatus(InteractionResultStatus status,
                                                      IStateAccess state)
                                               throws InstallException

Throws:

InstallException

getPromptValue

public String getPromptValue(IStateAccess state)
                      throws InstallException

Description copied from class: BaseInteraction

Method that needs to be implemented by the sub-classes to return a prompt value (default value) that needs to be displayed for the user to input data. If the prompt value other than null is returned then the prompt message will be some thing as in Example shown below: Enter the Server Port [8080]:

Specified by:

getPromptValue in class BaseInteraction

Parameters:

state - IStateAccess

Returns:

a String containing the default value or null if no value is present.

Throws:

InstallException - TODO