概要 | パッケージ | クラス | 使用 | 階層ツリー | 非推奨 API | 索引 | ヘルプ
前のクラス 次のクラス | フレームあり フレームなし
概要: 入れ子 | フィールド | コンストラクタ | メソッド | 詳細: フィールド | コンストラクタ | メソッド

## org.seasar.cubby.plugin
クラス AbstractPlugin

    java.lang.Object
      org.seasar.cubby.plugin.AbstractPlugin

すべての実装されたインタフェース:
  Plugin

直系の既知のサブクラス:
  BinderPlugin, ValidationPlugin

    public abstract class AbstractPlugin

extends Object
implements Plugin

プラグインの抽象的な実装です。

作成者:
  baba

コンストラクタの概要
`AbstractPlugin()`

メソッドの概要
`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)` 要求に対する処理を実行します。
`protected boolean` | `isSupport(Class<? extends Provider> service)` このプラグインが指定されたサービスをサポートするかを示します。
`void` | `ready()` このプラグインを準備します。
`protected void` | `support(Class<? extends Provider> service)` プラグインがサポートするサービスを追加します。

クラス java.lang.Object から継承されたメソッド
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

コンストラクタの詳細

### AbstractPlugin

    public AbstractPlugin()

メソッドの詳細

### support

    protected void support(Class<? extends Provider> service)

  プラグインがサポートするサービスを追加します。

  パラメータ:
    `service` - サービス

### isSupport

    protected boolean isSupport(Class<? extends Provider> service)

  このプラグインが指定されたサービスをサポートするかを示します。

  パラメータ:
    `service` - サービス
  戻り値:
    このプラグインが指定されたサービスをサポートする場合は `true`、そうでない場合は `false`

### initialize

    public void initialize(ServletContext servletContext)
                    throws Exception

  このプラグインを初期化します。

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

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

### getSupportedServices

    public Set<Class<? extends Provider>> getSupportedServices()

  このプラグインが提供するサービスプロバイダのセットを返します。

  定義:
    インタフェース `Plugin` 内の `getSupportedServices`
  戻り値:
    このプラグインが提供するサービスプロバイダのセット

### getProvider

    public <S extends Provider> S getProvider(Class<S> service)

  このプラグインが提供するサービスプロバイダを取得します。

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

  定義:
    インタフェース `Plugin` 内の `getProvider`
  型パラメータ:
    `S` - サービスの型
  パラメータ:
    `service` - サービス
  戻り値:
    サービスプロバイダ

### ready

    public void ready()
               throws Exception

  このプラグインを準備します。

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

  定義:
    インタフェース `Plugin` 内の `ready`
  例外:
    `Exception` - プラグインの準備に失敗した場合

### destroy

    public void destroy()

  このプラグインを破棄します。

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

  定義:
    インタフェース `Plugin` 内の `destroy`
  関連項目:
    `Filter.destroy()`

### invokeRequestProcessing

    public void invokeRequestProcessing(RequestProcessingInvocation invocation)
                                 throws Exception

  要求に対する処理を実行します。

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

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

  定義:
    インタフェース `Plugin` 内の `invokeRequestProcessing`
  パラメータ:
    `invocation` - 要求に対する処理の実行情報
  例外:
    `Exception` - 要求に対する処理の実行時に例外が発生した場合

### invokeAction

    public ActionResult invokeAction(ActionInvocation invocation)
                              throws Exception

  アクションメソッドを実行します。

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

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

  定義:
    インタフェース `Plugin` 内の `invokeAction`
  パラメータ:
    `invocation` - アクションメソッドの実行情報
  戻り値:
    アクションの実行結果
  例外:
    `Exception` - アクションメソッドの実行時に例外が発生した場合

### invokeActionResult

    public void invokeActionResult(ActionResultInvocation invocation)
                            throws Exception

  アクションの実行結果を実行します。

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

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

  定義:
    インタフェース `Plugin` 内の `invokeActionResult`
  パラメータ:
    `invocation` - アクションの実行結果の実行情報
  例外:
    `Exception` - アクションの実行結果の実行時に例外が発生した場合

概要 | パッケージ | クラス | 使用 | 階層ツリー | 非推奨 API | 索引 | ヘルプ
前のクラス 次のクラス | フレームあり フレームなし
概要: 入れ子 | フィールド | コンストラクタ | メソッド | 詳細: フィールド | コンストラクタ | メソッド

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