パッケージ org.springframework.security.oauth2.jwt

クラス JwsHeader.Builder

java.lang.ObjectSE
org.springframework.security.oauth2.jwt.JwsHeader.Builder
含まれているクラス:
JwsHeader
public static final class JwsHeader.Builder extends ObjectSE
JwsHeader のビルダー。

  • メソッドの詳細

    • build

      public JwsHeader build()
      新しい JwsHeader を作成します。
      戻り値:
      JwsHeader

    • getHeaders

      protected MapSE<StringSE,ObjectSE> getHeaders()

    • getThis

      protected final JwsHeader.Builder getThis()

    • algorithm

      public JwsHeader.Builder algorithm(JwaAlgorithm jwaAlgorithm)
      JWS のデジタル署名または JWE の暗号化に使用される JWA algorithm を設定します。
      パラメーター:
      jwaAlgorithm - JwaAlgorithm
      戻り値:
      JoseHeader.AbstractBuilder

    • jwkSetUrl

      public JwsHeader.Builder jwkSetUrl(StringSE jwkSetUrl)
      JSON でエンコードされた公開鍵のセットのリソースを参照する JWK セット URL を設定します。そのうちの 1 つは、JWS のデジタル署名または JWE の暗号化に使用される鍵に対応します。
      パラメーター:
      jwkSetUrl - JWK セットの URL
      戻り値:
      JoseHeader.AbstractBuilder

    • jwk

      public JwsHeader.Builder jwk(MapSE<StringSE,ObjectSE> jwk)
      JWS のデジタル署名または JWE の暗号化に使用されるキーに対応する公開鍵である JSON Web キーを設定します。
      パラメーター:
      jwk - JSON Web キー
      戻り値:
      JoseHeader.AbstractBuilder

    • keyId

      public JwsHeader.Builder keyId(StringSE keyId)
      JWS または JWE を保護するために使用されたキーを示すヒントであるキー ID を設定します。
      パラメーター:
      keyId - キー ID
      戻り値:
      JoseHeader.AbstractBuilder

    • x509Url

      public JwsHeader.Builder x509Url(StringSE x509Url)
      JWS のデジタル署名または JWE の暗号化に使用されるキーに対応する X.509 公開鍵証明書または証明書チェーンのリソースを参照する X.509URL を設定します。
      パラメーター:
      x509Url - X.509URL
      戻り値:
      JoseHeader.AbstractBuilder

    • x509CertificateChain

      public JwsHeader.Builder x509CertificateChain(ListSE<StringSE> x509CertificateChain)
      X.509 公開鍵証明書または JWS のデジタル署名または JWE の暗号化に使用される鍵に対応する証明書チェーンを含む X.509 証明書チェーンを設定します。証明書または証明書チェーンは、証明書値 String の List として表されます。List の各 String は、Base64 でエンコードされた DERPKIX 証明書の値です。
      パラメーター:
      x509CertificateChain - X.509 証明書チェーン
      戻り値:
      JoseHeader.AbstractBuilder

    • x509SHA1Thumbprint

      public JwsHeader.Builder x509SHA1Thumbprint(StringSE x509SHA1Thumbprint)
      JWS のデジタル署名または JWE の暗号化に使用されるキーに対応する X.509 証明書の DER エンコードの base64url エンコード SHA-1 拇印（別名ダイジェスト）である X.509 証明書 SHA-1 拇印を設定します。
      パラメーター:
      x509SHA1Thumbprint - X.509 証明書 SHA-1 拇印
      戻り値:
      JoseHeader.AbstractBuilder

    • x509SHA256Thumbprint

      public JwsHeader.Builder x509SHA256Thumbprint(StringSE x509SHA256Thumbprint)
      JWS のデジタル署名または JWE の暗号化に使用されるキーに対応する X.509 証明書の DER エンコードの base64url エンコード SHA-256 拇印（別名ダイジェスト）である X.509 証明書 SHA-256 拇印を設定します。
      パラメーター:
      x509SHA256Thumbprint - X.509 証明書 SHA-256 拇印
      戻り値:
      JoseHeader.AbstractBuilder

    • type

      public JwsHeader.Builder type(StringSE type)
      JWS/JWE のメディア型を宣言する型ヘッダーを設定します。
      パラメーター:
      type - 型ヘッダー
      戻り値:
      JoseHeader.AbstractBuilder

    • contentType

      public JwsHeader.Builder contentType(StringSE contentType)
      保護されたコンテンツのメディア型（ペイロード）を宣言するコンテンツ型ヘッダーを設定します。
      パラメーター:
      contentType - コンテンツ型ヘッダー
      戻り値:
      JoseHeader.AbstractBuilder

    • criticalHeader

      public JwsHeader.Builder criticalHeader(StringSE name, ObjectSE value)
      JWS/JWE/JWA 仕様のどの拡張機能が使用されているかを示す重要なヘッダーを設定します。これらの拡張機能は、理解して処理する必要があります。
      パラメーター:
      name - 重要なヘッダー名
      value - 重要なヘッダー値
      戻り値:
      JoseHeader.AbstractBuilder

    • header

      public JwsHeader.Builder header(StringSE name, ObjectSE value)
      ヘッダーを設定します。
      パラメーター:
      name - ヘッダー名
      value - ヘッダー値
      戻り値:
      JoseHeader.AbstractBuilder

    • headers

      public JwsHeader.Builder headers(ConsumerSE<MapSE<StringSE,ObjectSE>> headersConsumer)
      追加、置換、削除する機能を可能にするヘッダーへのアクセスを提供される Consumer。
      パラメーター:
      headersConsumer - ヘッダーの Consumer 
      戻り値:
      JoseHeader.AbstractBuilder