パッケージ jakarta.ws.rs

インターフェース SeBootstrap.Configuration

  • 含まれているインターフェース:
    SeBootstrap

    public static interface SeBootstrap.Configuration
    アプリケーションをブートストラップするために JAX-RS 実装に必要な情報を提供します。

    構成は、基本的に一連のパラメーターで構成されます。実際に有効なキーのセットは製品固有ですが、SeBootstrap.Configuration インターフェースで定義されたキー定数はすべての準拠製品で有効でなければなりません。不明なキーは確認なしで無視する必要があります。

    導入:
    3.1
    作成者:
    Markus KARG (markus@headcrashing.eu)
    • フィールドの詳細

      • PROTOCOL

        static final StringSE PROTOCOL
        アプリケーションがバインドされているプロトコルの構成キー。

        これらのプロトコルがサポートされている場合、対応する実装は、文字列 "HTTP" および "HTTPS" を少なくとも受け入れなければなりません (MUST)。

        デフォルト値は "HTTP" です。

        導入:
        3.1
        関連事項:
        定数フィールド値
      • HOST

        static final StringSE HOST
        アプリケーションがバインドされるホスト名または IP アドレスの構成キー。

        準拠した実装は、少なくともホスト名、IP4 アドレステキスト表現、および IP6 アドレステキスト表現を含む文字列値を受け入れなければなりません (MUST)。ホスト名文字列、IP6 用の特別な IP4 アドレス文字列 "0.0.0.0" または "::" が提供される場合、アプリケーションは、そのホスト名に割り当てられたすべての IP アドレスにバインドする必要があります。ホスト名文字列が "localhost" の場合、アプリケーションはローカルホストのループバックアダプターのみにバインドする必要があります。

        デフォルト値は "localhost" です。

        導入:
        3.1
        関連事項:
        定数フィールド値
      • PORT

        static final StringSE PORT
        アプリケーションがバインドされている TCP ポートの構成キー。

        準拠した実装は、java.lang.Integer 値を受け入れなければなりません。

        この仕様で義務付けられているデフォルトのポートはありませんが、このプロパティのデフォルトDEFAULT_PORT (つまり -1) です。対応する実装は、-1 が提供される場合、独自のデフォルトポートを使用する必要があり、自動選択アルゴリズムと範囲スキャンアルゴリズムを適用できます (ただし、義務付けられていません)。

        導入:
        3.1
        関連事項:
        定数フィールド値
      • ROOT_PATH

        static final StringSE ROOT_PATH
        アプリケーションがバインドされるルートパスの構成キー。

        デフォルト値は "/" です。

        導入:
        3.1
        関連事項:
        定数フィールド値
      • FREE_PORT

        static final int FREE_PORT
        実装が空きポートをスキャンする必要があることを示す PORT プロパティの特別な値。
        導入:
        3.1
        関連事項:
        定数フィールド値
      • DEFAULT_PORT

        static final int DEFAULT_PORT
        実装がそのデフォルトポートを使用しなければならないことを示す PORT プロパティの特別な値。
        導入:
        3.1
        関連事項:
        定数フィールド値
    • メソッドの詳細

      • property

        ObjectSE property​(StringSE name)
        指定された名前のプロパティの値を返します。その名前のプロパティがない場合は null を返します。
        パラメーター:
        name - プロパティの名前を指定する String
        戻り値:
        プロパティの値を含む Object、または指定された名前に一致するプロパティが存在しない場合は null 
        導入:
        3.1
      • hasProperty

        default boolean hasProperty​(StringSE name)
        指定された名前のプロパティが明示的に構成されているか、デフォルトで構成されているかを返します。
        パラメーター:
        name - プロパティの名前を指定する String
        戻り値:
        指定された名前に一致するプロパティが存在しない場合は false、それ以外の場合は true
        導入:
        3.1
      • host

        default StringSE host()
        host を使用するための便利なメソッド。

        (String) property(HOST) を呼び出した場合と同じです。

        戻り値:
        使用するホスト名または IP アドレス (例: "localhost" または "0.0.0.0")。
        例外:
        ClassCastExceptionSE - ホストが StringSE でない場合。
        導入:
        3.1
        関連事項:
        HOST
      • port

        default int port()
        実際に使用されている port を取得するための便利なメソッド。

        (int) property(PORT) を呼び出した場合と同じです。

        ポートが明示的に指定されていない場合、JAX-RS 実装によって暗黙的に選択されたポートが返されます。

        戻り値:
        実際に使用されるポート番号 (例: 8080)。
        例外:
        ClassCastExceptionSE - ポートが Integer でない場合。
        導入:
        3.1
        関連事項:
        PORT
      • baseUriBuilder

        default UriBuilder baseUriBuilder()
        アプリケーションのルートパスを含む UriBuilder を返します。
        戻り値:
        アプリケーションの UriBuilder
        導入:
        3.1
      • baseUri

        default URISE baseUri()
        アプリケーションのビルドされた URISE を返す便利なメソッド。
        戻り値:
        アプリケーション用に構築された URISE
        導入:
        3.1
        関連事項:
        baseUriBuilder()