3.4. 管理 API

• JBoss EAP は、リクエストパスに対して設定された接頭辞を照合して、custom-constant HTTP ヘッダーを適用します。

  たとえば、/ や /management などのリクエストパスのリクエストに、custom-constant HTTP ヘッダーをマップできます。

• リクエストが複数の接頭辞に一致する場合、JBoss EAP はすべてのマッピングから custom-constant HTTP ヘッダーを適用します。

  たとえば、パス /management へのリクエストは、/ と /management の両方のマッピングと一致します。JBoss EAP は両方のマッピングからヘッダーを適用します。

• リクエストの処理の最後に、応答がクライアントに返される前に、対応するエンドポイントによって設定されたヘッダーをオーバーライドします。

  たとえば、管理エンドポイントは各応答に X-Frame-Options ヘッダーを設定します。X-Frame-Options という名前の custom-constant HTTP ヘッダーを定義すると、custom-constant HTTP ヘッダーがデフォルトのヘッダーをオーバーライドします。

• custom-constant HTTP ヘッダーには、RFC-7231 - Hypertext Transfer Protocol (HTTP/1.1): Semantics and Content でサポートされている文字のみを使用できます。

• 次の定義済み HTTP ヘッダーをオーバーライドすることはできません。

  • Connection
  • Content-Length
  • Content-Type
  • Date

  • Transfer-Encoding

    これらの定義済みヘッダーのいずれかをオーバーライドしようとすると、エラーが発生します。

  • たとえば、Date という名前で custom-constant HTTP ヘッダーを設定しようとすると、次のエラーが返されます。

    {
        "outcome" => "failed",
        "failure-description" => "WFLYCTL0458:Disallowed HTTP Header name 'Date'",
        "rolled-back" => true
    }

• JBoss EAP は指定されたパスにアクセスできるかどうかを検証しません。
• サブシステムは、HTTP 管理インターフェイスがサポートするコンテキストを動的に追加できます。
• custom-constant HTTP ヘッダーは、エンドポイントがリクエストへの応答を処理する方法を変更しません。

関連情報

• Hypertext Transfer Protocol (HTTP/1.1):Semantics and Content
• custom-constant HTTP ヘッダーの定義
• custom-constant HTTP ヘッダーを定義する CLI コマンド

検証

• HTTP 管理インターフェイスにリクエストを送信します。

  curl -s -D - -o /dev/null --digest http://localhost:9990/management/ -u USERNAME:PASSWORD

  custom-constant HTTP ヘッダー X-Help の例のレスポンス例

  admin:redhat
  HTTP/1.1 200 OK
  Connection: keep-alive
  X-Frame-Options: SAMEORIGIN
  Content-Type: application/json; charset=utf-8
  Content-Length: 3312
  X-Help: http://mywebsite.com
  Date: Tue, 27 Oct 2020 08:13:17 GMT

  レスポンスには、X-Help custom-constant HTTP ヘッダーが含まれます。

関連情報

• custom-constant ヘッダー
• custom-constant HTTP ヘッダーを定義する CLI コマンド

スタンドアロンモード

• 単一の custom-constant HTTP ヘッダーを定義するには、以下のコマンドを使用します。

  /core-service=management/management-interface=http-interface:write-attribute(name=constant-headers,value=[{path=/PREFIX,headers=[{name=X-HEADER,value=HEADERVALUE}]}])

  このコマンドにより、XML 設定は以下のようになります。

  <management-interfaces>
      <http-interface http-authentication-factory="management-http-authentication">
          <http-upgrade enabled="true" sasl-authentication-factory="management-sasl-authentication/>
          <socket-binding http="management-http"/>
          <constant-headers>
              <header-mapping path="/PREFIX">
                  <header name="X-HEADER" value="HEADERVALUE"/>
              </header-mapping>
          </constant-headers>
      </http-interface>
  </management-interfaces>

• 複数の custom-constant HTTP ヘッダーを定義するには、以下のコマンドを使用します。

  /core-service=management/management-interface=http-interface:write-attribute(name=constant-headers,value=[{path=/PREFIX1,headers=[{name=X-HEADER,value=HEADERVALUE-FOR-X}]},{path=/PREFIX2,headers=[{name=Y-HEADER,value=HEADERVALUE-FOR-Y}]}])

ドメインモード

• 単一の custom-constant HTTP ヘッダーを定義するには、以下のコマンドを使用します。

  /host=primary/core-service=management/management-interface=http-interface:write-attribute(name=constant-headers,value=[{path=/PREFIX,headers=[{name=X-HEADER,value=HEADER-VALUE}]}])

  このコマンドにより、XML 設定は以下のようになります。

  <management-interfaces>
      <http-interface http-authentication-factory="management-http-authentication">
          <http-upgrade enabled="true" sasl-authentication-factory="management-sasl-authentication/>
          <socket interface="management" port="${jboss.management.http.port:9990}"/>
          <constant-headers>
              <header-mapping path="/PREFIX">
                  <header name="X-HEADER" value="HEADER-VALUE"/>
              </header-mapping>
          </constant-headers>
      </http-interface>
  </management-interfaces>

• 複数の custom-constant HTTP ヘッダーを定義するには、以下のコマンドを使用します。

  /host=primary/core-service=management/management-interface=http-interface:write-attribute(name=constant-headers,value=[ {path=/PREFIX-1,headers=[{name=X-HEADER,value=HEADER-VALUE-FOR-X}]},{path=/PREFIX-2,headers=[{name=Y-HEADER,value=HEADER-VALUE-FOR-Y}]}])

関連情報

• custom-constant ヘッダー
• custom-constant HTTP ヘッダーの定義