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

クラス ClientRegistration

java.lang.ObjectSE
org.springframework.security.oauth2.client.registration.ClientRegistration
実装されたすべてのインターフェース:
SerializableSE
public final class ClientRegistration extends ObjectSE implements SerializableSE
OAuth 2.0 または OpenID Connect 1.0 プロバイダーを使用したクライアント登録の表現。
導入:
5.0
関連事項:

  • メソッドの詳細

    • getRegistrationId

      public StringSE getRegistrationId()
      登録の識別子を返します。
      戻り値:
      登録の識別子

    • getClientId

      public StringSE getClientId()
      クライアント識別子を返します。
      戻り値:
      クライアント識別子

    • getClientSecret

      public StringSE getClientSecret()
      クライアントシークレットを返します。
      戻り値:
      クライアントのシークレット

    • getClientAuthenticationMethod

      public ClientAuthenticationMethod getClientAuthenticationMethod()
      認可サーバーでクライアントを認証するときに使用される authentication method を返します。
      戻り値:
      ClientAuthenticationMethod

    • getAuthorizationGrantType

      public AuthorizationGrantType getAuthorizationGrantType()
      クライアントに使用される authorization grant type を返します。
      戻り値:
      AuthorizationGrantType

    • getRedirectUri

      public StringSE 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 SetSE<StringSE> getScopes()
      クライアントに使用されるスコープを返します。
      戻り値:
      スコープの Set 

    • getProviderDetails

      public ClientRegistration.ProviderDetails getProviderDetails()
      プロバイダーの詳細を返します。
      戻り値:
      ClientRegistration.ProviderDetails

    • getClientName

      public StringSE getClientName()
      クライアントまたは登録の論理名を返します。
      戻り値:
      クライアントまたは登録名

    • toString

      public StringSE toString()
      オーバーライド:
      クラス ObjectSE の toString 

    • withRegistrationId

      public static ClientRegistration.Builder withRegistrationId(StringSE registrationId)
      指定された登録識別子で初期化された新しい ClientRegistration.Builder を返します。
      パラメーター:
      registrationId - 登録の識別子
      戻り値:
      ClientRegistration.Builder

    • withClientRegistration

      public static ClientRegistration.Builder withClientRegistration(ClientRegistration clientRegistration)
      指定された ClientRegistration で初期化された新しい ClientRegistration.Builder を返します。
      パラメーター:
      clientRegistration - コピー元の ClientRegistration
      戻り値:
      ClientRegistration.Builder