DeploymentManager (Jakarta EE 8 Specification API)

```
public interface DeploymentManager
```
DeploymentManager オブジェクトは、Jakarta EE プラットフォームが Java EE アプリケーションデプロイに提供する必要のあるコア機能セットを提供します。デプロイターゲットのリスト、ベンダー固有のランタイム構成情報などのサーバー関連情報を提供します。

メソッドのサマリー

すべてのメソッドインスタンスメソッド抽象メソッド非推奨のメソッド
修飾子と型	メソッドと説明
`DeploymentConfiguration`	`createConfiguration(DeployableObject dObj)` Jakarta EE デプロイ可能コンポーネントのサーバー固有のデプロイ構成情報を提供するオブジェクトを取得します。
`ProgressObject`	`distribute(Target[] targetList, FileSE moduleArchive, FileSE deploymentPlan)` 配布メソッドは 3 つのタスクを実行します。デプロイ構成データを検証し、すべてのコンテナー固有のクラスとインターフェースを生成し、完全にベイクされたアーカイブを指定されたデプロイターゲットに移動します。
`ProgressObject`	`distribute(Target[] targetList, InputStreamSE moduleArchive, InputStreamSE deploymentPlan)` 使用すべきではありません。 Java EE 5 以降、`distribute(Target[], ModuleType, InputStream, InputStream)` に置き換え
`ProgressObject`	`distribute(Target[] targetList, ModuleType type, InputStreamSE moduleArchive, InputStreamSE deploymentPlan)` 配布メソッドは 3 つのタスクを実行します。デプロイ構成データを検証し、すべてのコンテナー固有のクラスとインターフェースを生成し、完全にベイクされたアーカイブを指定されたデプロイターゲットに移動します。
`TargetModuleID[]`	`getAvailableModules(ModuleType moduleType, Target[] targetList)` 識別されたターゲットで実行中または実行されていないすべての Jakarta EE アプリケーションモジュールのリストを取得します。
`LocaleSE`	`getCurrentLocale()` javax.enterprise.deploy.spi サブパッケージのこの実装が実行されているアクティブなロケールを返します。
`DConfigBeanVersionType`	`getDConfigBeanVersion()` 構成 Bean が提供されている Jakarta EE プラットフォームのバージョン番号を返します。
`LocaleSE`	`getDefaultLocale()` javax.enterprise.deploy.spi サブパッケージのこの実装でサポートされるデフォルトのロケールを返します。
`TargetModuleID[]`	`getNonRunningModules(ModuleType moduleType, Target[] targetList)` 識別されたターゲットに配布され、現在関連付けられているサーバーで実行されていない Jakarta EE アプリケーションモジュールのリストを取得します。
`TargetModuleID[]`	`getRunningModules(ModuleType moduleType, Target[] targetList)` 識別されたターゲットに配布され、現在関連付けられているサーバーで実行されている Jakarta EE アプリケーションモジュールのリストを取得します。
`LocaleSE[]`	`getSupportedLocales()` この実装でサポートされているロケールの配列を返します。
`Target[]`	`getTargets()` この DeploymentManager でサポートされるデプロイターゲットのリストを取得します。
`boolean`	`isDConfigBeanVersionSupported(DConfigBeanVersionType version)` 構成 Bean が指定された Jakarta EE プラットフォームのバージョンをサポートしている場合、"true" を返します。
`boolean`	`isLocaleSupported(LocaleSE locale)` この実装が指定されたロケールをサポートするかどうかを報告します。
`boolean`	`isRedeploySupported()` このメソッドは、このプラットフォームベンダーがアプリケーションの再デプロイメント機能を提供するかどうかを指定します。
`ProgressObject`	`redeploy(TargetModuleID[] moduleIDList, FileSE moduleArchive, FileSE deploymentPlan)` （オプション）redeploy メソッドは、現在デプロイされている Jakarta EE アプリケーションを更新する手段を提供します。
`ProgressObject`	`redeploy(TargetModuleID[] moduleIDList, InputStreamSE moduleArchive, InputStreamSE deploymentPlan)` （オプション）redeploy メソッドは、現在デプロイされている Jakarta EE アプリケーションを更新する手段を提供します。
`void`	`release()` リリース方法は、ツールが DeploymentManager にプラットフォームに接続された状態で実行を継続する必要がないことを通知するメカニズムです。
`void`	`setDConfigBeanVersion(DConfigBeanVersionType version)` 使用する構成 Bean を、特定の Jakarta EE プラットフォームのバージョンに設定します。
`void`	`setLocale(LocaleSE locale)` javax.enterprise.deploy.spi サブパッケージのこの実装を実行するためのアクティブなロケールを設定します。
`ProgressObject`	`start(TargetModuleID[] moduleIDList)` 実行中のアプリケーションを起動します。
`ProgressObject`	`stop(TargetModuleID[] moduleIDList)` 実行中のアプリケーションを停止します。
`ProgressObject`	`undeploy(TargetModuleID[] moduleIDList)` ターゲットサーバーからアプリケーションを削除します。

