Package com.bonitasoft.processbuilder.records

Record Class RestAuthConfig.OAuth2ClientCredentials

java.lang.Object
java.lang.Record
com.bonitasoft.processbuilder.records.RestAuthConfig.OAuth2ClientCredentials
Record Components:
tokenUrl - The token endpoint URL
clientId - The client ID
clientSecret - The client secret
scope - Optional scope(s) to request
audience - Optional audience (for Auth0, etc.)
clientAuthMethod - How to send client credentials (BODY or HEADER)
All Implemented Interfaces:
RestAuthConfig
Enclosing interface:
RestAuthConfig
public static record RestAuthConfig.OAuth2ClientCredentials(String tokenUrl, String clientId, String clientSecret, String scope, String audience, RestOAuth2ClientAuthMethod clientAuthMethod) extends Record implements RestAuthConfig
OAuth 2.0 Client Credentials authentication configuration.

  • Constructor Details

    • OAuth2ClientCredentials

      public OAuth2ClientCredentials(String tokenUrl, String clientId, String clientSecret, String scope, String audience, RestOAuth2ClientAuthMethod clientAuthMethod)
      Creates an instance of a OAuth2ClientCredentials record class.
      Parameters:
      tokenUrl - the value for the tokenUrl record component
      clientId - the value for the clientId record component
      clientSecret - the value for the clientSecret record component
      scope - the value for the scope record component
      audience - the value for the audience record component
      clientAuthMethod - the value for the clientAuthMethod record component

  • Method Details

    • getAuthType

      public RestAuthenticationType getAuthType()
      Description copied from interface: RestAuthConfig
      Gets the authentication type for this configuration.
      Specified by:
      getAuthType in interface RestAuthConfig
      Returns:
      The authentication type

    • getAuthHeaders

      public Map<String,String> getAuthHeaders()
      Description copied from interface: RestAuthConfig
      Generates the HTTP headers required for this authentication.
      Specified by:
      getAuthHeaders in interface RestAuthConfig
      Returns:
      Map of header name to header value

    • getTokenRequestHeaders

      public Map<String,String> getTokenRequestHeaders()
      Gets the headers for the token request (not the API request).
      Returns:
      Headers for token endpoint

    • getTokenRequestBody

      public String getTokenRequestBody()
      Gets the body parameters for the token request.
      Returns:
      Form parameters for token endpoint

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • tokenUrl

      public String tokenUrl()
      Returns the value of the tokenUrl record component.
      Returns:
      the value of the tokenUrl record component

    • clientId

      public String clientId()
      Returns the value of the clientId record component.
      Returns:
      the value of the clientId record component

    • clientSecret

      public String clientSecret()
      Returns the value of the clientSecret record component.
      Returns:
      the value of the clientSecret record component

    • scope

      public String scope()
      Returns the value of the scope record component.
      Returns:
      the value of the scope record component

    • audience

      public String audience()
      Returns the value of the audience record component.
      Returns:
      the value of the audience record component

    • clientAuthMethod

      public RestOAuth2ClientAuthMethod clientAuthMethod()
      Returns the value of the clientAuthMethod record component.
      Returns:
      the value of the clientAuthMethod record component