|
||||||||||
前のクラス 次のクラス | フレームあり フレームなし | |||||||||
概要: 入れ子 | フィールド | コンストラクタ | メソッド | 詳細: フィールド | コンストラクタ | メソッド |
public interface Plugin
プラグインを表すインターフェイスです。
プラグインは所属する Web アプリケーションのサーブレットに対する変更の通知を受け取ることができます。
メソッドの概要 | ||
---|---|---|
void |
destroy()
このプラグインを破棄します。 |
|
|
getProvider(Class<S> service)
このプラグインが提供するサービスプロバイダを取得します。 |
|
Set<Class<? extends Provider>> |
getSupportedServices()
このプラグインが提供するサービスプロバイダのセットを返します。 |
|
void |
initialize(ServletContext servletContext)
このプラグインを初期化します。 |
|
ActionResult |
invokeAction(ActionInvocation invocation)
アクションメソッドを実行します。 |
|
void |
invokeActionResult(ActionResultInvocation invocation)
アクションの実行結果を実行します。 |
|
void |
invokeRequestProcessing(RequestProcessingInvocation invocation)
要求に対する処理を実行します。 |
|
PathInfo |
invokeRouting(RoutingInvocation invocation)
ルーティングを実行して要求されたパスの情報を取得します。 |
|
ActionResult |
invokeValidation(ValidationInvocation invocation)
入力検証を実行します。 |
|
void |
ready()
このプラグインを準備します。 |
メソッドの詳細 |
---|
void initialize(ServletContext servletContext) throws Exception
CubbyFilter
がサービスを提供できるようになった時に実行されます。
servletContext
- 呼び出し元が現在実行している ServletContext
への参照
Exception
- プラグインの初期化に失敗した場合Filter.init(javax.servlet.FilterConfig)
<S extends Provider> S getProvider(Class<S> service)
このプラグインが指定されたサービスを提供しない場合は null
を返します。
S
- サービスの型service
- サービス
Set<Class<? extends Provider>> getSupportedServices()
void ready() throws Exception
プラグインの準備が完了した時に実行されます。
Exception
- プラグインの準備に失敗した場合void destroy()
CubbyFilter
がサービスの提供を停止するときに実行されます。
Filter.destroy()
PathInfo invokeRouting(RoutingInvocation invocation) throws Exception
このメソッドをオーバーライドすることで、ルーティングの実行をインターセプトすることができます。
このメソッド内で Invocation.proceed()
メソッドを実行することで、別のプラグインの
invokeRouting(RoutingInvocation)
またはルーティングが実行されます。
invocation
- ルーティングの実行情報
Exception
- ルーティングの実行時に例外が発生した場合void invokeRequestProcessing(RequestProcessingInvocation invocation) throws Exception
このメソッドをオーバーライドすることで、要求に対する処理の実行をインターセプトすることができます。
このメソッド内で Invocation.proceed()
メソッドを実行することで、別のプラグインの
invokeRequestProcessing(RequestProcessingInvocation)
または要求に対する処理が実行されます。
invocation
- 要求に対する処理の実行情報
Exception
- 要求に対する処理の実行時に例外が発生した場合ActionResult invokeAction(ActionInvocation invocation) throws Exception
このメソッドをオーバーライドすることで、アクションメソッドの実行をインターセプトすることができます。
このメソッド内で Invocation.proceed()
メソッドを実行することで、別のプラグインの
invokeAction(ActionInvocation)
またはアクションメソッドが実行されます。
invocation
- アクションメソッドの実行情報
Exception
- アクションメソッドの実行時に例外が発生した場合ActionResult invokeValidation(ValidationInvocation invocation) throws Exception
このメソッドをオーバーライドすることで、入力検証の実行をインターセプトすることができます。
このメソッド内で Invocation.proceed()
メソッドを実行することで、別のプラグインの
invokeValidation(ValidationInvocation)
または入力検証が実行されます。
invocation
- 入力検証の実行情報
Exception
- 入力検証の実行時に例外が発生した場合void invokeActionResult(ActionResultInvocation invocation) throws Exception
このメソッドをオーバーライドすることで、アクションの実行結果の実行をインターセプトすることができます。
このメソッド内で Invocation.proceed()
メソッドを実行することで、別のプラグインの
invokeActionResult(ActionResultInvocation)
またはアクションの実行結果が実行されます。
invocation
- アクションの実行結果の実行情報
Exception
- アクションの実行結果の実行時に例外が発生した場合
|
||||||||||
前のクラス 次のクラス | フレームあり フレームなし | |||||||||
概要: 入れ子 | フィールド | コンストラクタ | メソッド | 詳細: フィールド | コンストラクタ | メソッド |