- メソッドの詳細
  - getTargets
```
Target[] getTargets()
             throws IllegalStateExceptionSE
```
    この DeploymentManager でサポートされるデプロイターゲットのリストを取得します。
    戻り値:
    ユーザーがアプリケーションデプロイに対して選択できるデプロイターゲット指定子のリスト。存在しない場合は "null"。
    例外:
    IllegalStateExceptionSE - 切断モードで実行中にメソッドが呼び出されるとスローされます。
  - getRunningModules
```
TargetModuleID[] getRunningModules(ModuleType moduleType,
                                   Target[] targetList)
                            throws TargetException,
                                   IllegalStateExceptionSE
```
    識別されたターゲットに配布され、現在関連付けられているサーバーで実行されている Jakarta EE アプリケーションモジュールのリストを取得します。
    パラメーター:
    moduleType - Jakarta EE モジュール型の定義済み指定子。
    targetList - ユーザーがモジュールの実行ステータスを確認したいデプロイターゲット指定子のリスト。
    戻り値:
    実行中のモジュールを表す TargetModuleID オブジェクトの配列。存在しない場合は "null"。
    例外:
    IllegalStateExceptionSE - 切断モードで実行中にメソッドが呼び出されるとスローされます。
    TargetException - 無効なターゲット指定子が見つかりました。
  - getNonRunningModules
```
TargetModuleID[] getNonRunningModules(ModuleType moduleType,
                                      Target[] targetList)
                               throws TargetException,
                                      IllegalStateExceptionSE
```
    識別されたターゲットに配布され、現在関連付けられているサーバーで実行されていない Jakarta EE アプリケーションモジュールのリストを取得します。
    パラメーター:
    moduleType - Jakarta EE モジュール型の定義済み指定子。
    targetList - モジュールが実行されていない状態かどうかをユーザーが確認したいデプロイターゲット指定子のリスト。
    戻り値:
    実行されていないモジュールを表す TargetModuleID オブジェクトの配列。存在しない場合は "null"。
    例外:
    IllegalStateExceptionSE - 切断モードで実行中にメソッドが呼び出されるとスローされます。
    TargetException - 無効なターゲット指定子が見つかりました。
  - getAvailableModules
```
TargetModuleID[] getAvailableModules(ModuleType moduleType,
                                     Target[] targetList)
                              throws TargetException,
                                     IllegalStateExceptionSE
```
    識別されたターゲットで実行中または実行されていないすべての Jakarta EE アプリケーションモジュールのリストを取得します。
    パラメーター:
    moduleType - Jakarta EE モジュール型の定義済み指定子。
    targetList - モジュールが実行されていない状態かどうかをユーザーが確認したいデプロイターゲット指定子のリスト。
    戻り値:
    実行中または実行されていないすべてのデプロイ済みモジュールを表す TargetModuleID オブジェクトの配列、またはデプロイ済みモジュールがない場合は "null"。
    例外:
    IllegalStateExceptionSE - 切断モードで実行中にメソッドが呼び出されるとスローされます。
    TargetException - 無効なターゲット指定子が見つかりました。
  - createConfiguration
```
DeploymentConfiguration createConfiguration(DeployableObject dObj)
                                     throws InvalidModuleException
```
    Jakarta EE デプロイ可能コンポーネントのサーバー固有のデプロイ構成情報を提供するオブジェクトを取得します。
    パラメーター:
    dObj - Jakarta EE デプロイ可能コンポーネントを表すオブジェクト。
    例外:
    InvalidModuleException - DeployableObject は、この構成ツールでは不明またはサポートされていないコンポーネントです。
  - distribute
