パッケージ org.springframework.security.oauth2.core.endpoint

クラス OAuth2AuthorizationRequest

java.lang.ObjectSE
org.springframework.security.oauth2.core.endpoint.OAuth2AuthorizationRequest
実装されたすべてのインターフェース:
SerializableSE
public final class OAuth2AuthorizationRequest extends ObjectSE implements SerializableSE
認可コード付与型の OAuth 2.0 認可リクエストの表現。
導入:
5.0
関連事項:

  • メソッドの詳細

    • getAuthorizationUri

      public StringSE getAuthorizationUri()
      認可エンドポイントの URI を返します。
      戻り値:
      認可エンドポイントの URI

    • getGrantType

      public AuthorizationGrantType getGrantType()
      grant type を返します。
      戻り値:
      AuthorizationGrantType

    • getResponseType

      public OAuth2AuthorizationResponseType getResponseType()
      response type を返します。
      戻り値:
      OAuth2AuthorizationResponseType

    • getClientId

      public StringSE getClientId()
      クライアント識別子を返します。
      戻り値:
      クライアント識別子

    • getRedirectUri

      public StringSE getRedirectUri()
      リダイレクトエンドポイントの URI を返します。
      戻り値:
      リダイレクトエンドポイントの URI

    • getScopes

      public SetSE<StringSE> getScopes()
      スコープを返します。
      戻り値:
      スコープ、または利用できない場合は空の Set 

    • getState

      public StringSE getState()
      状態を返します。
      戻り値:
      状態

    • getAdditionalParameters

      public MapSE<StringSE,ObjectSE> getAdditionalParameters()
      リクエストで使用される追加のパラメーターを返します。
      戻り値:
      追加パラメーターの Map、または利用できない場合は空の Map 

    • getAttributes

      public MapSE<StringSE,ObjectSE> getAttributes()
      リクエストに関連付けられている属性を返します。
      戻り値:
      属性の Map、または利用できない場合は空の Map 
      導入:
      5.2

    • getAttribute

      public <T> T getAttribute(StringSE name)
      リクエストに関連付けられている属性の値を返します。
      型パラメーター:
      T - 属性の型
      パラメーター:
      name - 属性の名前
      戻り値:
      リクエストに関連付けられた属性の値、または利用できない場合は null 
      導入:
      5.2

    • getAuthorizationRequestUri

      public StringSE getAuthorizationRequestUri()
      OAuth 2.0 認可リクエストの URI 文字列表現を返します。

      注意 : URI 文字列は、application/x-www-form-urlencoded MIME 形式でエンコードされます。

      戻り値:
      OAuth 2.0 認可リクエストの URI 文字列表現
      導入:
      5.1

    • authorizationCode

      public static OAuth2AuthorizationRequest.Builder authorizationCode()
      認証コード付与型で初期化された新しい OAuth2AuthorizationRequest.Builder を返します。
      戻り値:
      OAuth2AuthorizationRequest.Builder

    • from

      public static OAuth2AuthorizationRequest.Builder from(OAuth2AuthorizationRequest authorizationRequest)
      指定された authorizationRequest の値で初期化された新しい OAuth2AuthorizationRequest.Builder を返します。
      パラメーター:
      authorizationRequest - OAuth2AuthorizationRequest.Builder の初期化に使用される認可リクエスト
      戻り値:
      OAuth2AuthorizationRequest.Builder
      導入:
      5.1