public final class Profile.ParameterFactory extends Object
Profile.Parameter
.
Those methods are meant to be only used by parameters.groovy scripts.
Modifier and Type | Method and Description |
---|---|
Profile.Parameter<Boolean> |
booleanParameter(String variableName)
Creates and returns a new boolean parameter.
|
<T> Profile.Parameter<T> |
customParameter(Profile.ParameterType<T> type,
String variableName)
Creates and returns a new parameter of the provided type.
|
Profile.Parameter<Dn> |
domainParameter(String variableName)
Creates and returns a new domain parameter.
|
Profile.Parameter<Double> |
doubleParameter(String variableName)
Creates and returns a new
Double parameter. |
Profile.EnumParameter<String> |
enumStringParameter(String variableName,
String... allowedValues)
Creates and returns a new enum string parameter.
|
Profile.Parameter<Float> |
floatParameter(String variableName)
Creates and returns a new
Float parameter. |
Profile.Parameter<Integer> |
integerParameter(String variableName)
Creates and returns a new
Integer parameter. |
Profile.Parameter<Long> |
longParameter(String variableName)
Creates and returns a new
Long parameter. |
Profile.Parameter<String> |
passwordParameter(String variableName)
Creates and returns a new password parameter.
|
Profile.Parameter<Path> |
pathParameter(String variableName)
Creates and returns a new
Path parameter. |
Profile.Parameter<String> |
stringParameter(String variableName)
Creates and returns a new
String parameter. |
public Profile.Parameter<Boolean> booleanParameter(String variableName)
This method is only meant to be used in parameters.groovy scripts.
variableName
- The parameter variable nameprofile parameter
public Profile.Parameter<Dn> domainParameter(String variableName)
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:
variableName
- The parameter variable nameprofile parameter
public Profile.Parameter<Double> doubleParameter(String variableName)
Double
parameter.
This method is only meant to be used in parameters.groovy scripts.
variableName
- The parameter variable nameDouble
profile parameter
public <T> Profile.Parameter<T> customParameter(Profile.ParameterType<T> type, String variableName)
T
- Concrete type of the parametertype
- Parameter type, can be set using Profile.ParameterType.of(String, Function)
methodvariableName
- The parameter variable nameprofile parameter
public Profile.EnumParameter<String> enumStringParameter(String variableName, String... allowedValues)
variableName
- The parameter variable nameallowedValues
- Allowed values for this parameter.String
enum profile parameter
public Profile.Parameter<Float> floatParameter(String variableName)
Float
parameter.
This method is only meant to be used in parameters.groovy scripts.
variableName
- The parameter variable nameFloat
profile parameter
public Profile.Parameter<Integer> integerParameter(String variableName)
Integer
parameter.
This method is only meant to be used in parameters.groovy scripts.
variableName
- The parameter variable nameInteger
profile parameter
public Profile.Parameter<Long> longParameter(String variableName)
Long
parameter.
This method is only meant to be used in parameters.groovy scripts.
variableName
- The parameter variable nameLong
profile parameter
public Profile.Parameter<String> passwordParameter(String variableName)
String value retrieved from the Profile.ParameterValuesProvider
passed as argument of
Profile.resolveParameterValues(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.
variableName
- The parameter variable nameprofile parameter
public Profile.Parameter<Path> pathParameter(String variableName)
Path
parameter.
This method is only meant to be used in parameters.groovy scripts.
variableName
- The parameter variable namepath
profile parameter
public Profile.Parameter<String> stringParameter(String variableName)
String
parameter.
This method is only meant to be used in parameters.groovy scripts.
variableName
- The parameter variable namestring
profile parameter
Copyright 2010-2022 ForgeRock AS.