Package org.a2aproject.sdk.spec

Record Class ClientCredentialsOAuthFlow

java.lang.Object
java.lang.Record
org.a2aproject.sdk.spec.ClientCredentialsOAuthFlow
Record Components:
refreshUrl - URL for obtaining refresh tokens (optional, rarely used in client credentials flow)
scopes - map of available OAuth scopes to their descriptions (required)
tokenUrl - URL for the token endpoint where client credentials are exchanged for tokens (required)
public record ClientCredentialsOAuthFlow(String refreshUrl, Map<String,String> scopes, String tokenUrl) extends Record
Configuration for the OAuth 2.0 Client Credentials flow.

The client credentials flow is designed for machine-to-machine authentication where the client application authenticates using its own credentials (client ID and secret) rather than on behalf of a user. This is suitable for server-to-server communication and backend services.

This flow is appropriate when the client is acting on its own behalf, not representing a user, such as accessing its own resources or performing administrative operations.

See Also:

  • Constructor Details

    • ClientCredentialsOAuthFlow

      public ClientCredentialsOAuthFlow(String refreshUrl, Map<String,String> scopes, String tokenUrl)
      Compact constructor that validates required fields.
      Parameters:
      refreshUrl - the refreshUrl parameter (see class-level JavaDoc)
      scopes - the scopes parameter (see class-level JavaDoc)
      tokenUrl - the tokenUrl parameter (see class-level JavaDoc)
      Throws:
      IllegalArgumentException - if scopes or tokenUrl is null

  • Method Details

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

    • refreshUrl

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

    • scopes

      public Map<String,String> scopes()
      Returns the value of the scopes record component.
      Returns:
      the value of the scopes record component

    • tokenUrl

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