Record Class BearerAuthConfig

java.lang.Object
java.lang.Record
com.bonitasoft.processbuilder.extension.template.auth.BearerAuthConfig
All Implemented Interfaces:
AuthConfig

public record BearerAuthConfig(String token) extends Record implements AuthConfig
Configuration for Bearer Token Authentication.
Since:
2025-02-06
Author:
Process Builder Team
  • Constructor Summary

    Constructors
    Constructor
    Description
    Creates an instance of a BearerAuthConfig record class.
  • Method Summary

    Modifier and Type
    Method
    Description
    final boolean
    Indicates whether some other object is "equal to" this one.
    fromJson(com.fasterxml.jackson.databind.JsonNode node)
     
    Gets the authentication type identifier.
    final int
    Returns a hash code value for this object.
    of(String token)
     
    com.fasterxml.jackson.databind.JsonNode
    toJson(com.fasterxml.jackson.databind.ObjectMapper mapper)
    Converts this configuration to a JSON node for storage.
    com.fasterxml.jackson.databind.JsonNode
    toJsonEncrypted(com.fasterxml.jackson.databind.ObjectMapper mapper)
    Converts this configuration to a JSON node with sensitive fields encrypted.
    Returns the value of the token record component.
    final String
    Returns a string representation of this record class.

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait
  • Constructor Details

    • BearerAuthConfig

      public BearerAuthConfig(String token)
      Creates an instance of a BearerAuthConfig record class.
      Parameters:
      token - the value for the token record component
  • 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 BearerAuthConfig fromJson(com.fasterxml.jackson.databind.JsonNode node)
    • of

      public static BearerAuthConfig of(String token)
    • 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.
    • token

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