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

Class BaseInteraction

java.lang.Object

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

Direct Known Subclasses:

ConfirmInteraction, UserDataInteraction, UserResponseInteraction

public abstract class BaseInteraction
extends Object

Constructor Summary

Constructors

Constructor	Description
BaseInteraction()

Method Summary

Modifier and Type	Method	Description
void	displayMessages()
void	displayOptionsHelp(IStateAccess state)	This method should not be called until the interaction initializes the UserOptionItem with three param constructor.
protected void	displayPromptMessage(IStateAccess state)
abstract 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.
abstract 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.
abstract 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.
abstract 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.

Methods inherited from class java.lang.Object

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

Constructor Detail

BaseInteraction

public BaseInteraction()

Method Detail

getDisplayMessages

public abstract 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.

Returns:

ArrayList of LocalizedMessage objects or empty or null ArrayList

getUserOptions

public abstract BaseOptions getUserOptions(IStateAccess state)
                                    throws InstallException

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

Parameters:

state - IStateAccess

Returns:

a BaseOptions with ResponseOption's populated.

Throws:

InstallException - if an error occurred while getting the user options

getPromptMessage

public abstract 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.

Parameters:

state - IStateAccess

Returns:

a LocalizedMessage Prompt

getPromptValue

public abstract String getPromptValue(IStateAccess state)
                               throws InstallException

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]:

Parameters:

state - IStateAccess

Returns:

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

Throws:

InstallException - TODO

displayOptionsHelp

public void displayOptionsHelp(IStateAccess state)
                        throws InstallException

This method should not be called until the interaction initializes the UserOptionItem with three param constructor. Presently, only InstallInteraction uses this method.

Parameters:

state - the IStateAcess

Throws:

InstallException

displayMessages

public void displayMessages()

displayPromptMessage

protected void displayPromptMessage(IStateAccess state)
                             throws InstallException

Throws:

InstallException