Package org.forgerock.opendj.setup.model

Class Profile.ParameterFactory

java.lang.Object

org.forgerock.opendj.setup.model.Profile.ParameterFactory

Enclosing class:

Profile

public final class Profile.ParameterFactory
extends Object

Factory class which groups methods used for creating new Profile.Parameter.

Those methods are meant to be only used by parameters.groovy scripts.

Method Summary

Modifier and Type	Method	Description
Profile.EnumParameter<Boolean>	booleanParameter(String variableName)	Creates and returns a new boolean parameter.
Profile.DnParameter	dnParameter(String variableName)	Creates and returns a new DN parameter.
Profile.DomainParameter	domainParameter(String variableName)	Creates and returns a new domain parameter.
Profile.NumberParameter<Double>	doubleParameter(String variableName)	Creates and returns a new Double parameter.
Profile.EnumParameter<String>	enumStringParameter(String variableName, Map<String,String> allowedValues)	Creates and returns a new enum string parameter.
Profile.NumberParameter<Float>	floatParameter(String variableName)	Creates and returns a new Float parameter.
Profile.HostPortParameter	hostPortParameter(String variableName)	Creates and returns a new remote server host and port parameter.
Profile.NumberParameter<Integer>	integerParameter(String variableName)	Creates and returns a new Integer parameter.
Profile.NumberParameter<Long>	longParameter(String variableName)	Creates and returns a new Long parameter.
Profile.PasswordParameter	passwordParameter(String variableName)	Creates and returns a new password parameter.
Profile.PathParameter	pathParameter(String variableName)	Creates and returns a new Path parameter.
Profile.StringParameter	stringParameter(String variableName)	Creates and returns a new String parameter.

Methods inherited from class java.lang.Object

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

Method Detail

booleanParameter

public Profile.EnumParameter<Boolean> booleanParameter(String variableName)

Creates and returns a new boolean parameter.

This method is only meant to be used in parameters.groovy scripts.

Parameters:

variableName - The parameter variable name

Returns:

A new boolean profile parameter

domainParameter

public Profile.DomainParameter domainParameter(String variableName)

Creates and returns a new domain parameter.

This method is only meant to be used in parameters.groovy scripts. Values associated to this parameter will be converted into Dn with domains attribute types:

• example will be converted into dc=example
• company.example.com will be converted into dc=company,dc=example,dc=com

Parameters:

variableName - The parameter variable name

Returns:

A new domain profile parameter

doubleParameter

public Profile.NumberParameter<Double> doubleParameter(String variableName)

Creates and returns a new Double parameter.

This method is only meant to be used in parameters.groovy scripts.

Parameters:

variableName - The parameter variable name

Returns:

A new Double profile parameter

dnParameter

public Profile.DnParameter dnParameter(String variableName)

Creates and returns a new DN parameter.

Parameters:

variableName - The parameter variable name

Returns:

A new profile parameter

enumStringParameter

public Profile.EnumParameter<String> enumStringParameter(String variableName,
                                                         Map<String,String> allowedValues)

Creates and returns a new enum string parameter.

Parameters:

variableName - The parameter variable name

allowedValues - Allowed values for this parameter.

Returns:

A new String enum profile parameter

floatParameter

public Profile.NumberParameter<Float> floatParameter(String variableName)

Creates and returns a new Float parameter.

This method is only meant to be used in parameters.groovy scripts.

Parameters:

variableName - The parameter variable name

Returns:

A new Float profile parameter

integerParameter

public Profile.NumberParameter<Integer> integerParameter(String variableName)

Creates and returns a new Integer parameter.

This method is only meant to be used in parameters.groovy scripts.

Parameters:

variableName - The parameter variable name

Returns:

A new Integer profile parameter

longParameter

public Profile.NumberParameter<Long> longParameter(String variableName)

Creates and returns a new Long parameter.

This method is only meant to be used in parameters.groovy scripts.

Parameters:

variableName - The parameter variable name

Returns:

A new Long profile parameter

passwordParameter

public Profile.PasswordParameter passwordParameter(String variableName)

Creates and returns a new password parameter.

String value retrieved from the Profile.ParameterValuesProvider passed as argument of Profile.resolveParameterValues(ExecutionContext, SetupConfiguration, ParameterValuesProvider) will be encoded so that parameter value will never appear in clear-text.

This method is only meant to be used in parameters.groovy scripts.

Parameters:

variableName - The parameter variable name

Returns:

A new password profile parameter

pathParameter

public Profile.PathParameter pathParameter(String variableName)

Creates and returns a new Path parameter.

This method is only meant to be used in parameters.groovy scripts.

Parameters:

variableName - The parameter variable name

Returns:

A new path profile parameter

stringParameter

public Profile.StringParameter stringParameter(String variableName)

Creates and returns a new String parameter.

This method is only meant to be used in parameters.groovy scripts.

Parameters:

variableName - The parameter variable name

Returns:

A new string profile parameter

hostPortParameter

public Profile.HostPortParameter hostPortParameter(String variableName)

Creates and returns a new remote server host and port parameter.

This method is only meant to be used in parameters.groovy scripts.

Parameters:

variableName - The parameter variable name

Returns:

A new remote server profile parameter