com.sun.identity.install.tools.configurator

Class ConfirmInteraction

java.lang.Object

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

com.sun.identity.install.tools.configurator.ConfirmInteraction

public class ConfirmInteraction
extends BaseInteraction

Constructor Summary

Constructors

Constructor and Description
ConfirmInteraction()

Method Summary

Modifier and Type	Method and Description
ArrayList	getDisplayMessages() Method that needs to be implemented by the sub-classes to return the Localized Messages that need to be displayed as part of the interaction.
LocalizedMessage	getPromptMessage(IStateAccess state) Method that needs to be implemented by the sub-classes to return the prompt message that needs to be displayed for the user to input data.
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.
BaseOptions	getUserOptions(IStateAccess state) Method that needs to be implemented by the sub-classes to return the ResponseOption's and return the appropriate BaseOptions. * viz., SingleLineOptions & MutliLineOptions.
InteractionResultStatus	interact(IStateAccess state)

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

displayMessages, displayOptionsHelp, displayPromptMessage

Methods inherited from class java.lang.Object

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

Constructor Detail

ConfirmInteraction

public ConfirmInteraction()

Method Detail

getDisplayMessages

public ArrayList getDisplayMessages()

Description copied from class: BaseInteraction

Method that needs to be implemented by the sub-classes to return the Localized Messages that need to be displayed as part of the interaction.

Specified by:

getDisplayMessages in class BaseInteraction

Returns:

ArrayList of LocalizedMessage objects or empty or null ArrayList

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

getPromptMessage

public LocalizedMessage getPromptMessage(IStateAccess state)

Description copied from class: BaseInteraction

Method that needs to be implemented by the sub-classes to return the prompt message that needs to be displayed for the user to input data.

Specified by:

getPromptMessage in class BaseInteraction

Parameters:

state - IStateAccess

Returns:

a LocalizedMessage Prompt

getUserOptions

public BaseOptions getUserOptions(IStateAccess state)
                           throws InstallException

Description copied from class: BaseInteraction

Method that needs to be implemented by the sub-classes to return the ResponseOption's and return the appropriate BaseOptions. * viz., SingleLineOptions & MutliLineOptions.

Specified by:

getUserOptions in class BaseInteraction

Parameters:

state - IStateAccess

Returns:

a BaseOptions with ResponseOption's populated.

Throws:

InstallException - if an error occurred while getting the user options

interact

public InteractionResultStatus interact(IStateAccess state)
                                 throws InstallException

Throws:

InstallException