Package org.a2aproject.sdk.spec

Record Class HTTPAuthSecurityScheme

java.lang.Object
java.lang.Record
org.a2aproject.sdk.spec.HTTPAuthSecurityScheme
Record Components:
bearerFormat - the bearer token format (optional)
scheme - the authentication scheme (required)
description - the scheme description (optional)
All Implemented Interfaces:
SecurityScheme
public record HTTPAuthSecurityScheme(@Nullable String bearerFormat, String scheme, @Nullable String description) extends Record implements SecurityScheme
HTTP authentication security scheme for agent authentication.

This security scheme uses HTTP authentication mechanisms, supporting both basic authentication and bearer token authentication (e.g., JWT). The scheme parameter specifies the HTTP authentication scheme name as defined in RFC 7235.

Common schemes:

  • basic - HTTP Basic authentication (RFC 7617)
  • bearer - Bearer token authentication (RFC 6750), typically used with OAuth 2.0

For bearer tokens, the bearerFormat field can provide additional information about the token format (e.g., "JWT").

Example usage: 


 HTTPAuthSecurityScheme scheme = HTTPAuthSecurityScheme.builder()
     .scheme("bearer")
     .bearerFormat("JWT")
     .description("JWT bearer token authentication")
     .build();
See Also:

  • Field Details

  • Constructor Details

    • HTTPAuthSecurityScheme

      public HTTPAuthSecurityScheme(@Nullable String bearerFormat, String scheme, @Nullable String description)
      Compact constructor with validation.
      Parameters:
      bearerFormat - the bearer token format (optional)
      scheme - the authentication scheme (required)
      description - the scheme description (optional)
      Throws:
      IllegalArgumentException - if scheme is null

  • Method Details

    • type

      public String type()
      Description copied from interface: SecurityScheme
      Returns the type of the security scheme.
      Specified by:
      type in interface SecurityScheme
      Returns:
      the type of the security scheme.

    • builder

      public static HTTPAuthSecurityScheme.Builder builder()
      Create a new Builder
      Returns:
      the 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.

    • bearerFormat

      public @Nullable String bearerFormat()
      Returns the value of the bearerFormat record component.
      Returns:
      the value of the bearerFormat record component

    • scheme

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

    • description

      public @Nullable String description()
      Returns the value of the description record component.
      Specified by:
      description in interface SecurityScheme
      Returns:
      the value of the description record component