クラス ClientRegistration
- java.lang.Object
-
- org.springframework.security.oauth2.client.registration.ClientRegistration
- 実装されたすべてのインターフェース:
java.io.Serializable
public final class ClientRegistration extends java.lang.Object implements java.io.Serializable
OAuth 2.0 または OpenID Connect 1.0 プロバイダーを使用したクライアント登録の表現。- 導入:
- 5.0
- 関連事項:
- セクション 2 クライアント登録 , 直列化された形式
ネストされたクラスのサマリー
ネストされたクラス 修飾子と型 クラス 説明 static class
ClientRegistration.Builder
ClientRegistration
のビルダー。class
ClientRegistration.ProviderDetails
プロバイダーの詳細。
メソッドのサマリー
すべてのメソッド 静的メソッド インスタンスメソッド 具象メソッド 非推奨のメソッド 修飾子と型 メソッド 説明 AuthorizationGrantType
getAuthorizationGrantType()
クライアントに使用されるauthorization grant type
を返します。ClientAuthenticationMethod
getClientAuthenticationMethod()
認可サーバーでクライアントを認証するときに使用されるauthentication method
を返します。java.lang.String
getClientId()
クライアント識別子を返します。java.lang.String
getClientName()
クライアントまたは登録の論理名を返します。java.lang.String
getClientSecret()
クライアントシークレットを返します。ClientRegistration.ProviderDetails
getProviderDetails()
プロバイダーの詳細を返します。java.lang.String
getRedirectUri()
リダイレクトエンドポイントの uri(または uri テンプレート)を返します。java.lang.String
getRedirectUriTemplate()
使用すべきではありません。代わりにgetRedirectUri()
を使用してくださいjava.lang.String
getRegistrationId()
登録の識別子を返します。java.util.Set<java.lang.String>
getScopes()
クライアントに使用されるスコープを返します。java.lang.String
toString()
static ClientRegistration.Builder
withClientRegistration(ClientRegistration clientRegistration)
指定されたClientRegistration
で初期化された新しいClientRegistration.Builder
を返します。static ClientRegistration.Builder
withRegistrationId(java.lang.String registrationId)
指定された登録識別子で初期化された新しいClientRegistration.Builder
を返します。
メソッドの詳細
getRegistrationId
public java.lang.String getRegistrationId()
登録の識別子を返します。- 戻り値:
- 登録の識別子
getClientId
public java.lang.String getClientId()
クライアント識別子を返します。- 戻り値:
- クライアント識別子
getClientSecret
public java.lang.String getClientSecret()
クライアントシークレットを返します。- 戻り値:
- クライアントのシークレット
getClientAuthenticationMethod
public ClientAuthenticationMethod getClientAuthenticationMethod()
認可サーバーでクライアントを認証するときに使用されるauthentication method
を返します。
getAuthorizationGrantType
public AuthorizationGrantType getAuthorizationGrantType()
クライアントに使用されるauthorization grant type
を返します。
getRedirectUriTemplate
@Deprecated public java.lang.String getRedirectUriTemplate()
使用すべきではありません。代わりにgetRedirectUri()
を使用してくださいリダイレクトエンドポイントの uri(または uri テンプレート)を返します。- 戻り値:
- リダイレクトエンドポイントの URI(または URI テンプレート)
getRedirectUri
public java.lang.String getRedirectUri()
リダイレクトエンドポイントの uri (または uri テンプレート) を返します。
サポートされている uri テンプレート変数は、{baseScheme}、{baseHost}、{basePort}、{basePath}、{registrationId} です。
注 : {baseUrl} もサポートされています。これは {baseScheme}://{baseHost}{basePort}{basePath} と同じです。
uri テンプレート変数の構成は、クライアントがプロキシサーバーの背後で実行されている場合に特に役立ちます。これにより、redirect-uri を展開するときに X-Forwarded-* ヘッダーが使用されるようになります。- 戻り値:
- リダイレクトエンドポイントの URI(または URI テンプレート)
- 導入:
- 5.4
getScopes
public java.util.Set<java.lang.String> getScopes()
クライアントに使用されるスコープを返します。- 戻り値:
- スコープの
Set
getProviderDetails
public ClientRegistration.ProviderDetails getProviderDetails()
プロバイダーの詳細を返します。
getClientName
public java.lang.String getClientName()
クライアントまたは登録の論理名を返します。- 戻り値:
- クライアントまたは登録名
toString
public java.lang.String toString()
- オーバーライド:
- クラス
java.lang.Object
のtoString
withRegistrationId
public static ClientRegistration.Builder withRegistrationId(java.lang.String registrationId)
指定された登録識別子で初期化された新しいClientRegistration.Builder
を返します。- パラメーター:
registrationId
- 登録の識別子- 戻り値:
ClientRegistration.Builder
withClientRegistration
public static ClientRegistration.Builder withClientRegistration(ClientRegistration clientRegistration)
指定されたClientRegistration
で初期化された新しいClientRegistration.Builder
を返します。- パラメーター:
clientRegistration
- コピー元のClientRegistration
- 戻り値:
ClientRegistration.Builder