Package com.bonitasoft.processbuilder.extension.template.auth

Record Class OAuth2ClientConfig

java.lang.Object
java.lang.Record
com.bonitasoft.processbuilder.extension.template.auth.OAuth2ClientConfig
All Implemented Interfaces:
AuthConfig
public record OAuth2ClientConfig(String tokenUrl, String clientId, String clientSecret, String scope, String audience, OAuth2ClientConfig.ClientAuthMethod clientAuthMethod) extends Record implements AuthConfig
Configuration for OAuth2 Client Credentials flow.
Since:
2025-02-06
Author:
Process Builder Team

  • Constructor Details

    • OAuth2ClientConfig

      public OAuth2ClientConfig(String tokenUrl, String clientId, String clientSecret, String scope, String audience, OAuth2ClientConfig.ClientAuthMethod clientAuthMethod)
      Creates an instance of a OAuth2ClientConfig 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

    • OAuth2ClientConfig

      public OAuth2ClientConfig(String tokenUrl, String clientId, String clientSecret)

    • OAuth2ClientConfig

      public OAuth2ClientConfig(String tokenUrl, String clientId, String clientSecret, String scope)

  • Method Details

    • getAuthType

      public String getAuthType()
      Description copied from interface: AuthConfig
      Gets the authentication type identifier.
      Specified by:
      getAuthType in interface AuthConfig
      Returns:
      The authentication type string (lowercase)

    • toJson

      public com.fasterxml.jackson.databind.JsonNode toJson(com.fasterxml.jackson.databind.ObjectMapper mapper)
      Description copied from interface: AuthConfig
      Converts this configuration to a JSON node for storage.
      Specified by:
      toJson in interface AuthConfig
      Parameters:
      mapper - The ObjectMapper to use for JSON creation
      Returns:
      JSON representation of this configuration

    • toJsonEncrypted

      public com.fasterxml.jackson.databind.JsonNode toJsonEncrypted(com.fasterxml.jackson.databind.ObjectMapper mapper)
      Description copied from interface: AuthConfig
      Converts this configuration to a JSON node with sensitive fields encrypted.
      Specified by:
      toJsonEncrypted in interface AuthConfig
      Parameters:
      mapper - The ObjectMapper to use for JSON creation
      Returns:
      JSON representation with encrypted sensitive fields

    • fromJson

      public static OAuth2ClientConfig fromJson(com.fasterxml.jackson.databind.JsonNode node)

    • builder

      public static OAuth2ClientConfig.Builder builder()

    • 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 OAuth2ClientConfig.ClientAuthMethod clientAuthMethod()
      Returns the value of the clientAuthMethod record component.
      Returns:
      the value of the clientAuthMethod record component