/*
 * Copyright (c) 2003, Morpho Project.
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice,
 *    this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright notice,
 *    this list of conditions and the following disclaimer in the documentation
 *    and/or other materials provided with the distribution.
 * 3. Neither the name of the Morpho Project nor the names of its contributors
 *    may be used to endorse or promote products derived from this software
 *    without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */
package jp.morpho.webapp.action;

import jp.morpho.webapp.PluginContext;
import jp.morpho.webapp.PluginException;
import jp.morpho.webapp.PluginKeys;

/**
 * <P>
 * このクラスは、ActionMappingManager インタフェースのスケルトン実装を提供し、このインタフェースを実装するのに必要な作業量を最小限に抑えます。
 * アクションマッピングマネージャを実装するには、このクラスを拡張して、いくつかのメソッドを実装する必要があります。
 * ActionMappingManager インタフェースの仕様で推奨されているように、通常は、引数なしの void コンストラクタを提供してください。
 * </P>
 * @author Kenichi Fukuda
 */
public abstract class AbstractActionMappingManager
	implements ActionMappingManager
{

	/**
	 * <P>
	 * 要求を処理するステータスのパラメータの名前を返します。
	 * </P>
	 * @return 要求を処理するステータスのパラメータの名前
	 * @see jp.morpho.webapp.action.ActionMappingManager#getStatusParameterName()
	 */
	public abstract String getStatusParameterName();

	/**
	 * <P>
	 * 要求を処理するアクションのパラメータの名前を返します。
	 * </P>
	 * @return 要求を処理するアクションのパラメータの名前
	 * @see jp.morpho.webapp.action.ActionMappingManager#getActionParameterName()
	 */
	public abstract String getActionParameterName();

	/**
	 * <P>
	 * アクションハンドラチェインを返します。
	 * アクションハンドラチェインは、ActionMappingManager の getActionHandlers(String, String, String) メソッドと getActionView(String, String) メソッドを呼び出します。
	 * </P>
	 * @param servletPath アクションマッピングが対応する URL
	 * @param status 要求を処理するステータスの値
	 * @param action 要求を処理するアクションの値
	 * @return アクションハンドラチェイン
	 * @see jp.morpho.webapp.action.ActionMappingManager#getActionHandlerChain(String, String, String)
	 */
	public abstract ActionHandlerChain getActionHandlerChain(
		String servletPath,
		String status,
		String action);

	/**
	 * <P>
	 * アクションハンドラの配列を返します。
	 * 返されたアクションハンドラの配列は、アクションハンドラチェインの doActionHandler メソッドで順に呼び出されます。
	 * </P>
	 * <P>
	 * このメソッドは、要求を処理するアクションハンドラを取得するために、アクションハンドラチェインから呼び出されます。
	 * </P>
	 * @param servletPath アクションマッピングが対応する URL
	 * @param status 要求を処理するステータスの値
	 * @param action 要求を処理するアクションの値
	 * @return アクションハンドラの配列
	 * @see jp.morpho.webapp.action.ActionMappingManager#getActionHandlers(String, String, String)
	 */
	public abstract ActionHandler[] getActionHandlers(
		String servletPath,
		String status,
		String action)
		throws ActionMappingNotFoundException;

	/**
	 * <P>
	 * アクションビューのパス (JSP など) を返します。
	 * アクションビューは、アクションハンドラチェインの doActionHandler メソッドで、アクションハンドラが呼び出された後、応答にインクルードされます。
	 * </P>
	 * <P>
	 * ステータスの値は、アクションハンドラで変更されることがあるため、サーブレットが要求を受け取った時の値と必ずしも一致しません。
	 * このメソッドは、アクションハンドラチェインの doActionHandler メソッドで、すべてのアクションハンドラが実行された後に呼び出されます。
	 * </P>
	 * @param servletPath アクションマッピングが対応する URL
	 * @param status 要求を処理するステータスの値
	 * @return アクションビューのパス
	 * @see jp.morpho.webapp.action.ActionMappingManager#getActionView(String, String)
	 */
	public abstract String getActionView(String servletPath, String status)
		throws ActionMappingNotFoundException;

	/**
	 * <P>
	 * プラグインを識別するためのキーを返します。
	 * プラグインのキーは、パッケージ名と同じ規則に従う必要があります。
	 * この仕様では、jp.morpho.* に一致する名前を予約しています。
	 * </P>
	 * @return プラグインを識別するためのキー
	 * @see jp.morpho.webapp.Plugin#getPluginKey()
	 */
	public final String getPluginKey()
	{
		return PluginKeys.actionMappingManager;
	}

	/**
	 * <P>
	 * プラグインコンテキストを設定します。
	 * フレームワークでは、プラグインインスタンスが追加された時にこのメソッドを呼び出します。
	 * </P>
	 * @param fc このインスタンスを追加した FrameworkContext オブジェクト
	 * @exception PluginException このメソッドによってスローされ、何らかのエラーが原因で障害が発生したことを示す
	 */
	public void setPluginContext(PluginContext fc)
		throws PluginException
	{
	}

	/**
	 * <P>
	 * pluginActivate メソッドは、インスタンスが活性化状態になるときに呼び出されます。
	 * インスタンスを初期化します。
	 * </P>
	 * @exception PluginException このメソッドによってスローされ、何らかのエラーが原因で障害が発生したことを示す
	 */
	public void pluginActivate()
		throws PluginException
	{
	}

	/**
	 * <P>
	 * フレームワークでは、プラグインオブジェクトの有効期間を終わらせる前にこのメソッドを呼び出します。
	 * すべてのリソースを解放します。
	 * </P>
	 * @exception PluginException このメソッドによってスローされ、何らかのエラーが原因で障害が発生したことを示す
	 */
	public void pluginRemove()
		throws PluginException
	{
	}

}
