Package org.a2aproject.sdk.spec

Record Class OAuth2SecurityScheme

java.lang.Object

java.lang.Record

org.a2aproject.sdk.spec.OAuth2SecurityScheme

Record Components:

flows - the OAuth 2.0 flow configuration (required)

description - optional description of the security scheme

oauth2MetadataUrl - optional URL to OAuth 2.0 metadata (RFC 8414)

All Implemented Interfaces:

SecurityScheme

public record OAuth2SecurityScheme(OAuthFlows flows, @Nullable String description, @Nullable String oauth2MetadataUrl)
extends Record
implements SecurityScheme

OAuth 2.0 security scheme for agent authentication.

This security scheme uses OAuth 2.0 authorization flows to authenticate requests. Supports authorization code, client credentials, implicit, and password flows via the OAuthFlows configuration.

Corresponds to the OpenAPI "oauth2" security scheme type.

See Also:

• for the base interface
• for flow configuration
• OpenAPI Security Scheme
• A2A Protocol Specification

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	OAuth2SecurityScheme.Builder	Builder for constructing immutable OAuth2SecurityScheme instances.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	TYPE	The type identifier for OAuth 2.0 security schemes: "oauth2SecurityScheme".

Constructor Summary

Constructors

Constructor	Description
OAuth2SecurityScheme(OAuthFlows flows, @Nullable String description, @Nullable String oauth2MetadataUrl)	Compact constructor with validation.

Method Summary

Modifier and Type	Method	Description
static OAuth2SecurityScheme.Builder	builder()	Create a new Builder
@Nullable 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.
OAuthFlows	flows()	Returns the value of the flows record component.
final int	hashCode()	Returns a hash code value for this object.
@Nullable String	oauth2MetadataUrl()	Returns the value of the oauth2MetadataUrl record component.
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 OAuth 2.0 security schemes: "oauth2SecurityScheme".

See Also:

• Constant Field Values

Constructor Details

OAuth2SecurityScheme

public OAuth2SecurityScheme(OAuthFlows flows,
 @Nullable String description,
 @Nullable String oauth2MetadataUrl)

Compact constructor with validation.

Parameters:

flows - the OAuth 2.0 flow configuration (required)

description - optional description of the security scheme

oauth2MetadataUrl - optional URL to OAuth 2.0 metadata (RFC 8414)

Throws:

IllegalArgumentException - if flows 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 OAuth2SecurityScheme.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.

flows

public OAuthFlows flows()

Returns the value of the flows record component.

Returns:

the value of the flows 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

oauth2MetadataUrl

public @Nullable String oauth2MetadataUrl()

Returns the value of the oauth2MetadataUrl record component.

Returns:

the value of the oauth2MetadataUrl record component