jp.morpho.webapp
インタフェース Plugin

すべてのスーパーインタフェース:
java.io.Serializable
既知のサブインタフェースの一覧:
ActionMappingManager
既知の実装クラスの一覧:
AbstractActionMappingManager, MessageResourceManager, TagManager

public interface Plugin
extends java.io.Serializable

Plugin インタフェースは、各プラグインクラスによって実装されます。

作成者:
Kenichi Fukuda

メソッドの概要
 java.lang.String getPluginKey()
           プラグインを識別するためのキーを返します。
 void pluginActivate()
           pluginActivate メソッドは、インスタンスが活性化状態になるときに呼び出されます。
 void pluginRemove()
           フレームワークでは、プラグインオブジェクトの有効期間を終わらせる前にこのメソッドを呼び出します。
 void setPluginContext(PluginContext fc)
           プラグインコンテキストを設定します。
 

メソッドの詳細

getPluginKey

public java.lang.String getPluginKey()

プラグインを識別するためのキーを返します。 プラグインのキーは、パッケージ名と同じ規則に従う必要があります。 この仕様では、jp.morpho.* に一致する名前を予約しています。

戻り値:
プラグインを識別するためのキー

setPluginContext

public void setPluginContext(PluginContext fc)
                      throws PluginException

プラグインコンテキストを設定します。 フレームワークでは、プラグインインスタンスが追加された時にこのメソッドを呼び出します。

パラメータ:
fc - このインスタンスを追加した FrameworkContext オブジェクト
例外:
PluginException - このメソッドによってスローされ、何らかのエラーが原因で障害が発生したことを示す

pluginActivate

public void pluginActivate()
                    throws PluginException

pluginActivate メソッドは、インスタンスが活性化状態になるときに呼び出されます。 この処理でインスタンスを初期化する必要があります。

例外:
PluginException - このメソッドによってスローされ、何らかのエラーが原因で障害が発生したことを示す

pluginRemove

public void pluginRemove()
                  throws PluginException

フレームワークでは、プラグインオブジェクトの有効期間を終わらせる前にこのメソッドを呼び出します。 この処理ですべてのリソースを解放する必要があります。

例外:
PluginException - このメソッドによってスローされ、何らかのエラーが原因で障害が発生したことを示す