public class PluginManager extends Object
ファイル名 説明 plugin.xml プラグイン設定ファイル plugin.properties
または
plugin_***.properties
プラグイン設定ファイルに差し込む国際化情報
javaで用いられるリソースバンドルを用いたプロパティファイル
このインスタンスは、インスタンス作成時に、呼び出し元のコンテキストに紐づくLocale, TenantIdを内包します。<?xml version="1.0" encoding="UTF-8"?>
<plugin>
<extension point="{拡張ポイントID}" > <任意のプラグインタグ名 name = "{プラグイン名}" id = "{プラグインID}" version = "{バージョン}" rank = "{ランク}" target = "{ターゲットプラグインID}" before = "{差込み方向}" enable = "{有効無効フラグ}" >
・・・任意のタグを記述・・・
</任意のプラグインタグ名> ・・・繰り返し別のプラグインを指定可能・・・
</extension>
・・・繰り返し別のextensionタグを指定可能・・・
</plugin><任意のプラグインタグ名>に囲まれた部分が1つのプラグイン設定となります。
拡張ポイントIDはプラグインをグループ化するための任意のIDです。
通常、IDの一意性を保つため、jp.co.intra_mart.plugin.sampleなどのパッケージ名形式で記述することをお勧めします。
【プラグインタグ名の各属性】
属性名 必須 名称 説明 デフォルト name ○プラグイン名 プラグインの名称です。 --- id ○プラグインID 同じ拡張ポイントで一意に識別するプラグインIDです。 --- version --バージョン プラグインのバージョンです。
数値をドットつなぎで指定します。最大4個まで
例 1 / 1.3 / 1.3.12 / 1.3.12.40 etc
同一の拡張ポイントに同じプラグインIDが存在した場合、
バージョン番号がもっとも大きいもの1つが有効になります。
指定しない場合はもっとも小さいものとして扱われます。
--- rank --ランク ランクを指定することで、このランクの小さい順位にプラグインが読み込まれます。
*target属性が指定された場合は、target属性が有効になります。
数値で指定します。
指定しない場合は、ファイルを読み込んだ順序で、逐次最後に追加されます。--- target --ターゲットプラグインID 同一の拡張ポイント内でこのプラグインの読み込み順を操作するために利用します。
このプラグインを差し込むターゲットプラグインIDを指定します。
ターゲットプラグインの前後にこのプラグインを差し込みます。
差込む方向はbefore属性で指定します。
--- before --差込み方向 ターゲットプラグインの手前に差し込むときは、trueを指定します。
*ターゲットプラグインIDが指定された場合有効になります。false enable --有効無効フラグ このプラグインを無効にする場合は、falseを指定します。 true
コンストラクタと説明 |
---|
PluginManager()
プラグインマネージャーを作成します。
|
PluginManager(Locale locale)
プラグインマネージャーを作成します。
|
PluginManager(Locale locale,
String loginGroupCd)
非推奨です。
|
修飾子とタイプ | メソッドと説明 |
---|---|
void |
clear()
非推奨です。
このメソッドは利用すべきではありません。
|
boolean |
containsPoint(String point)
プラグインマネージャーが指定の拡張ポイントを保持する場合に true を取得します。
|
String[] |
getExtensionPoints()
プラグインマネージャーが保持する拡張ポイントの配列を返します。
|
PluginDescriptor |
getPluginDescriptor(String point)
指定されたPointIDのプラグイン定義情報モデルを取得します。
|
PluginDescriptor |
getPluginDescriptor(String point,
String pluginId)
指定されたPointIDの指定したプラグインIDのプラグイン定義情報モデルを取得します。
|
Collection<PluginDescriptor> |
getPluginDescriptors(String point)
指定したポイントに設定されているプラグイン定義情報を配列で取得します。
|
void |
refresh()
プラグイン定義情報を初期化します。
|
public PluginManager()
public PluginManager(Locale locale)
locale
- ロケール情報public PluginManager(Locale locale, String loginGroupCd)
locale
- ロケール情報loginGroupCd
- ログイングループCDAccessSecurityException
NoFilterException
@Deprecated public void clear()
public void refresh()
public boolean containsPoint(String point)
point
- public String[] getExtensionPoints()
public PluginDescriptor getPluginDescriptor(String point)
point
- ターゲットポイントpublic PluginDescriptor getPluginDescriptor(String point, String pluginId)
point
- ターゲットポイントpublic Collection<PluginDescriptor> getPluginDescriptors(String point)
point
- ターゲットポイントCopyright © 2012 NTT DATA INTRAMART CORPORATION