15 自己完結型アプリケーションでのJVMオプションのカスタマイズ

15.2.1 UserJvmOptionsServiceのインスタンス化

UserJvmOptionsService APIの使用の最初のステップは、使用するサービスのインスタンスを取得することです。 インスタンスは、パッケージャおよびランチャによって決定されます。 正しいインスタンスを取得するには、次の例のようなコマンドでUserJvmOptionsService.getUserJVMDefaults()を呼び出します。

UserJvmOptionsService ujo=UserJvmOptionsService.getUserJVMDefaults();

15.2.2 JVMオプションの現在値の取得

アプリケーションの現在のJVMオプションを取得するには、getUserJVMOptions()メソッドを使用します。 このメソッドは、アプリケーション・パッケージの作成時にsetUserJVMOptions()メソッドまたは-BuserJvmOptions引数を使用して設定されたJVMオプションおよび値を返します。 アプリケーションの起動後に設定に変更が加えられた場合、返される値はアプリケーション起動時に使用された設定ではなく、最新の設定です。

次の例は、15.2.1項「UserJvmOptionsServiceのインスタンス化」で取得したUserJvmOptionsServiceのインスタンスを使用するgetUserJVMOptions()メソッドへのサンプル・コールを示しています。

Map<String, String> userOptions = ujo.getUserJVMOptions();

JVMオプションはキーと値のペアとして返されます。 各キーはダッシュ(-)で始まります。 キーと値の間に等号記号(=)が必要な場合、キーは等号記号で終わらせます。

15.2.3 JVMオプションのデフォルト値の取得

アプリケーションのデフォルトのJVMオプションを取得するには、getUserJVMOptionDefaults()メソッドを使用します。 このメソッドは、アプリケーション・パッケージの作成時に-BuserJvmOptions引数を使用して設定されたJVMオプションおよび値を返します。

次の例は、15.2.1項「UserJvmOptionsServiceのインスタンス化」で取得したUserJvmOptionsServiceのインスタンスを使用するgetUserJVMOptionDefaults()メソッドへのサンプル・コールを示しています。

Map<String, String> defaults = ujo.getUserJVMOptionsDefaults();

JVMオプションはキーと値のペアとして返されます。 各キーはダッシュ(-)で始まります。 キーと値の間に等号記号(=)が必要な場合、キーは等号記号で終わらせます。

15.2.4 JVMオプションの新しい値の設定

JVMオプションに加えられた変更を格納するには、setUserJVMOptions()メソッドを使用します。 新しい値を使用するには、アプリケーションを再起動する必要があります。 アプリケーション・パッケージの作成時に-BuserJvmOptions引数で指定されたオプションにユーザーが値を設定しなかった場合、アプリケーション起動時には-BuserJvmOptions引数の値が使用されます。

JVMオプションはキーと値のペアとして渡されます。これらは、JVMに渡されるときに連結されます。 キーはダッシュ(-)で始めます。 キーと値の間に等号記号(=)が必要な場合、等号記号をキーの最後の文字にする必要があります。 たとえば、システム・プロパティapplicationNameをSampleAppに設定するには、キー-DapplicationName=および値SampleAppを使用します。 メモリー割当てプールの最大サイズを80メガバイトに設定するには、キー-Xmxおよび値80Mを使用します。

次の例は、15.2.1項「UserJvmOptionsServiceのインスタンス化」で取得したUserJvmOptionsServiceのインスタンスを使用するsetUserJVMOptions()メソッドへのサンプル・コール、およびuserOptions変数に含まれるオプションのセットを示しています。

ujo.setUserJVMOptions(userOptions);

15.2.5 UserJvmOptionsService APIの使用例

次のサンプル・コードは、UserJvmOptionsService APIを使用してアプリケーションが実行された最初および最後の時刻を追跡する方法を示しています。 サンプルでは、オプションの現在値とデフォルト値を示す表も生成されています。

// get the helper instance
UserJvmOptionsService ujo = UserJvmOptionsService.getUserJVMDefaults();
Map<String, String> userOptions = ujo.getUserJVMOptions();
 
// print out all the options currently set
for (Map.Entry <String, String> entry : userOptions.entrySet()) {
    System.out.println("key:" + entry.getKey() + " value:" + entry.getValue());
}
 
// if we haven't marked the first run, do so now
if (!userOptions.containsKey("-DfirstRunMs=")) {
    userOptions.put("-DfirstRunMs=", Long.toString(System.currentTimeMillis()));
}
 
// add the last run
userOptions.put("-DlastRunMs=", Long.toString(System.currentTimeMillis()));
 
// save the changes
ujo.setUserJVMOptions(userOptions);
 
...
 
// create a table row with Key, Current Value, and Default Value
DefaultTableModel model = new DefaultTableModel();
model.addColumn("Key");
model.addColumn("Effective");
model.addColumn("Default");
 
Map<String, String> defaults = ujo.getUserJVMOptionDefaults();
for (Map.Entry <String, String> entry : userOptions.entrySet()) {
    // get the default, it may be null
    String def = defaults.get(entry.getKey());
 
    model.addRow(new Object[] {entry.getKey(), entry.getValue(), 
                 def == null ? "<no default>" : def});
       }