Package com.adobe.granite.haf.annotations

Annotation Type HttpFormParam

  • @Target(PARAMETER)
@Retention(RUNTIME)
public @interface HttpFormParam
    Use this annotation to bind specific java parameters to HTTP form parameters coming from the request. These will only be processed if the method has an ApiAction annotation.

    • Required Element Summary

      Required Elements 
      Modifier and Type Required Element Description
      java.lang.String value
      The name of the HTTP parameter to bind to.

    • Optional Element Summary

      Optional Elements 
      Modifier and Type Optional Element Description
      boolean optional
      Whether the parameter should be considered optional.

    • Element Detail

      • value

        java.lang.String value
        The name of the HTTP parameter to bind to.
        Returns:
        The parameter name

      • optional

        boolean optional
        Whether the parameter should be considered optional. If it is, and no value for it is passed in the request the method will receive null as the value.
        Returns:
        The optional property
        Default:
        false