インターフェース SeBootstrap.Configuration
- 含まれているインターフェース:
- SeBootstrap
public static interface SeBootstrap.Configuration
アプリケーションをブートストラップするために JAX-RS 実装に必要な情報を提供します。構成は、基本的に一連のパラメーターで構成されます。実際に有効なキーのセットは製品固有ですが、
SeBootstrap.Configuration
インターフェースで定義されたキー定数はすべての準拠製品で有効でなければなりません。不明なキーは確認なしで無視する必要があります。- 導入:
- 3.1
- 作成者:
- Markus KARG (markus@headcrashing.eu)
ネストされたクラスのサマリー
ネストされたクラス 修飾子と型 インターフェース 説明 static interface
SeBootstrap.Configuration.Builder
ブートストラップSeBootstrap.Configuration
のビルダー。static class
SeBootstrap.Configuration.SSLClientAuthentication
セキュアソケットクライアント認証ポリシー
フィールドサマリー
フィールド 修飾子と型 フィールド 説明 static int
DEFAULT_PORT
実装がそのデフォルトポートを使用しなければならないことを示すPORT
プロパティの特別な値。static int
FREE_PORT
実装が空きポートをスキャンする必要があることを示すPORT
プロパティの特別な値。static StringSE
HOST
アプリケーションがバインドされるホスト名または IP アドレスの構成キー。static StringSE
PORT
アプリケーションがバインドされている TCP ポートの構成キー。static StringSE
PROTOCOL
アプリケーションがバインドされているプロトコルの構成キー。static StringSE
ROOT_PATH
アプリケーションがバインドされるルートパスの構成キー。static StringSE
SSL_CLIENT_AUTHENTICATION
セキュアソケットクライアント認証ポリシーの構成キー。static StringSE
SSL_CONTEXT
使用するセキュアソケット構成の構成キー。
メソッドのサマリー
すべてのメソッド 静的メソッド インスタンスメソッド 抽象メソッド デフォルトメソッド 修飾子と型 メソッド 説明 default URISE
baseUri()
アプリケーションのビルドされたURI
SE を返す便利なメソッド。default UriBuilder
baseUriBuilder()
アプリケーションのルートパスを含むUriBuilder
を返します。static SeBootstrap.Configuration.Builder
builder()
新しいブートストラップ構成ビルダーインスタンスを作成します。default boolean
hasProperty(StringSE name)
指定された名前のプロパティが明示的に構成されているか、デフォルトで構成されているかを返します。default StringSE
host()
host
を使用するための便利なメソッド。default int
port()
実際に使用されているport
を取得するための便利なメソッド。ObjectSE
property(StringSE name)
指定された名前のプロパティの値を返します。その名前のプロパティがない場合はnull
を返します。default StringSE
protocol()
protocol
を使用するための便利なメソッド。default StringSE
rootPath()
rootPath
を使用するための便利なメソッド。default SeBootstrap.Configuration.SSLClientAuthentication
sslClientAuthentication()
セキュアソケットクライアント認証ポリシーを取得する便利なメソッド。default SSLContextSE
sslContext()
sslContext
を使用するための便利なメソッド。
フィールドの詳細
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
- 関連事項:
- 定数フィールド値
SSL_CONTEXT
static final StringSE SSL_CONTEXT
使用するセキュアソケット構成の構成キー。デフォルト値は
SSLContext.getDefault()
です。- 導入:
- 3.1
- 関連事項:
- 定数フィールド値
SSL_CLIENT_AUTHENTICATION
static final StringSE SSL_CLIENT_AUTHENTICATION
セキュアソケットクライアント認証ポリシーの構成キー。準拠した実装は、
SeBootstrap.Configuration.SSLClientAuthentication
列挙型を受け入れなければなりません。デフォルト値は
SSLClientAuthentication#NONE
です。- 導入:
- 3.1
- 関連事項:
- 定数フィールド値
FREE_PORT
static final int FREE_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
protocol
default StringSE protocol()
protocol
を使用するための便利なメソッド。(String) property(PROTOCOL)
を呼び出した場合と同じです。- 戻り値:
- 使用するプロトコル (例:
"HTTP")
. - 例外:
ClassCastExceptionSE
- protocol がString
SE でない場合。- 導入:
- 3.1
- 関連事項:
PROTOCOL
host
default StringSE host()
host
を使用するための便利なメソッド。(String) property(HOST)
を呼び出した場合と同じです。- 戻り値:
- 使用するホスト名または IP アドレス (例:
"localhost"
または"0.0.0.0"
)。 - 例外:
ClassCastExceptionSE
- ホストがString
SE でない場合。- 導入:
- 3.1
- 関連事項:
HOST
port
default int port()
実際に使用されているport
を取得するための便利なメソッド。(int) property(PORT)
を呼び出した場合と同じです。ポートが明示的に指定されていない場合、JAX-RS 実装によって暗黙的に選択されたポートが返されます。
- 戻り値:
- 実際に使用されるポート番号 (例:
8080
)。 - 例外:
ClassCastExceptionSE
- ポートがInteger
でない場合。- 導入:
- 3.1
- 関連事項:
PORT
rootPath
default StringSE rootPath()
rootPath
を使用するための便利なメソッド。(String) property(ROOT_PATH)
を呼び出した場合と同じです。- 戻り値:
- 使用するルートパス。
"/"
。 - 例外:
ClassCastExceptionSE
- ルートパスがString
SE でない場合。- 導入:
- 3.1
- 関連事項:
ROOT_PATH
sslContext
default SSLContextSE sslContext()
sslContext
を使用するための便利なメソッド。(SSLContext) property(SSL_CONTEXT)
を呼び出した場合と同じです。- 戻り値:
- 使用するルートパス。g.
"/"
。 - 例外:
ClassCastExceptionSE
- if sslContext is not aSSLContext
SE。- 導入:
- 3.1
- 関連事項:
SSL_CONTEXT
sslClientAuthentication
default SeBootstrap.Configuration.SSLClientAuthentication sslClientAuthentication()
セキュアソケットクライアント認証ポリシーを取得する便利なメソッド。(SSLClientAuthentication) property(SSL_CLIENT_AUTHENTICATION)
を呼び出した場合と同じです。- 戻り値:
- クライアント認証モード、e。g.
NONE
。 - 例外:
ClassCastExceptionSE
- if sslClientAuthentication is not aSeBootstrap.Configuration.SSLClientAuthentication
。- 導入:
- 3.1
- 関連事項:
SSL_CLIENT_AUTHENTICATION
baseUriBuilder
default UriBuilder baseUriBuilder()
アプリケーションのルートパスを含むUriBuilder
を返します。- 戻り値:
- アプリケーションの
UriBuilder
。 - 導入:
- 3.1
baseUri
default URISE baseUri()
アプリケーションのビルドされたURI
SE を返す便利なメソッド。- 戻り値:
- アプリケーション用に構築された
URI
SE。 - 導入:
- 3.1
- 関連事項:
baseUriBuilder()
builder
static SeBootstrap.Configuration.Builder builder()
新しいブートストラップ構成ビルダーインスタンスを作成します。- 戻り値:
- ブートストラップ構成用の
SeBootstrap.Configuration.Builder
。 - 導入:
- 3.1