クラス OAuth2AuthorizationRequestRedirectFilter
- java.lang.Object
-
- org.springframework.web.filter.GenericFilterBean
-
- org.springframework.web.filter.OncePerRequestFilter
-
- org.springframework.security.oauth2.client.web.OAuth2AuthorizationRequestRedirectFilter
- 実装されたすべてのインターフェース:
javax.servlet.Filter
、org.springframework.beans.factory.Aware
、org.springframework.beans.factory.BeanNameAware
、org.springframework.beans.factory.DisposableBean
、org.springframework.beans.factory.InitializingBean
、org.springframework.context.EnvironmentAware
、org.springframework.core.env.EnvironmentCapable
、org.springframework.web.context.ServletContextAware
public class OAuth2AuthorizationRequestRedirectFilter extends org.springframework.web.filter.OncePerRequestFilter
このFilter
は、エンドユーザーのユーザーエージェントを認証サーバーの認証エンドポイントにリダイレクトすることにより、認証コードの認可または暗黙の認可フローを開始します。OAuth 2.0 認可リクエストを作成します。これは、認可エンドポイントへのリダイレクト
URI
として使用されます。リダイレクトURI
には、クライアント識別子、リクエストされたスコープ、状態、レスポンス型、エンドユーザーによってアクセスが認可(または拒否)された後、認可サーバーがユーザーエージェントを送り返すリダイレクト URI が含まれます(リソース所有者)。デフォルトでは、この
Filter
は、デフォルトのOAuth2AuthorizationRequestResolver
を使用してURI
/oauth2/authorization/{registrationId}
での認可リクエストに応答します。URI
テンプレート変数{registrationId}
は、OAuth 2.0 認可リクエストを開始するために使用されるクライアントのregistration identifier
を表します。デフォルトのベース
URI
/oauth2/authorization
は、コンストラクターOAuth2AuthorizationRequestRedirectFilter(ClientRegistrationRepository, String)
を介してオーバーライドできます。あるいは、コンストラクターOAuth2AuthorizationRequestRedirectFilter(OAuth2AuthorizationRequestResolver)
にOAuth2AuthorizationRequestResolver
を提供して、認可リクエストの解決をオーバーライドすることもできます。
フィールドサマリー
フィールド 修飾子と型 フィールド 説明 static java.lang.String
DEFAULT_AUTHORIZATION_REQUEST_BASE_URI
認可リクエストに使用されるデフォルトのベースURI
。
コンストラクターのサマリー
コンストラクター コンストラクター 説明 OAuth2AuthorizationRequestRedirectFilter(ClientRegistrationRepository clientRegistrationRepository)
指定されたパラメーターを使用してOAuth2AuthorizationRequestRedirectFilter
を構築します。OAuth2AuthorizationRequestRedirectFilter(ClientRegistrationRepository clientRegistrationRepository, java.lang.String authorizationRequestBaseUri)
指定されたパラメーターを使用してOAuth2AuthorizationRequestRedirectFilter
を構築します。OAuth2AuthorizationRequestRedirectFilter(OAuth2AuthorizationRequestResolver authorizationRequestResolver)
指定されたパラメーターを使用してOAuth2AuthorizationRequestRedirectFilter
を構築します。
メソッドのサマリー
すべてのメソッド インスタンスメソッド 具象メソッド 修飾子と型 メソッド 説明 protected void
doFilterInternal(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, javax.servlet.FilterChain filterChain)
void
setAuthorizationRequestRepository(AuthorizationRequestRepository<OAuth2AuthorizationRequest> authorizationRequestRepository)
OAuth2AuthorizationRequest
の保存に使用されるリポジトリを設定します。void
setRequestCache(RequestCache requestCache)
OAuth 2.0 認可リクエストをリダイレクトする前に、現在のリクエストを保存するために使用されるRequestCache
を設定します。クラス org.springframework.web.filter.OncePerRequestFilter から継承されたメソッド
doFilter, doFilterNestedErrorDispatch, getAlreadyFilteredAttributeName, isAsyncDispatch, isAsyncStarted, shouldNotFilter, shouldNotFilterAsyncDispatch, shouldNotFilterErrorDispatch
フィールドの詳細
DEFAULT_AUTHORIZATION_REQUEST_BASE_URI
public static final java.lang.String DEFAULT_AUTHORIZATION_REQUEST_BASE_URI
認可リクエストに使用されるデフォルトのベースURI
。- 関連事項:
- 定数フィールド値
コンストラクターの詳細
OAuth2AuthorizationRequestRedirectFilter
public OAuth2AuthorizationRequestRedirectFilter(ClientRegistrationRepository clientRegistrationRepository)
指定されたパラメーターを使用してOAuth2AuthorizationRequestRedirectFilter
を構築します。- パラメーター:
clientRegistrationRepository
- クライアント登録のリポジトリ
OAuth2AuthorizationRequestRedirectFilter
public OAuth2AuthorizationRequestRedirectFilter(ClientRegistrationRepository clientRegistrationRepository, java.lang.String authorizationRequestBaseUri)
指定されたパラメーターを使用してOAuth2AuthorizationRequestRedirectFilter
を構築します。- パラメーター:
clientRegistrationRepository
- クライアント登録のリポジトリauthorizationRequestBaseUri
- 認可リクエストに使用されるベースURI
OAuth2AuthorizationRequestRedirectFilter
public OAuth2AuthorizationRequestRedirectFilter(OAuth2AuthorizationRequestResolver authorizationRequestResolver)
指定されたパラメーターを使用してOAuth2AuthorizationRequestRedirectFilter
を構築します。- パラメーター:
authorizationRequestResolver
- 認可リクエストの解決に使用されるリゾルバー- 導入:
- 5.1
メソッドの詳細
setAuthorizationRequestRepository
public final void setAuthorizationRequestRepository(AuthorizationRequestRepository<OAuth2AuthorizationRequest> authorizationRequestRepository)
OAuth2AuthorizationRequest
の保存に使用されるリポジトリを設定します。- パラメーター:
authorizationRequestRepository
-OAuth2AuthorizationRequest
の保存に使用されるリポジトリ
setRequestCache
public final void setRequestCache(RequestCache requestCache)
OAuth 2.0 認可リクエストをリダイレクトする前に、現在のリクエストを保存するために使用されるRequestCache
を設定します。- パラメーター:
requestCache
- 現在のリクエストを保存するために使用されるキャッシュ
doFilterInternal
protected void doFilterInternal(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, javax.servlet.FilterChain filterChain) throws javax.servlet.ServletException, java.io.IOException
- 次で指定:
- クラス
org.springframework.web.filter.OncePerRequestFilter
のdoFilterInternal
- 例外:
javax.servlet.ServletException
java.io.IOException