Module org.mule.sdk.api
Package org.mule.sdk.api.annotation.connectivity.oauth

Annotation Interface OAuthParameter

@Target(FIELD) @Retention(RUNTIME) @Documented @MinMuleVersion("4.5.0") public @interface OAuthParameter
Similar to Parameter, but intended to be used exclusively on fields of a ConnectionProvider which supports OAuth.

The semantics are similar to that of Parameter, but with some important differences:

  • When the authorization dance is performed, the values of these parameters are sent as custom parameters to the OAuth provider
  • Unlike traditional parameters (which support expressions by default), these parameters cannot support them. Actually, the Expression annotation cannot be used alongside this one.
  • Only basic types are supported on OAuth parameters
being sent as a custom OAuth parameter during the authentication dance.

Since:
1.0

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    HttpParameterPlacement
    placement
     
    String
    requestAlias
    The name under which the parameter's value is to be sent to the OAuth provider during the authentication request.

  • Element Details

    • requestAlias

      String requestAlias
      The name under which the parameter's value is to be sent to the OAuth provider during the authentication request. Not to be confused with the Alias annotation, this does not influence the parameter's name. This parameter can be used alongside Alias without any problem.

      Not specifying this annotation means using the parameter's default name.

      Returns:
      the name of the parameter during the OAuth dance
      Default:
      ""

    • placement

      HttpParameterPlacement placement
      Returns:
      The parameter's placement in the resulting HTTP request
      Default:
      QUERY_PARAMS