Record Class ResourceIndicator

java.lang.Object
java.lang.Record
cloud.opencode.base.oauth2.security.ResourceIndicator
public record ResourceIndicator(String resource) extends Record
Resource Indicator (RFC 8707) 资源指示器（RFC 8707）

Represents an OAuth 2.0 resource indicator as defined in RFC 8707. Resource indicators allow clients to indicate the target resource server when requesting tokens, enabling the authorization server to restrict tokens to specific audiences.

表示 RFC 8707 定义的 OAuth 2.0 资源指示器。资源指示器允许客户端在请求 Token 时指示 目标资源服务器，使授权服务器能够将 Token 限制到特定受众。

Features | 主要功能:

  • RFC 8707 compliant resource indicator - 符合 RFC 8707 的资源指示器
  • URI validation on construction - 构造时进行 URI 验证
  • Immutable record - 不可变记录

Usage Examples | 使用示例:

// Create a resource indicator
// 创建资源指示器
ResourceIndicator resource = ResourceIndicator.of("https://api.example.com");

// Use in authorization request
// 在授权请求中使用
params.put("resource", resource.toParam());

Security | 安全性:

  • Thread-safe: Yes (immutable record) - 线程安全: 是（不可变记录）
  • Null-safe: Yes (validates inputs) - 空值安全: 是（验证输入）
Since:
JDK 25, opencode-base-oauth2 V1.0.3
Author:
Leon Soo www.LeonSoo.com
See Also:

  • Constructor Summary

    Constructors
    Constructor
    Description
    ResourceIndicator(String resource)
    Compact constructor with validation.

  • Method Summary

    Modifier and Type
    Method
    Description
    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.
    static ResourceIndicator
    of(String resource)
    Create a ResourceIndicator from a URI string.
    String
    resource()
    Returns the value of the resource record component.
    String
    toParam()
    Get the resource URI string suitable for use as a request parameter.
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class Object

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

  • Constructor Details

    • ResourceIndicator

      public ResourceIndicator(String resource)
      Compact constructor with validation. 带验证的紧凑构造器。
      Throws:
      NullPointerException - if resource is null | 如果 resource 为 null 则抛出
      IllegalArgumentException - if resource is blank or not a valid URI | 如果 resource 为空白或不是有效的 URI 则抛出

  • Method Details

    • toParam

      public String toParam()
      Get the resource URI string suitable for use as a request parameter. 获取适合用作请求参数的资源 URI 字符串。
      Returns:
      the resource URI string | 资源 URI 字符串

    • of

      public static ResourceIndicator of(String resource)
      Create a ResourceIndicator from a URI string. 从 URI 字符串创建 ResourceIndicator。
      Parameters:
      resource - the resource URI string | 资源 URI 字符串
      Returns:
      the resource indicator | 资源指示器
      Throws:
      NullPointerException - if resource is null | 如果 resource 为 null 则抛出
      IllegalArgumentException - if resource is blank or not a valid URI | 如果 resource 为空白或不是有效的 URI 则抛出

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

    • resource

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