Package org.a2aproject.sdk.spec

Record Class MutualTLSSecurityScheme

java.lang.Object
java.lang.Record
org.a2aproject.sdk.spec.MutualTLSSecurityScheme
Record Components:
description - optional description of the security scheme
All Implemented Interfaces:
SecurityScheme
public record MutualTLSSecurityScheme(String description) extends Record implements SecurityScheme
Mutual TLS (mTLS) security scheme for agent authentication.

This security scheme uses mutual TLS authentication, where both the client and server present X.509 certificates to authenticate each other. This provides strong, certificate-based authentication at the transport layer.

Unlike other authentication schemes that operate at the HTTP layer, mTLS authentication occurs during the TLS handshake before any HTTP communication begins. This makes it particularly suitable for high-security environments and machine-to-machine communication.

Example usage: 


 MutualTLSSecurityScheme scheme = new MutualTLSSecurityScheme(
     "Client certificate authentication required"
 );
See Also:

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    TYPE
    The type identifier for mutual TLS security schemes: "mtlsSecurityScheme".

  • Constructor Summary

    Constructors
    Constructor
    Description
    MutualTLSSecurityScheme(String description)
    Creates an instance of a MutualTLSSecurityScheme record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    description()
    Returns the value of the description record component.
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    final int
    hashCode()
    Returns a hash code value for this object.
    final String
    toString()
    Returns a string representation of this record class.
    String
    type()
    Returns the type of the security scheme.

    Methods inherited from class java.lang.Object

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

  • Field Details

    • TYPE

      public static final String TYPE
      The type identifier for mutual TLS security schemes: "mtlsSecurityScheme".
      See Also:

  • Constructor Details

    • MutualTLSSecurityScheme

      public MutualTLSSecurityScheme(String description)
      Creates an instance of a MutualTLSSecurityScheme record class.
      Parameters:
      description - the value for the description record component

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

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

    • description

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