プラグインの展開
最後に、プラグインのパッケージ化されたファイルをバンドルし、Windchill に展開する必要があります。
プラグインのコンパイルで説明したように、システム設定コレクターは、Java クラスローダーを使用して、カスタムプラグインであるすべてのファイルをロードします。クラスローダーがプラグインを認識できるようにするために、サービスファイルを作成し、プラグインとともに展開する必要があります (このファイルについては、「ソリューションエレメント」と「関連 Web サイト」を参照してください)。
機能的に展開されたプラグインを設定する手順は、次のとおりです。
1. ファイルをパッケージ化します。
2. ファイルを JAR ファイルにします。
3. JAR ファイルを展開します。
1. パッケージ化されたソースのディレクトリのルートに META-INF という名前のディレクトリを作成します。そのディレクトリ内に services という名前のサブディレクトリを作成します。services ディレクトリ内に com.ptc.customersupport.mbeans.PluginMBean というテキストファイルを作成します。これが、クラスローダーがプラグインのクラスファイルについて調べるサービスファイルです。このファイルは、ロードするプラグインごとに作成する必要があり、また厳密な構文フォーマットに従っている必要があります。サービスファイル内のプラグインエントリのフォーマットは、次のとおりです。
<java ソースパッケージ>.<プラグインクラス名> (括弧なし)
たとえば、CustomPlugin の例に戻ると、対応するサービスファイルには次の 1 行しか含まれていません。
com.ptc.customersupport.mbeans.plugins.CustomPlugin
ここに、CustomPlugin のソース、クラスファイル、およびサービスファイルのパッケージ構造の例を示します。
以下の点に注意してください。
◦ CustomPlugin のソースへのパッケージ構造 com/ptc/customersupport/mbeans/plugins は維持する必要があります。
◦ .class ファイルは /plugins ディレクトリにあります。オプションで、.java ソースファイルをこのディレクトリに配置することもできます。
◦ META-INF/services ディレクトリが存在します。
◦ /services ディレクトリにはロードされるプラグインごとにエントリがある com.ptc.customersupport.mbeans.PluginMBean が含まれています。
2. パッケージ構造とサービスファイルを作成したら、これらのファイルを Java .jar ファイルにバンドルする必要があります。Java の jar コマンドの詳細については、「関連 Web サイト」を参照してください。
windchill シェルを使用して、ルートのパッケージがある場所に移動し、.jar ファイルを作成します。
パッケージ構造を示す上記の例に戻り、
jar cvfM CustomPlugin.jar ./com ./META-INF
というコマンドを実行すると、/com ディレクトリと /META-INF ディレクトリのサブディレクトリを含むすべての内容を格納する CustomPlugin.jar が生成されます。
3. 最後に、この .jar ファイルをシステム設定コレクターのクラスローダーがある場所に展開する必要があります。このファイルをコピーして、<Windchill>/utilities/SystemConfigurationCollector/plugins ディレクトリに配置します。
これで、プラグインをシステム設定コレクターページで使用できる状態になりました。プラグインを使用するには、ブラウザを再表示し、カスタムプラグインをカスタムカテゴリに追加します。カスタムカテゴリの作成の詳細については、システム設定コレクターの使用方法に関するヘルプを参照してください。
システム設定コレクターとその使用法の詳細については、
システム設定コレクターを参照してください。
プラグインはすべて MBean であるため、JMX コンソールで使用するプラグインを展開することもできます。JMX コンソールを使用して CustomerSupport MBean に移動し、reloadPlugins() オペレーションを実行します。このオペレーションにより、プラグインの MBean ローダーが使用可能なすべてのプラグイン (展開場所にあるものも含む) を再読み込みします。次のスクリーンショットは、ユーザーが reloadPlugins CustomerSupport MBean オペレーションを呼び出しているところを示しています。
reloadPlugins CustomerSupport MBean オペレーションを呼び出したら、プラグインが定義されている個別のプラグインタイプのサブディレクトリにある com.ptc/plugins MBean の下にカスタムプラグインが表示されます。
JMX コンソールからプラグインを再読み込みする方法の詳細とイメージについては、「予測される結果」を参照してください。
