Package com.bonitasoft.processbuilder.records

Record Class RestAuthConfig.ApiKeyAuth

java.lang.Object
java.lang.Record
com.bonitasoft.processbuilder.records.RestAuthConfig.ApiKeyAuth
Record Components:
keyName - The name of the header or query parameter
keyValue - The API key value
location - Where to send the key (HEADER or QUERY_PARAM)
All Implemented Interfaces:
RestAuthConfig
Enclosing interface:
RestAuthConfig
public static record RestAuthConfig.ApiKeyAuth(String keyName, String keyValue, RestApiKeyLocation location) extends Record implements RestAuthConfig
API Key authentication configuration.

  • Constructor Details

    • ApiKeyAuth

      public ApiKeyAuth(String keyName, String keyValue, RestApiKeyLocation location)
      Creates an instance of a ApiKeyAuth record class.
      Parameters:
      keyName - the value for the keyName record component
      keyValue - the value for the keyValue record component
      location - the value for the location 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

    • getAuthQueryParams

      public Map<String,String> getAuthQueryParams()
      Description copied from interface: RestAuthConfig
      Gets any query parameters required for this authentication.
      Specified by:
      getAuthQueryParams in interface RestAuthConfig
      Returns:
      Map of parameter name to parameter value

    • 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.

    • keyName

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

    • keyValue

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

    • location

      public RestApiKeyLocation location()
      Returns the value of the location record component.
      Returns:
      the value of the location record component