Package org.forgerock.opendj.setup.model

Interface Profile.ParameterValuesProvider

All Known Implementing Classes:
Profile.ParameterValues
Enclosing class:
Profile
public static interface Profile.ParameterValuesProvider
Interface used by the setup model to retrieve profile parameter values.

  • Method Summary

    Modifier and Type
    Method
    Description
    List<String>
    getValues(Profile.Parameter<?,?> parameter)
    Returns the values set for the provided profile parameter.
    default void
    postResolutionActions(Collection<String> resolvedParameterNames, String profileName)
    Performs actions once profile parameter values have been resolved.

  • Method Details

    • getValues

      List<String> getValues(Profile.Parameter<?,?> parameter)
      Returns the values set for the provided profile parameter.

      This method will be called during the profile's parameters.groovy script execution

      If provided parameter has not been flagged as being multivalued, the returned list will contain only one element.

      Parameters:
      parameter - The parameter from which the value(s) should be resolved
      Returns:
      A list of string representing the values set in command line arguments for the provided profile Profile.Parameter, or an empty list if parameter default value should be used.

    • postResolutionActions

      default void postResolutionActions(Collection<String> resolvedParameterNames, String profileName) throws com.forgerock.opendj.cli.ArgumentException
      Performs actions once profile parameter values have been resolved.

      Default implementation is to do nothing.

      Parameters:
      resolvedParameterNames - Names of the profile parameters whose values have been resolved
      profileName - Description of the running profile
      Throws:
      com.forgerock.opendj.cli.ArgumentException - if some parameter is not acceptable