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

クラス JwsHeader.Builder

  • 含まれているクラス:
    JwsHeader
    public static final class JwsHeader.Builder
extends java.lang.Object
    JwsHeader のビルダー。

    • メソッドのサマリー

      すべてのメソッド   インスタンスメソッド   具象メソッド  
      修飾子と型 メソッド 説明
      Balgorithm​(JwaAlgorithm jwaAlgorithm)
      JWS のデジタル署名または JWE の暗号化に使用される JWA algorithm を設定します。
      JwsHeaderbuild()
      新しい JwsHeader を作成します。
      BcontentType​(java.lang.String contentType)
      保護されたコンテンツのメディア型（ペイロード）を宣言するコンテンツ型ヘッダーを設定します。
      BcriticalHeader​(java.lang.String name, java.lang.Object value)
      JWS/JWE/JWA 仕様のどの拡張機能が使用されているかを示す重要なヘッダーを設定します。これらの拡張機能は、理解して処理する必要があります。
      protected java.util.Map<java.lang.String,​java.lang.Object>getHeaders()
      protected BgetThis()
      Bheader​(java.lang.String name, java.lang.Object value)
      ヘッダーを設定します。
      Bheaders​(java.util.function.Consumer<java.util.Map<java.lang.String,​java.lang.Object>> headersConsumer)
      追加、置換、削除する機能を可能にするヘッダーへのアクセスを提供される Consumer。
      Bjwk​(java.util.Map<java.lang.String,​java.lang.Object> jwk)
      JWS のデジタル署名または JWE の暗号化に使用されるキーに対応する公開鍵である JSON Web キーを設定します。
      BjwkSetUrl​(java.lang.String jwkSetUrl)
      JSON でエンコードされた公開鍵のセットのリソースを参照する JWK セット URL を設定します。そのうちの 1 つは、JWS のデジタル署名または JWE の暗号化に使用される鍵に対応します。
      BkeyId​(java.lang.String keyId)
      JWS または JWE を保護するために使用されたキーを示すヒントであるキー ID を設定します。
      Btype​(java.lang.String type)
      JWS/JWE のメディア型を宣言する型ヘッダーを設定します。
      Bx509CertificateChain​(java.util.List<java.lang.String> x509CertificateChain)
      X.509 公開鍵証明書または JWS のデジタル署名または JWE の暗号化に使用される鍵に対応する証明書チェーンを含む X.509 証明書チェーンを設定します。
      Bx509SHA1Thumbprint​(java.lang.String x509SHA1Thumbprint)
      base64url でエンコードされた SHA-1 拇印である X.509 証明書 SHA-1 拇印を設定します（別名
      Bx509SHA256Thumbprint​(java.lang.String x509SHA256Thumbprint)
      base64url でエンコードされた SHA-256 拇印である X.509 証明書 SHA-256 拇印を設定します（別名
      Bx509Url​(java.lang.String x509Url)
      JWS のデジタル署名または JWE の暗号化に使用されるキーに対応する X.509 公開鍵証明書または証明書チェーンのリソースを参照する X.509URL を設定します。

      • クラス java.lang.Object から継承されたメソッド

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • メソッドの詳細

      • getHeaders

        protected java.util.Map<java.lang.String,​java.lang.Object> getHeaders()

      • getThis

        protected final B getThis()

      • algorithm

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

      • jwkSetUrl

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

      • jwk

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

      • keyId

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

      • x509Url

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

      • x509CertificateChain

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

      • x509SHA1Thumbprint

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

      • x509SHA256Thumbprint

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

      • type

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

      • contentType

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

      • criticalHeader

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

      • header

        public B header​(java.lang.String name,
                java.lang.Object value)
        ヘッダーを設定します。
        パラメーター:
        name - ヘッダー名
        value - ヘッダー値
        戻り値:
        JoseHeader.AbstractBuilder

      • headers

        public B headers​(java.util.function.Consumer<java.util.Map<java.lang.String,​java.lang.Object>> headersConsumer)
        追加、置換、削除する機能を可能にするヘッダーへのアクセスを提供される Consumer。
        パラメーター:
        headersConsumer - ヘッダーの Consumer 
        戻り値:
        JoseHeader.AbstractBuilder