org.forgerock.opendj.setup.model

Class Profile.Parameter<T>

java.lang.Object

org.forgerock.opendj.setup.model.Profile.Parameter<T>

Type Parameters:

T - The parameter concrete class

Direct Known Subclasses:

Profile.EnumParameter

Enclosing class:

Profile

public class Profile.Parameter<T>
extends Object

Represents parameters that can be used in the profile.groovy script.

A parameter is defined by:

• a mandatory variable name (e.g fooBar)
• an optional property name (e.g FOO_BAR), this property will be used for substituting commons configuration expression in resource files (see ResourcesManager#applyTemplate(String, String))
• a default value which will be used if no values are provided for the parameter at runtime
• a mandatory type
• a value

Method Summary

Modifier and Type	Method and Description
Profile.Parameter<T>	advanced() Specifies that this profile parameter is advanced.
Profile.Parameter<T>	defaultValue(String defaultValue) Sets this profile parameter default value with the provided string.
Profile.Parameter<T>	defaultValue(T defaultValue) Sets this profile parameter default value.
Profile.Parameter<T>	description(String description) Sets this profile parameter description.
boolean	equals(Object obj)
T	getDefaultValue() Returns this profile parameter default value.
LocalizableMessage	getDescriptionMsg() Returns this profile parameter description.
LocalizableMessage	getHelpMsg() Returns this profile parameter help message.
LocalizableMessage	getPromptMsg() Returns this profile parameter prompt message.
Profile.ParameterType<T>	getType() Returns this profile parameter type.
T	getValue() Returns this profile parameter value.
String	getVariableName() Returns this profile parameter variable name.
int	hashCode()
Profile.Parameter<T>	help(String... helpMsgLines) Sets this profile parameter help.
boolean	isAdvanced() Returns whether this profile parameter is advanced.
T	parseStringValue(String strValue) Parses provided string value into this parameter type and returns the typed value.
Profile.Parameter<T>	prompt(String... promptMsgLines) Sets this profile parameter prompt message.
Profile.Parameter<T>	property(String property) Sets this profile parameter property.
T	resolveValue() Resolves and returns this profile parameter runtime value.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

defaultValue

public final Profile.Parameter<T> defaultValue(T defaultValue)

Sets this profile parameter default value.

If no value is available for the parameter at runtime, default value will be used.

Parameters:

defaultValue - The default value to be associated to this parameter

Returns:

This profile parameter

description

public final Profile.Parameter<T> description(String description)

Sets this profile parameter description.

Description will be used by setup tool interactive mode in summaries, hence description content should be concise (e.g Name of the backend used to ...

Parameters:

description - A string representing the parameter description

Returns:

This profile parameter

help

public final Profile.Parameter<T> help(String... helpMsgLines)

Sets this profile parameter help.

Help is printed when user wants to know all parameters associated to a profile (setup --help-profile "profileId"), if not set description will be used.

Parameters:

helpMsgLines - Strings representing the message lines

Returns:

This profile parameter

defaultValue

public final Profile.Parameter<T> defaultValue(String defaultValue)
                                        throws SetupException

Sets this profile parameter default value with the provided string.

If no value is available for the parameter at runtime, default value will be used.

Parameters:

defaultValue - A string representing the default value to be associated to this parameter

Returns:

This profile parameter

Throws:

SetupException - If the provided string cannot be converted in the parameter object type

advanced

public final Profile.Parameter<T> advanced()

Specifies that this profile parameter is advanced.

Setup interactive mode does not prompt for advanced profile parameter value. As a consequence, advanced parameter must have a default value defined.

Returns:

This profile parameter

prompt

public final Profile.Parameter<T> prompt(String... promptMsgLines)

Sets this profile parameter prompt message.

Parameters:

promptMsgLines - Strings representing the message lines to be printed by setup interactive mode while resolving this Profile.Parameter value (e.g "Provide a name for the backend used to ...)

Returns:

This profile parameter

property

public final Profile.Parameter<T> property(String property)

Sets this profile parameter property.

Parameters:

property - The property to be associated to this parameter

Returns:

This profile parameter

resolveValue

public final T resolveValue()
                     throws com.forgerock.opendj.cli.ArgumentException

Resolves and returns this profile parameter runtime value.

This method is only be meant to be called one time by parameters.groovy scripts. For example:

  
      define.newDn "domainBaseDn" \
         property "DOMAIN_BASE_DN" \
         defaultValue Dn.valueOf("dc=example,dc=com") \
         resolveValue()

      define.newPassword "amAdminPassword" \
         property "AM_ADMIN_PASSWORD" \
         resolveValue()
  
 

Value resolution is done as follow:

• 1) Retrieve the string value returned by the provider set by a call to Profile.resolveParameterValues(SetupConfiguration, ParameterValuesProvider)
• 2) If the value is cannot be retrieved then fallback to the default value or throw an exception if this parameter has no default value
• 3) Use the type function to convert the string value into an object of the parameter type (an exception is thrown if value cant be retrieved from string

Returns:

This profile parameter value

Throws:

com.forgerock.opendj.cli.ArgumentException - If the parameter value cannot be resolved or if the resolution (i.e parsing its string representation) failed

parseStringValue

public T parseStringValue(String strValue)
                   throws com.forgerock.opendj.cli.ArgumentException

Parses provided string value into this parameter type and returns the typed value.

Parameters:

strValue - A string representing the parameter value to be parsed

Returns:

The typed value associated to provided string

Throws:

com.forgerock.opendj.cli.ArgumentException - If an error occurred while parsing provided string value

isAdvanced

public final boolean isAdvanced()

Returns whether this profile parameter is advanced.

the setup interactive mode should prompt for this profile parameter value.

Returns:

true if this profile parameter is advanced, false otherwise

See Also:

advanced()

getDefaultValue

public final T getDefaultValue()

Returns this profile parameter default value.

Returns:

This profile parameter default value

getDescriptionMsg

public final LocalizableMessage getDescriptionMsg()

Returns this profile parameter description.

Returns:

A LocalizableMessage representing this profile parameter description

getHelpMsg

public final LocalizableMessage getHelpMsg()

Returns this profile parameter help message.

Returns:

A LocalizableMessage representing this profile parameter help message

getPromptMsg

public final LocalizableMessage getPromptMsg()

Returns this profile parameter prompt message.

Returns:

This profile parameter prompt message

getVariableName

public final String getVariableName()

Returns this profile parameter variable name.

Returns:

A string representing this profile parameter variable name

getType

public final Profile.ParameterType<T> getType()

Returns this profile parameter type.

Returns:

A Profile.ParameterType object representing this profile parameter type

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

toString

public final String toString()

Overrides:

toString in class Object

getValue

public final T getValue()

Returns this profile parameter value.

To be set, resolveValue() method must have been called.

Returns:

This profile parameter value