Package org.forgerock.api.annotations

Annotation Type Parameter

  • public @interface Parameter
    A extra parameter to an operation.

    • Required Element Summary

      Required Elements 
      Modifier and Type Required Element Description
      String name
      The name of the parameter.
      String type
      The type semantics of the String value.

    • Element Detail

      • name

        String name
        The name of the parameter.

      • type

        String type
        The type semantics of the String value.

      • defaultValue

        String defaultValue
        The default value, if applicable. Should not be an empty string.
        Default:
        ""

      • description

        String description
        A description of the parameter.
        Default:
        ""

      • source

        ParameterSource source
        The source of the parameter. Defaults to PATH.
        Default:
        org.forgerock.api.enums.ParameterSource.PATH

      • required

        boolean required
        Whether the parameter is required. Defaults to true.
        Default:
        true

      • enumValues

        String[] enumValues
        Enumeration of acceptable values, if required.
        Default:
        {}

      • enumTitles

        String[] enumTitles
        Titles of enumeration values.
        Default:
        {}