```
ProgressObject distribute(Target[] targetList,
                          FileSE moduleArchive,
                          FileSE deploymentPlan)
                   throws IllegalStateExceptionSE
```
    配布メソッドは 3 つのタスクを実行します。デプロイ構成データを検証し、すべてのコンテナー固有のクラスとインターフェースを生成し、完全にベイクされたアーカイブを指定されたデプロイターゲットに移動します。
    パラメーター:
    targetList - ユーザーがこのアプリケーションのデプロイ先を指定しているサーバーターゲットのリスト。
    moduleArchive - 配布するアプリケーションアーカイブのファイル名。
    deploymentPlan - このアプリケーションアーカイブに関連付けられているランタイム構成情報を含む XML ファイル。
    戻り値:
    ProgressObject は、配布プロセスのステータスを追跡および報告するオブジェクトです。
    例外:
    IllegalStateExceptionSE - 切断モードで実行中にメソッドが呼び出されるとスローされます。
  - distribute
```
ProgressObject distribute(Target[] targetList,
                          InputStreamSE moduleArchive,
                          InputStreamSE deploymentPlan)
                   throws IllegalStateExceptionSE
```
    非推奨。Java EE 5 以降、distribute(Target[], ModuleType, InputStream, InputStream) に置き換えられました。
    配布メソッドは 3 つのタスクを実行します。デプロイ構成データを検証し、すべてのコンテナー固有のクラスとインターフェースを生成し、完全にベイクされたアーカイブを指定されたデプロイターゲットに移動します。
    パラメーター:
    targetList - ユーザーがこのアプリケーションのデプロイ先を指定しているサーバーターゲットのリスト。
    moduleArchive - 配布するアプリケーションアーカイブを含む入力ストリーム。
    deploymentPlan - このアプリケーションアーカイブに関連付けられているデプロイ構成情報を含む入力ストリーム。
    戻り値:
    ProgressObject は、配布プロセスのステータスを追跡および報告するオブジェクトです。
    例外:
    IllegalStateExceptionSE - 切断モードで実行中にメソッドが呼び出されるとスローされます。
  - distribute
```
ProgressObject distribute(Target[] targetList,
                          ModuleType type,
                          InputStreamSE moduleArchive,
                          InputStreamSE deploymentPlan)
                   throws IllegalStateExceptionSE
```
    配布メソッドは 3 つのタスクを実行します。デプロイ構成データを検証し、すべてのコンテナー固有のクラスとインターフェースを生成し、完全にベイクされたアーカイブを指定されたデプロイターゲットに移動します。
    パラメーター:
    targetList - ユーザーがこのアプリケーションのデプロイ先を指定しているサーバーターゲットのリスト。
    type - このアプリケーションアーカイブのモジュール型。
    moduleArchive - 配布するアプリケーションアーカイブを含む入力ストリーム。
    deploymentPlan - このアプリケーションアーカイブに関連付けられているデプロイ構成情報を含む入力ストリーム。
    戻り値:
    ProgressObject は、配布プロセスのステータスを追跡および報告するオブジェクトです。
    例外:
    IllegalStateExceptionSE - 切断モードで実行中にメソッドが呼び出されるとスローされます。
  - start
```
ProgressObject start(TargetModuleID[] moduleIDList)
              throws IllegalStateExceptionSE
```
    実行中のアプリケーションを起動します。
    ルートモジュールを表す TargetModuleID のみが、起動に有効です。ルート TargetModuleID には親がありません。親を持つ TargetModuleID を個別に開始することはできません。ルート TargetModuleID モジュールとそのすべての子モジュールが開始されます。
    パラメーター:
    moduleIDList - 開始するモジュールを表す TargetModuleID オブジェクトの配列。
    戻り値:
    ProgressObject は、開始操作のステータスを追跡および報告するオブジェクトです。
    例外:
    IllegalStateExceptionSE - 切断モードで実行中にメソッドが呼び出されるとスローされます。
  - stop
```
ProgressObject stop(TargetModuleID[] moduleIDList)
             throws IllegalStateExceptionSE
```
    実行中のアプリケーションを停止します。
    ルートモジュールを表す TargetModuleID のみが停止に有効です。ルート TargetModuleID には親がありません。親を持つ TargetModuleID を個別に停止することはできません。ルート TargetModuleID モジュールとそのすべての子モジュールが停止します。
    パラメーター:
    moduleIDList - 停止するモジュールを表す TargetModuleID オブジェクトの配列。
    戻り値:
    ProgressObject 停止操作のステータスを追跡および報告するオブジェクト。
    例外:
    IllegalStateExceptionSE - 切断モードで実行中にメソッドが呼び出されるとスローされます。
  - undeploy
