クラス Application
- java.lang.ObjectSE
-
- jakarta.ws.rs.core.Application
public class Application extends ObjectSE
JAX-RS アプリケーションのコンポーネントを定義し、追加のメタデータを提供します。JAX-RS アプリケーションまたは実装は、この抽象クラスの具象サブクラスを提供します。アプリケーションサブクラスの実装で作成されたインスタンスは、
Context
を使用してリソースクラスとプロバイダーに注入できます。Application
サブクラスメソッドまたはそのコンストラクターのいずれかがRuntimeException
SE をスローした場合、アプリケーションのデプロイは失敗して中止されるべきです(SHOULD)。- 導入:
- 1.0
- 作成者:
- Paul Sandoz, Marc Hadley, Marek Potociar
コンストラクターのサマリー
コンストラクター コンストラクター 説明 Application()
メソッドのサマリー
すべてのメソッド インスタンスメソッド 具象メソッド 非推奨のメソッド 修飾子と型 メソッド 説明 SetSE<ClassSE<?>>
getClasses()
ルートリソース、プロバイダー、feature
クラスのセットを取得します。MapSE<StringSE,ObjectSE>
getProperties()
アプリケーション全体のカスタムプロパティのマップを取得します。SetSE<ObjectSE>
getSingletons()
使用すべきではありません。リソースとプロバイダーの自動検出またはgetClasses
メソッドは、getSingletons
より優先されます。
メソッドの詳細
getClasses
public SetSE<ClassSE<?>> getClasses()
ルートリソース、プロバイダー、feature
クラスのセットを取得します。リソースクラスインスタンスのデフォルトのライフサイクルはリクエストごとです。プロバイダーのデフォルトのライフサイクル(直接または機能を介して登録)はシングルトンです。実装は、ルートリソースまたはプロバイダー / 機能クラスの要件に準拠していないクラスについて警告し、無視する必要があります。実装は、
getSingletons()
がインスタンスを返すクラスについて警告し、無視する必要があります。実装は、返されたセットを変更してはなりません(MUSTNOT)。デフォルトの実装は空のセットを返します。
- 戻り値:
- ルートリソースとプロバイダークラスのセット。
null
を返すことは、空のセットを返すことと同じです。
getSingletons
@DeprecatedSE public SetSE<ObjectSE> getSingletons()
使用すべきではありません。リソースとプロバイダーの自動検出またはgetClasses
メソッドは、getSingletons
より優先されます。ルートリソース、プロバイダー、feature
インスタンスのセットを取得します。返されたインスタンスのフィールドとプロパティには、使用前にランタイムによって宣言された依存関係(Context
を参照)が挿入されます。実装は、ルートリソースまたはプロバイダークラスの要件に準拠していないクラスについて警告し、無視する必要があります。返されたセットに同じクラスのインスタンスが複数含まれている場合、実装はエラーにフラグを立てる必要があります。実装は、返されたセットを変更してはなりません(MUSTNOT)。
デフォルトの実装は空のセットを返します。
- 戻り値:
- ルートリソースとプロバイダーインスタンスのセット。
null
を返すことは、空のセットを返すことと同じです。
getProperties
public MapSE<StringSE,ObjectSE> getProperties()
アプリケーション全体のカスタムプロパティのマップを取得します。返されたプロパティは、サーバー側の機能に渡されるか、サーバー側の JAX-RS コンポーネントに挿入されるアプリケーション
configuration
に反映されます。返されるプロパティのセットは、コンテナー固有の機能とデプロイ記述子を使用して、デプロイ時にさらに拡張またはカスタマイズできます。例: サーブレットベースのデプロイシナリオでは、Web アプリケーションの
<context-param>
値とサーブレット<init-param>
値を使用して、このメソッドによってプログラムで返されるプロパティの値を継承またはオーバーライドできます。デフォルトの実装は空のセットを返します。
- 戻り値:
- カスタムアプリケーション全体のプロパティのマップ。
null
を返すことは、空のセットを返すことと同じです。 - 導入:
- 2.0