org.seasar.cubby.plugin
インタフェース Plugin

既知の実装クラスの一覧:
AbstractPlugin, BinderPlugin

public interface Plugin

プラグインを表すインターフェイスです。

プラグインは所属する Web アプリケーションのサーブレットに対する変更の通知を受け取ることができます。

作成者:
baba

メソッドの概要
 void destroy()
          このプラグインを破棄します。
<S extends Provider>
S
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()
          このプラグインを準備します。
 

メソッドの詳細

initialize

void initialize(ServletContext servletContext)
                throws Exception
このプラグインを初期化します。

CubbyFilter がサービスを提供できるようになった時に実行されます。

パラメータ:
servletContext - 呼び出し元が現在実行している ServletContext への参照
例外:
Exception - プラグインの初期化に失敗した場合
関連項目:
Filter.init(javax.servlet.FilterConfig)

getProvider

<S extends Provider> S getProvider(Class<S> service)
このプラグインが提供するサービスプロバイダを取得します。

このプラグインが指定されたサービスを提供しない場合は null を返します。

型パラメータ:
S - サービスの型
パラメータ:
service - サービス
戻り値:
サービスプロバイダ

getSupportedServices

Set<Class<? extends Provider>> getSupportedServices()
このプラグインが提供するサービスプロバイダのセットを返します。

戻り値:
このプラグインが提供するサービスプロバイダのセット

ready

void ready()
           throws Exception
このプラグインを準備します。

プラグインの準備が完了した時に実行されます。

例外:
Exception - プラグインの準備に失敗した場合

destroy

void destroy()
このプラグインを破棄します。

CubbyFilter がサービスの提供を停止するときに実行されます。

関連項目:
Filter.destroy()

invokeRouting

PathInfo invokeRouting(RoutingInvocation invocation)
                       throws Exception
ルーティングを実行して要求されたパスの情報を取得します。

このメソッドをオーバーライドすることで、ルーティングの実行をインターセプトすることができます。

このメソッド内で Invocation.proceed() メソッドを実行することで、別のプラグインの invokeRouting(RoutingInvocation) またはルーティングが実行されます。

パラメータ:
invocation - ルーティングの実行情報
例外:
Exception - ルーティングの実行時に例外が発生した場合

invokeRequestProcessing

void invokeRequestProcessing(RequestProcessingInvocation invocation)
                             throws Exception
要求に対する処理を実行します。

このメソッドをオーバーライドすることで、要求に対する処理の実行をインターセプトすることができます。

このメソッド内で Invocation.proceed() メソッドを実行することで、別のプラグインの invokeRequestProcessing(RequestProcessingInvocation) または要求に対する処理が実行されます。

パラメータ:
invocation - 要求に対する処理の実行情報
例外:
Exception - 要求に対する処理の実行時に例外が発生した場合

invokeAction

ActionResult invokeAction(ActionInvocation invocation)
                          throws Exception
アクションメソッドを実行します。

このメソッドをオーバーライドすることで、アクションメソッドの実行をインターセプトすることができます。

このメソッド内で Invocation.proceed() メソッドを実行することで、別のプラグインの invokeAction(ActionInvocation) またはアクションメソッドが実行されます。

パラメータ:
invocation - アクションメソッドの実行情報
戻り値:
アクションの実行結果
例外:
Exception - アクションメソッドの実行時に例外が発生した場合

invokeValidation

ActionResult invokeValidation(ValidationInvocation invocation)
                              throws Exception
入力検証を実行します。

このメソッドをオーバーライドすることで、入力検証の実行をインターセプトすることができます。

このメソッド内で Invocation.proceed() メソッドを実行することで、別のプラグインの invokeValidation(ValidationInvocation) または入力検証が実行されます。

パラメータ:
invocation - 入力検証の実行情報
戻り値:
入力検証の実行結果
例外:
Exception - 入力検証の実行時に例外が発生した場合
導入されたバージョン:
2.0.9

invokeActionResult

void invokeActionResult(ActionResultInvocation invocation)
                        throws Exception
アクションの実行結果を実行します。

このメソッドをオーバーライドすることで、アクションの実行結果の実行をインターセプトすることができます。

このメソッド内で Invocation.proceed() メソッドを実行することで、別のプラグインの invokeActionResult(ActionResultInvocation) またはアクションの実行結果が実行されます。

パラメータ:
invocation - アクションの実行結果の実行情報
例外:
Exception - アクションの実行結果の実行時に例外が発生した場合


Copyright © 2006-2010 The Seasar Foundation. All Rights Reserved.