クラス ClientRegistration
java.lang.ObjectSE
org.springframework.security.oauth2.client.registration.ClientRegistration
- 実装されたすべてのインターフェース:
SerializableSE
OAuth 2.0 または OpenID Connect 1.0 プロバイダーを使用したクライアント登録の表現。
- 導入:
- 5.0
- 関連事項:
ネストされたクラスのサマリー
ネストされたクラスメソッドのサマリー
修飾子と型メソッド説明クライアントに使用されるauthorization grant type
を返します。認可サーバーでクライアントを認証するときに使用されるauthentication method
を返します。クライアント識別子を返します。クライアントまたは登録の論理名を返します。クライアントシークレットを返します。プロバイダーの詳細を返します。リダイレクトエンドポイントの uri(または uri テンプレート)を返します。登録の識別子を返します。クライアントに使用されるスコープを返します。toString()
static ClientRegistration.Builder
withClientRegistration
(ClientRegistration clientRegistration) 指定されたClientRegistration
で初期化された新しいClientRegistration.Builder
を返します。static ClientRegistration.Builder
withRegistrationId
(StringSE registrationId) 指定された登録識別子で初期化された新しいClientRegistration.Builder
を返します。
メソッドの詳細
getRegistrationId
登録の識別子を返します。- 戻り値:
- 登録の識別子
getClientId
クライアント識別子を返します。- 戻り値:
- クライアント識別子
getClientSecret
クライアントシークレットを返します。- 戻り値:
- クライアントの秘密
getClientAuthenticationMethod
認可サーバーでクライアントを認証するときに使用されるauthentication method
を返します。getAuthorizationGrantType
クライアントに使用されるauthorization grant type
を返します。getRedirectUri
リダイレクトエンドポイントの uri (または uri テンプレート) を返します。
サポートされている uri テンプレート変数は、{baseScheme}、{baseHost}、{basePort}、{basePath}、{registrationId} です。
注 : {baseUrl} もサポートされています。これは {baseScheme}://{baseHost}{basePort}{basePath} と同じです。
uri テンプレート変数の構成は、クライアントがプロキシサーバーの背後で実行されている場合に特に役立ちます。これにより、redirect-uri を展開するときに X-Forwarded-* ヘッダーが使用されるようになります。- 戻り値:
- リダイレクトエンドポイントの URI(または URI テンプレート)
- 導入:
- 5.4
getScopes
クライアントに使用されるスコープを返します。- 戻り値:
- スコープの
Set
getProviderDetails
プロバイダーの詳細を返します。getClientName
クライアントまたは登録の論理名を返します。- 戻り値:
- クライアントまたは登録名
toString
withRegistrationId
指定された登録識別子で初期化された新しいClientRegistration.Builder
を返します。- パラメーター:
registrationId
- 登録の識別子- 戻り値:
ClientRegistration.Builder
withClientRegistration
public static ClientRegistration.Builder withClientRegistration(ClientRegistration clientRegistration) 指定されたClientRegistration
で初期化された新しいClientRegistration.Builder
を返します。- パラメーター:
clientRegistration
- コピー元のClientRegistration
- 戻り値:
ClientRegistration.Builder