クラス ClientRegistration.Builder
java.lang.ObjectSE
org.springframework.security.oauth2.client.registration.ClientRegistration.Builder
- 実装されているすべてのインターフェース:
SerializableSE
- 含まれているクラス:
- ClientRegistration
ClientRegistration のビルダー。- 関連事項:
メソッドのサマリー
修飾子と型メソッド説明authorizationGrantType(AuthorizationGrantType authorizationGrantType) クライアントに使用するauthorization grant typeを設定します。authorizationUri(StringSE authorizationUri) 認可エンドポイントの URI を設定します。build()新しいClientRegistrationを作成します。clientAuthenticationMethod(ClientAuthenticationMethod clientAuthenticationMethod) 認可サーバーでクライアントを認証するときに使用されるauthentication methodを設定します。クライアント識別子を設定します。clientName(StringSE clientName) クライアントまたは登録の論理名を設定します。clientSecret(StringSE clientSecret) クライアントシークレットを設定します。OpenID Connect 1.0 プロバイダーまたは OAuth 2.0 認可サーバーの発行者識別子 uri を設定します。JSON Web キー(JWK)セットエンドポイントの URI を設定します。providerConfigurationMetadata(MapSE<StringSE, ObjectSE> configurationMetadata) プロバイダーの構成を説明するメタデータを設定します。redirectUri(StringSE redirectUri) リダイレクトエンドポイントの URI(または URI テンプレート)を設定します。registrationId(StringSE registrationId) 登録 ID を設定します。クライアントに使用されるスコープを設定します。scope(CollectionSE<StringSE> scope) クライアントに使用されるスコープを設定します。トークンエンドポイントの URI を設定します。userInfoAuthenticationMethod(AuthenticationMethod userInfoAuthenticationMethod) ユーザー情報エンドポイントの認証方法を設定します。userInfoUri(StringSE userInfoUri) ユーザー情報エンドポイントの URI を設定します。userNameAttributeName(StringSE userNameAttributeName) ユーザー情報レスポンスからユーザーの名前にアクセスするために使用される属性名を設定します。
メソッドの詳細
registrationId
登録 ID を設定します。- パラメーター:
registrationId- ID の登録- 戻り値:
ClientRegistration.Builder
clientId
クライアント識別子を設定します。- パラメーター:
clientId- クライアント識別子- 戻り値:
ClientRegistration.Builder
clientSecret
クライアントシークレットを設定します。- パラメーター:
clientSecret- クライアントの秘密- 戻り値:
ClientRegistration.Builder
clientAuthenticationMethod
public ClientRegistration.Builder clientAuthenticationMethod(ClientAuthenticationMethod clientAuthenticationMethod) 認可サーバーでクライアントを認証するときに使用されるauthentication methodを設定します。- パラメーター:
clientAuthenticationMethod- クライアントに使用される認証方法- 戻り値:
ClientRegistration.Builder
authorizationGrantType
public ClientRegistration.Builder authorizationGrantType(AuthorizationGrantType authorizationGrantType) クライアントに使用するauthorization grant typeを設定します。- パラメーター:
authorizationGrantType- クライアントに使用される認可付与型- 戻り値:
ClientRegistration.Builder
redirectUri
リダイレクトエンドポイントの uri (または uri テンプレート) を設定します。
サポートされている uri テンプレート変数は、{baseScheme}、{baseHost}、{basePort}、{basePath}、{registrationId} です。
注 : {baseUrl} もサポートされています。これは {baseScheme}://{baseHost}{basePort}{basePath} と同じです。
uri テンプレート変数の構成は、クライアントがプロキシサーバーの背後で実行されている場合に特に役立ちます。これにより、redirect-uri を展開するときに X-Forwarded-* ヘッダーが使用されるようになります。- パラメーター:
redirectUri- リダイレクトエンドポイントの URI(または URI テンプレート)- 戻り値:
ClientRegistration.Builder- 導入:
- 5.4
scope
クライアントに使用されるスコープを設定します。- パラメーター:
scope- クライアントに使用されるスコープ- 戻り値:
ClientRegistration.Builder
scope
クライアントに使用されるスコープを設定します。- パラメーター:
scope- クライアントに使用されるスコープ- 戻り値:
ClientRegistration.Builder
authorizationUri
認可エンドポイントの URI を設定します。- パラメーター:
authorizationUri- 認可エンドポイントの URI- 戻り値:
ClientRegistration.Builder
tokenUri
トークンエンドポイントの URI を設定します。- パラメーター:
tokenUri- トークンエンドポイントの URI- 戻り値:
ClientRegistration.Builder
userInfoUri
ユーザー情報エンドポイントの URI を設定します。- パラメーター:
userInfoUri- ユーザー情報エンドポイントの URI- 戻り値:
ClientRegistration.Builder
userInfoAuthenticationMethod
public ClientRegistration.Builder userInfoAuthenticationMethod(AuthenticationMethod userInfoAuthenticationMethod) ユーザー情報エンドポイントの認証方法を設定します。- パラメーター:
userInfoAuthenticationMethod- ユーザー情報エンドポイントの認証方法- 戻り値:
ClientRegistration.Builder- 導入:
- 5.1
userNameAttributeName
ユーザー情報レスポンスからユーザーの名前にアクセスするために使用される属性名を設定します。- パラメーター:
userNameAttributeName- ユーザー情報レスポンスからユーザーの名前にアクセスするために使用される属性名- 戻り値:
ClientRegistration.Builder
jwkSetUri
JSON Web キー(JWK)セットエンドポイントの URI を設定します。- パラメーター:
jwkSetUri- JSON Web キー(JWK)Set エンドポイントの URI- 戻り値:
ClientRegistration.Builder
issuerUri
OpenID Connect 1.0 プロバイダーまたは OAuth 2.0 認可サーバーの発行者識別子 uri を設定します。- パラメーター:
issuerUri- OpenID Connect 1.0 プロバイダーまたは OAuth 2.0 認可サーバーの発行者識別子 uri- 戻り値:
ClientRegistration.Builder- 導入:
- 5.4
providerConfigurationMetadata
public ClientRegistration.Builder providerConfigurationMetadata(MapSE<StringSE, ObjectSE> configurationMetadata) プロバイダーの構成を説明するメタデータを設定します。- パラメーター:
configurationMetadata- プロバイダーの構成を説明するメタデータ- 戻り値:
ClientRegistration.Builder- 導入:
- 5.1
clientName
クライアントまたは登録の論理名を設定します。- パラメーター:
clientName- クライアントまたは登録名- 戻り値:
ClientRegistration.Builder
build
新しいClientRegistrationを作成します。