パッケージ org.springframework.security.oauth2.server.authorization

クラス AbstractOAuth2ClientRegistration.AbstractBuilder<T は抽象 OAuth2 クライアント登録を継承し、B は AbstractOAuth2ClientRegistration.AbstractBuilder<T, B>> を継承します。

java.lang.ObjectSE
org.springframework.security.oauth2.server.authorization.AbstractOAuth2ClientRegistration.AbstractBuilder<T,B>
型パラメーター:
T - オブジェクトの種類
B - ビルダーの型
既知の直属サブクラス
OAuth2ClientRegistration.Builder, OidcClientRegistration.Builder
含まれているクラス:
AbstractOAuth2ClientRegistration
protected abstract static class AbstractOAuth2ClientRegistration.AbstractBuilder<T extends AbstractOAuth2ClientRegistration,B extends AbstractOAuth2ClientRegistration.AbstractBuilder<T,B>> extends ObjectSE
AbstractOAuth2ClientRegistration のサブクラスのビルダー。

  • コンストラクターの概要

    コンストラクター
    修飾子
    コンストラクター
    説明
    protected
    AbstractBuilder()

  • メソッドのサマリー

    修飾子と型
    メソッド
    説明
    abstract T
    build()
    クレームを検証し、AbstractOAuth2ClientRegistration をビルドします。
    B
    claim(StringSE name, ObjectSE value)
    クレームを設定します。
    B
    claims(ConsumerSE<MapSE<StringSE,ObjectSE>> claimsConsumer)
    これまでに宣言されたすべての claim(String, Object) へのアクセスを提供し、追加、置換、削除を可能にします。
    B
    clientId(StringSE clientId)
    クライアント識別子を設定します。REQUIRED。
    B
    clientIdIssuedAt(InstantSE clientIdIssuedAt)
    クライアント識別子が発行された時刻を設定します (OPTIONAL)。
    B
    clientName(StringSE clientName)
    エンドユーザーに提示されるクライアントの名前を設定します (OPTIONAL)。
    B
    clientSecret(StringSE clientSecret)
    クライアントシークレットを設定します (OPTIONAL)。
    B
    clientSecretExpiresAt(InstantSE clientSecretExpiresAt)
    client_secret が期限切れになる時刻、または期限切れにならない場合は null を設定します。client_secret が発行された場合は必須です。
    protected MapSE<StringSE,ObjectSE>
    getClaims()
    protected final B
    getThis()
    B
    grantType(StringSE grantType)
    クライアントが使用を制限する OAuth 2.0 grant_type を追加します (OPTIONAL)。
    B
    grantTypes(ConsumerSE<ListSE<StringSE>> grantTypesConsumer)
    OAuth 2.0 grant_type 値の Consumer は、クライアントが使用を制限し、追加、置換、削除する機能を許可します (OPTIONAL)。
    B
    jwkSetUrl(StringSE jwkSetUrl)
    クライアントの JSON Web キーセット、OPTIONAL の URL を設定します。
    B
    redirectUri(StringSE redirectUri)
    リダイレクトベースのフローに必須である、クライアントが使用するリダイレクト URI を追加します。
    B
    redirectUris(ConsumerSE<ListSE<StringSE>> redirectUrisConsumer)
    クライアントが使用するリダイレクト URI 値の Consumer。追加、置換、削除が可能で、リダイレクトベースのフローに必須です。
    B
    responseType(StringSE responseType)
    クライアントが使用を制限する OAuth 2.0 response_type を追加します (OPTIONAL)。
    B
    responseTypes(ConsumerSE<ListSE<StringSE>> responseTypesConsumer)
    OAuth 2.0 response_type 値の Consumer は、クライアントが使用を制限し、追加、置換、削除する機能を許可します (OPTIONAL)。
    B
    scope(StringSE scope)
    クライアントが使用を制限する OAuth 2.0 scope を追加します (OPTIONAL)。
    B
    scopes(ConsumerSE<ListSE<StringSE>> scopesConsumer)
    OAuth 2.0 scope 値の Consumer は、クライアントが使用を制限し、追加、置換、削除する機能を許可します (OPTIONAL)。
    B
    tokenEndpointAuthenticationMethod(StringSE tokenEndpointAuthenticationMethod)
    クライアントがトークンエンドポイントに使用する認証方法を設定します (OPTIONAL)。
    protected void
    validate()

    クラス java.lang.ObjectSE から継承されたメソッド

    clone, equalsSE, finalize, getClass, hashCode, notify, notifyAll, toString, wait, waitSE, waitSE

  • コンストラクターの詳細

    • AbstractBuilder

      protected AbstractBuilder()

  • メソッドの詳細

    • getClaims

      protected MapSE<StringSE,ObjectSE> getClaims()

    • getThis

      protected final B getThis()

    • clientId

      public B clientId(StringSE clientId)
      クライアント識別子を設定します。REQUIRED。
      パラメーター:
      clientId - クライアント識別子
      戻り値:
      さらなる構成のための AbstractOAuth2ClientRegistration.AbstractBuilder

    • clientIdIssuedAt

      public B clientIdIssuedAt(InstantSE clientIdIssuedAt)
      クライアント識別子が発行された時刻を設定します (OPTIONAL)。
      パラメーター:
      clientIdIssuedAt - クライアント識別子が発行された時刻
      戻り値:
      さらなる構成のための AbstractOAuth2ClientRegistration.AbstractBuilder

    • clientSecret

      public B clientSecret(StringSE clientSecret)
      クライアントシークレットを設定します (OPTIONAL)。
      パラメーター:
      clientSecret - クライアントシークレット
      戻り値:
      さらなる構成のための AbstractOAuth2ClientRegistration.AbstractBuilder

    • clientSecretExpiresAt

      public B clientSecretExpiresAt(InstantSE clientSecretExpiresAt)
      client_secret が期限切れになる時刻、または期限切れにならない場合は null を設定します。client_secret が発行された場合は必須です。
      パラメーター:
      clientSecretExpiresAt - client_secret が期限切れになる時刻、または期限切れにならない場合は null 
      戻り値:
      さらなる構成のための AbstractOAuth2ClientRegistration.AbstractBuilder

    • clientName

      public B clientName(StringSE clientName)
      エンドユーザーに提示されるクライアントの名前を設定します (OPTIONAL)。
      パラメーター:
      clientName - エンドユーザーに提示されるクライアントの名前
      戻り値:
      さらなる構成のための AbstractOAuth2ClientRegistration.AbstractBuilder

    • redirectUri

      public B redirectUri(StringSE redirectUri)
      リダイレクトベースのフローに必須である、クライアントが使用するリダイレクト URI を追加します。
      パラメーター:
      redirectUri - クライアントが使用するリダイレクト URI 
      戻り値:
      さらなる構成のための AbstractOAuth2ClientRegistration.AbstractBuilder

    • redirectUris

      public B redirectUris(ConsumerSE<ListSE<StringSE>> redirectUrisConsumer)
      クライアントが使用するリダイレクト URI 値の Consumer。追加、置換、削除が可能で、リダイレクトベースのフローに必須です。
      パラメーター:
      redirectUrisConsumer - クライアントが使用するリダイレクト URI 値の Consumer 
      戻り値:
      さらなる構成のための AbstractOAuth2ClientRegistration.AbstractBuilder

    • tokenEndpointAuthenticationMethod

      public B tokenEndpointAuthenticationMethod(StringSE tokenEndpointAuthenticationMethod)
      クライアントがトークンエンドポイントに使用する認証方法を設定します (OPTIONAL)。
      パラメーター:
      tokenEndpointAuthenticationMethod - クライアントがトークンエンドポイントに使用する認証方法
      戻り値:
      さらなる構成のための AbstractOAuth2ClientRegistration.AbstractBuilder

    • grantType

      public B grantType(StringSE grantType)
      クライアントが使用を制限する OAuth 2.0 grant_type を追加します (OPTIONAL)。
      パラメーター:
      grantType - クライアントが自身の使用を制限する OAuth 2.0 grant_type 
      戻り値:
      さらなる構成のための AbstractOAuth2ClientRegistration.AbstractBuilder

    • grantTypes

      public B grantTypes(ConsumerSE<ListSE<StringSE>> grantTypesConsumer)
      OAuth 2.0 grant_type 値の Consumer は、クライアントが使用を制限し、追加、置換、削除する機能を許可します (OPTIONAL)。
      パラメーター:
      grantTypesConsumer - クライアントが使用を制限する OAuth 2.0 grant_type 値の Consumer 
      戻り値:
      さらなる構成のための AbstractOAuth2ClientRegistration.AbstractBuilder

    • responseType

      public B responseType(StringSE responseType)
      クライアントが使用を制限する OAuth 2.0 response_type を追加します (OPTIONAL)。
      パラメーター:
      responseType - クライアントが自身の使用を制限する OAuth 2.0 response_type 
      戻り値:
      さらなる構成のための AbstractOAuth2ClientRegistration.AbstractBuilder

    • responseTypes

      public B responseTypes(ConsumerSE<ListSE<StringSE>> responseTypesConsumer)
      OAuth 2.0 response_type 値の Consumer は、クライアントが使用を制限し、追加、置換、削除する機能を許可します (OPTIONAL)。
      パラメーター:
      responseTypesConsumer - クライアントが使用を制限する OAuth 2.0 response_type 値の Consumer 
      戻り値:
      さらなる構成のための AbstractOAuth2ClientRegistration.AbstractBuilder

    • scope

      public B scope(StringSE scope)
      クライアントが使用を制限する OAuth 2.0 scope を追加します (OPTIONAL)。
      パラメーター:
      scope - クライアントが自身の使用を制限する OAuth 2.0 scope 
      戻り値:
      さらなる構成のための AbstractOAuth2ClientRegistration.AbstractBuilder

    • scopes

      public B scopes(ConsumerSE<ListSE<StringSE>> scopesConsumer)
      OAuth 2.0 scope 値の Consumer は、クライアントが使用を制限し、追加、置換、削除する機能を許可します (OPTIONAL)。
      パラメーター:
      scopesConsumer - クライアントが使用を制限する OAuth 2.0 scope 値の Consumer 
      戻り値:
      さらなる構成のための AbstractOAuth2ClientRegistration.AbstractBuilder

    • jwkSetUrl

      public B jwkSetUrl(StringSE jwkSetUrl)
      クライアントの JSON Web キーセット、OPTIONAL の URL を設定します。
      パラメーター:
      jwkSetUrl - クライアントの JSON Web キーセットの URL 
      戻り値:
      さらなる構成のための AbstractOAuth2ClientRegistration.AbstractBuilder

    • claim

      public B claim(StringSE name, ObjectSE value)
      クレームを設定します。
      パラメーター:
      name - クレーム名
      value - クレーム値
      戻り値:
      さらなる構成のための AbstractOAuth2ClientRegistration.AbstractBuilder

    • claims

      public B claims(ConsumerSE<MapSE<StringSE,ObjectSE>> claimsConsumer)
      これまでに宣言されたすべての claim(String, Object) へのアクセスを提供し、追加、置換、削除を可能にします。
      パラメーター:
      claimsConsumer - クレームの Consumer 
      戻り値:
      さらなる構成のための AbstractOAuth2ClientRegistration.AbstractBuilder

    • build

      public abstract T build()
      クレームを検証し、AbstractOAuth2ClientRegistration をビルドします。
      戻り値:
      AbstractOAuth2ClientRegistration

    • validate

      protected void validate()