Package org.a2aproject.sdk.spec

Record Class OpenIdConnectSecurityScheme

java.lang.Object
java.lang.Record
org.a2aproject.sdk.spec.OpenIdConnectSecurityScheme
Record Components:
openIdConnectUrl - URL to the OpenID Connect Discovery document (required)
description - optional description of the security scheme
All Implemented Interfaces:
SecurityScheme
public record OpenIdConnectSecurityScheme(String openIdConnectUrl, @Nullable String description) extends Record implements SecurityScheme
OpenID Connect security scheme for agent authentication.

This security scheme uses OpenID Connect Discovery to automatically configure authentication. The openIdConnectUrl must point to an OpenID Connect Discovery document that describes the provider's configuration, including authorization and token endpoints.

OpenID Connect builds on OAuth 2.0 to provide identity layer functionality, enabling clients to verify user identity and obtain basic profile information.

Example usage: 


 OpenIdConnectSecurityScheme scheme = OpenIdConnectSecurityScheme.builder()
     .openIdConnectUrl("https://example.com/.well-known/openid-configuration")
     .description("OpenID Connect authentication")
     .build();
See Also:

  • Field Details

    • TYPE

      public static final String TYPE
      The type identifier for OpenID Connect security schemes: "openIdConnect".
      See Also:

  • Constructor Details

    • OpenIdConnectSecurityScheme

      public OpenIdConnectSecurityScheme(String openIdConnectUrl, @Nullable String description)
      Compact constructor with validation.
      Parameters:
      openIdConnectUrl - URL to the OpenID Connect Discovery document (required)
      description - optional description of the security scheme
      Throws:
      IllegalArgumentException - if openIdConnectUrl 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 OpenIdConnectSecurityScheme.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.

    • openIdConnectUrl

      public String openIdConnectUrl()
      Returns the value of the openIdConnectUrl record component.
      Returns:
      the value of the openIdConnectUrl 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