```
ProgressObject undeploy(TargetModuleID[] moduleIDList)
                 throws IllegalStateExceptionSE
```
    ターゲットサーバーからアプリケーションを削除します。
    ルートモジュールを表す TargetModuleID のみがアンデプロイに有効です。ルート TargetModuleID には親がありません。親を持つ TargetModuleID はアンデプロイできません。ルート TargetModuleID モジュールとそのすべての子モジュールはアンデプロイされます。ルート TargetModuleID モジュールとそのすべての子モジュールは、アンデプロイする前に停止する必要があります。
    パラメーター:
    moduleIDList - 停止するルートモジュールを表す TargetModuleID オブジェクトの配列。
    戻り値:
    ProgressObject 停止操作のステータスを追跡および報告するオブジェクト。
    例外:
    IllegalStateExceptionSE - 切断モードで実行中にメソッドが呼び出されるとスローされます。
  - isRedeploySupported
```
boolean isRedeploySupported()
```
    このメソッドは、このプラットフォームベンダーがアプリケーションの再デプロイメント機能を提供するかどうかを指定します。true の値は、サポートされていることを意味します。False はそうではないことを意味します。
    戻り値:
    true の値は、このベンダーの DeploymentManager によって再デプロイメントがサポートされることを意味します。False はそうではないことを意味します。
  - redeploy
```
ProgressObject redeploy(TargetModuleID[] moduleIDList,
                        FileSE moduleArchive,
                        FileSE deploymentPlan)
                 throws UnsupportedOperationExceptionSE,
                        IllegalStateExceptionSE
```
    （オプション）redeploy メソッドは、現在デプロイされている Jakarta EE アプリケーションを更新する手段を提供します。これは、ベンダー実装のオプションのメソッドです。再デプロイすると、現在デプロイされているアプリケーションが更新されたバージョンに置き換えられます。更新されたアプリケーションの実行時構成情報は、更新するアプリケーションと同じでなければなりません。アプリケーションの更新が再デプロイされるとき、元の実行中のアプリケーションへの既存のすべてのクライアント接続が中断されてはなりません。新しいクライアントはアプリケーションの更新に接続します。この操作は、ルートモジュールを表す TargetModuleID に対して有効です。ルート TargetModuleID には親がありません。ルート TargetModuleID モジュールとそのすべての子モジュールが再デプロイされます。子 TargetModuleID モジュールを個別に再デプロイすることはできません。再デプロイ操作は、すべてのモジュールに対するこのアクションが完了したときにのみ完了します。
    パラメーター:
    moduleIDList - 更新するアプリケーションの指定子の配列。
    moduleArchive - 配布するアプリケーションアーカイブのファイル名。
    deploymentPlan - このアプリケーションアーカイブに関連付けられているデプロイ構成情報。
    戻り値:
    ProgressObject は、再デプロイ操作のステータスを追跡および報告するオブジェクトです。
    例外:
    IllegalStateExceptionSE - 切断モードで実行中にメソッドが呼び出されるとスローされます。
    UnsupportedOperationExceptionSE - このオプションのコマンドは、この実装ではサポートされていません。
  - redeploy
```
ProgressObject redeploy(TargetModuleID[] moduleIDList,
                        InputStreamSE moduleArchive,
                        InputStreamSE deploymentPlan)
                 throws UnsupportedOperationExceptionSE,
                        IllegalStateExceptionSE
```
    （オプション）redeploy メソッドは、現在デプロイされている Jakarta EE アプリケーションを更新する手段を提供します。これは、ベンダー実装のオプションのメソッドです。再デプロイすると、現在デプロイされているアプリケーションが更新されたバージョンに置き換えられます。更新されたアプリケーションの実行時構成情報は、更新するアプリケーションと同じでなければなりません。アプリケーションの更新が再デプロイされるとき、元の実行中のアプリケーションへの既存のすべてのクライアント接続が中断されてはなりません。新しいクライアントはアプリケーションの更新に接続します。この操作は、ルートモジュールを表す TargetModuleID に対して有効です。ルート TargetModuleID には親がありません。ルート TargetModuleID モジュールとそのすべての子モジュールが再デプロイされます。子 TargetModuleID モジュールを個別に再デプロイすることはできません。再デプロイ操作は、すべてのモジュールに対するこのアクションが完了したときにのみ完了します。
    パラメーター:
    moduleIDList - 更新するアプリケーションの指定子の配列。
    moduleArchive - 配布するアプリケーションアーカイブを含む入力ストリーム。
    deploymentPlan - このアプリケーションアーカイブに関連付けられているランタイム構成情報を含む入力ストリーム。
    戻り値:
    ProgressObject は、再デプロイ操作のステータスを追跡および報告するオブジェクトです。
    例外:
    IllegalStateExceptionSE - 切断モードで実行中にメソッドが呼び出されるとスローされます。
    UnsupportedOperationExceptionSE - このオプションのコマンドは、この実装ではサポートされていません。
  - release
