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

Record Class BasicAuthConfig

java.lang.Object
java.lang.Record
com.bonitasoft.processbuilder.extension.template.auth.BasicAuthConfig
All Implemented Interfaces:
AuthConfig
public record BasicAuthConfig(String username, String password, boolean preemptive) extends Record implements AuthConfig
Configuration for HTTP Basic Authentication.
Since:
2025-02-06
Author:
Process Builder Team

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static class 
    BasicAuthConfig.Builder
     

  • Constructor Summary

    Constructors
    Constructor
    Description
    BasicAuthConfig(String username, String password)
     
    BasicAuthConfig(String username, String password, boolean preemptive)
    Creates an instance of a BasicAuthConfig record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    static BasicAuthConfig.Builder
    builder()
     
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    static BasicAuthConfig
    fromJson(com.fasterxml.jackson.databind.JsonNode node)
     
    String
    getAuthType()
    Gets the authentication type identifier.
    final int
    hashCode()
    Returns a hash code value for this object.
    String
    password()
    Returns the value of the password record component.
    boolean
    preemptive()
    Returns the value of the preemptive record component.
    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.
    final String
    toString()
    Returns a string representation of this record class.
    String
    username()
    Returns the value of the username record component.

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • BasicAuthConfig

      public BasicAuthConfig(String username, String password)

    • BasicAuthConfig

      public BasicAuthConfig(String username, String password, boolean preemptive)
      Creates an instance of a BasicAuthConfig record class.
      Parameters:
      username - the value for the username record component
      password - the value for the password record component
      preemptive - the value for the preemptive 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 BasicAuthConfig fromJson(com.fasterxml.jackson.databind.JsonNode node)

    • builder

      public static BasicAuthConfig.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. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.
      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.

    • username

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

    • password

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

    • preemptive

      public boolean preemptive()
      Returns the value of the preemptive record component.
      Returns:
      the value of the preemptive record component