パッケージ org.springframework.security.oauth2.client.registration

クラス ClientRegistration.Builder

  • 実装されているすべてのインターフェース:
    java.io.Serializable
    含まれているクラス:
    ClientRegistration
    public static final class ClientRegistration.Builder
extends java.lang.Object
implements java.io.Serializable
    ClientRegistration のビルダー。
    関連事項:
    連載形式

    • メソッドの詳細

      • redirectUriTemplate

        @Deprecated
public ClientRegistration.Builder redirectUriTemplate​(java.lang.String redirectUriTemplate)
        使用すべきではありません。
        代わりに redirectUri(String) を使用してください
        リダイレクトエンドポイントの URI（または URI テンプレート）を設定します。
        パラメーター:
        redirectUriTemplate - リダイレクトエンドポイントの URI（または URI テンプレート）
        戻り値:
        ClientRegistration.Builder

      • redirectUri

        public ClientRegistration.Builder redirectUri​(java.lang.String 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

        public ClientRegistration.Builder scope​(java.lang.String... scope)
        クライアントに使用されるスコープを設定します。
        パラメーター:
        scope - クライアントに使用されるスコープ
        戻り値:
        ClientRegistration.Builder

      • scope

        public ClientRegistration.Builder scope​(java.util.Collection<java.lang.String> scope)
        クライアントに使用されるスコープを設定します。
        パラメーター:
        scope - クライアントに使用されるスコープ
        戻り値:
        ClientRegistration.Builder

      • authorizationUri

        public ClientRegistration.Builder authorizationUri​(java.lang.String authorizationUri)
        認可エンドポイントの URI を設定します。
        パラメーター:
        authorizationUri - 認可エンドポイントの URI
        戻り値:
        ClientRegistration.Builder

      • userInfoUri

        public ClientRegistration.Builder userInfoUri​(java.lang.String userInfoUri)
        ユーザー情報エンドポイントの URI を設定します。
        パラメーター:
        userInfoUri - ユーザー情報エンドポイントの URI
        戻り値:
        ClientRegistration.Builder

      • userInfoAuthenticationMethod

        public ClientRegistration.Builder userInfoAuthenticationMethod​(AuthenticationMethod userInfoAuthenticationMethod)
        ユーザー情報エンドポイントの認証方法を設定します。
        パラメーター:
        userInfoAuthenticationMethod - ユーザー情報エンドポイントの認証方法
        戻り値:
        ClientRegistration.Builder
        導入:
        5.1

      • userNameAttributeName

        public ClientRegistration.Builder userNameAttributeName​(java.lang.String userNameAttributeName)
        ユーザー情報レスポンスからユーザーの名前にアクセスするために使用される属性名を設定します。
        パラメーター:
        userNameAttributeName - ユーザー情報レスポンスからユーザーの名前にアクセスするために使用される属性名
        戻り値:
        ClientRegistration.Builder

      • jwkSetUri

        public ClientRegistration.Builder jwkSetUri​(java.lang.String jwkSetUri)
        JSON Web キー（JWK）セットエンドポイントの URI を設定します。
        パラメーター:
        jwkSetUri - JSON Web キー（JWK）Set エンドポイントの URI
        戻り値:
        ClientRegistration.Builder

      • issuerUri

        public ClientRegistration.Builder issuerUri​(java.lang.String 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​(java.util.Map<java.lang.String,​java.lang.Object> configurationMetadata)
        プロバイダーの構成を説明するメタデータを設定します。
        パラメーター:
        configurationMetadata - プロバイダーの構成を説明するメタデータ
        戻り値:
        ClientRegistration.Builder
        導入:
        5.1

      • clientName

        public ClientRegistration.Builder clientName​(java.lang.String clientName)
        クライアントまたは登録の論理名を設定します。
        パラメーター:
        clientName - クライアントまたは登録名
        戻り値:
        ClientRegistration.Builder