```
void release()
```
    リリースメソッドは、ツールが DeploymentManager にシグナルを送り、プラットフォームに接続して実行を継続する必要がないことを通知するメカニズムです。ツールは、切断モードで実行することを望んでいるか、シャットダウンする予定であることを示している可能性があります。リリースが呼び出されると、DeploymentManager はデプロイ構成用に持っていた Jakarta EE リソース接続を閉じ、その他の関連するリソースのクリーンアップを実行します。新しい操作リクエスト（つまり、配布、開始、停止、アンデプロイ、再デプロイ）を受け入れないようにする必要があります。現在処理中のすべての操作を終了する必要があります。実行中の操作に関連付けられている各 ProgressObject にはリリース済みのマークを付ける必要があります（ProgressObject を参照）。
  - getDefaultLocale
```
LocaleSE getDefaultLocale()
```
    javax.enterprise.deploy.spi サブパッケージのこの実装でサポートされるデフォルトのロケールを返します。
    戻り値:
    この実装のデフォルトのロケールをロケール設定します。
  - getCurrentLocale
```
LocaleSE getCurrentLocale()
```
    javax.enterprise.deploy.spi サブパッケージのこの実装が実行されているアクティブなロケールを返します。
    戻り値:
    この実装のアクティブなロケールをロケール設定します。
  - setLocale
```
void setLocale(LocaleSE locale)
        throws UnsupportedOperationExceptionSE
```
    javax.enterprise.deploy.spi サブパッケージのこの実装を実行するためのアクティブなロケールを設定します。
    例外:
    UnsupportedOperationExceptionSE - 提供ロケールはサポートされていません。
  - getSupportedLocales
```
LocaleSE[] getSupportedLocales()
```
    この実装でサポートされているロケールの配列を返します。
    戻り値:
    Locale[] サポートされているロケールのリスト。
  - isLocaleSupported
```
boolean isLocaleSupported(LocaleSE locale)
```
    この実装が指定されたロケールをサポートするかどうかを報告します。
    戻り値:
    "true" の値はサポートであることを意味し、"false" はサポートされていないことを意味します。
  - getDConfigBeanVersion
```
DConfigBeanVersionType getDConfigBeanVersion()
```
    構成 Bean が提供されている Jakarta EE プラットフォームのバージョン番号を返します。Bean は、Jakarta EE プラットフォームで必要な J2SE バージョンでコンパイルされている必要があります。
    戻り値:
    これらの Bean が提供されるプラットフォームのバージョン番号を表す DConfigBeanVersionType オブジェクト。
  - isDConfigBeanVersionSupported
```
boolean isDConfigBeanVersionSupported(DConfigBeanVersionType version)
```
    構成 Bean が指定された Jakarta EE プラットフォームのバージョンをサポートしている場合、"true" を返します。バージョンがサポートされていない場合は、"false" を返します。
    パラメーター:
    version - サポートがリクエストされている Jakarta EE プラットフォームのバージョンを表す DConfigBeanVersionType オブジェクト
    戻り値:
    バージョンがサポートされている場合は "true"、サポートされていない場合は "false"。
  - setDConfigBeanVersion
```
void setDConfigBeanVersion(DConfigBeanVersionType version)
                    throws DConfigBeanVersionUnsupportedException
```
    使用する構成 Bean を、特定の Jakarta EE プラットフォームのバージョンに設定します。
    パラメーター:
    version - サポートがリクエストされている Jakarta EE プラットフォームのバージョンを表す DConfigBeanVersionType オブジェクト
    例外:
    DConfigBeanVersionUnsupportedException - リクエストされた Bean バージョンがサポートされていない場合。

インターフェース DeploymentManager

メソッドのサマリー

メソッドの詳細

getTargets

getRunningModules

getNonRunningModules

getAvailableModules

createConfiguration

distribute

distribute

distribute

start

stop

undeploy

isRedeploySupported

redeploy

redeploy

release

getDefaultLocale

getCurrentLocale

setLocale

getSupportedLocales

isLocaleSupported

getDConfigBeanVersion

isDConfigBeanVersionSupported

setDConfigBeanVersion