/*
 * 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.impl;

import java.io.Serializable;

import javax.servlet.RequestDispatcher;

import jp.morpho.webapp.action.ActionHandler;
import jp.morpho.webapp.action.ActionHandlerChain;
import jp.morpho.webapp.action.ActionHandlerException;
import jp.morpho.webapp.action.ActionMappingManager;
import jp.morpho.webapp.action.ActionMappingNotFoundException;
import jp.morpho.webapp.servlet.ServletContextAttributeNames;
import jp.morpho.webapp.servlet.http.HttpActionRequest;
import jp.morpho.webapp.servlet.http.HttpActionResponse;

/**
 * <P>
 * ActionMappingManager の実装です。
 * ActionMappingManagerImpl が返すアクションハンドラチェインで、ActionHandlerChain の基本動作を実装します。
 * </P>
 * <P>
 * 新たに ActionMappingManager を実装する場合は、ActionHandlerChain インタフェースの実装としてこのクラスを使用するか、または 新たに ActionHandlerChain インタフェースを実装して必要なメソッドを定義します。
 * </P>
 * @author Kumiko Hiroi
 */
public class ActionHandlerChainImpl
	implements ActionHandlerChain, Serializable
{

	/** アクションハンドラの配列 */
	private ActionHandler[] actionHandlers = null;

	/** アクションマッピングマネージャ */
	private ActionMappingManager amm = null;

	/** 要求を受け取ったサーブレットのパス */
	private String servletPath = null;

	/** 次に実行されるアクションハンドラのインデックス */
	private int actionHandlerIndex = 0;

	private boolean actionViewCanceled = false;

	/**
	 * <P>
	 * FrameworkContextAdapter を作成します。
	 * </P>
	 * @param amm アクションマッピングマネージャ
	 * @param servletPath 要求を受け取ったサーブレットのパス
	 * @param status 要求を処理するステータスの値
	 * @param action 要求を処理するアクションの値
	 */
	public ActionHandlerChainImpl(ActionMappingManager amm, String servletPath, String status, String action)
	{
		super();
		try
		{
			this.amm = amm;
			this.servletPath = servletPath;
			actionHandlers = amm.getActionHandlers(servletPath, status, action);
		}
		catch (ActionMappingNotFoundException e)
		{
		}
	}

	/**
	 * <P>
	 * チェーン内の次のアクションハンドラを呼び出します。
	 * 呼び出し中のアクションハンドラがチェーン内の最後のアクションハンドラである場合は、アクションビューを応答にインクルードします。
	 * </P>
	 * @param request チェーンに沿って渡す要求
	 * @param response チェーンに沿って渡す応答
	 * @exception ActionHandlerException アクションハンドラの通常の処理を妨げる例外が発生した場合
	 * @see jp.morpho.webapp.action.ActionHandlerChain#doActionHandler(HttpActionRequest, HttpActionResponse)
	 */
	public synchronized void doActionHandler(
		HttpActionRequest request,
		HttpActionResponse response)
		throws ActionHandlerException
	{
		//次のアクションハンドラがある場合
		if (actionHandlerIndex < actionHandlers.length)
		{
			//次に実行するアクションハンドラを取得します
			ActionHandler next = actionHandlers[actionHandlerIndex];

			//次に実行されるアクションハンドラのインデックスを更新します
			actionHandlerIndex++;

			//アクションハンドラを実行します
			next.doActionHandler(request, response, this);
		}
		else if (!actionViewCanceled)
		{
			try
			{
				//文字エンコーディングを設定します
				response.setContentType("text/html; charset=" + request.getSession().getServletContext().getAttribute(ServletContextAttributeNames.characterEncoding));

				//すべてのアクションハンドラが実行された場合、応答にアクションビューをインクルードします
				RequestDispatcher rd = request.getRequestDispatcher(amm.getActionView(servletPath, request.getStatus()));
				rd.include(request, response);
			}
			catch (Exception e)
			{
				throw new ActionHandlerException(e);
			}
		}
	}

	/**
	 * @see jp.morpho.webapp.action.ActionHandlerChain#cancelActionHandlers()
	 */
	public synchronized void cancelActionHandlers()
	{
		actionHandlerIndex = actionHandlers.length;
	}

	/**
	 * @see jp.morpho.webapp.action.ActionHandlerChain#cancelActionView()
	 */
	public synchronized void cancelActionView()
	{
		actionViewCanceled = true;
	}

	/**
	 * @see jp.morpho.webapp.action.ActionHandlerChain#skipActionHandlers(int)
	 */
	public synchronized void skipActionHandlers(int skip)
	{
		if (skip < 1)
		{
			throw new IllegalArgumentException("" + skip);
		}
		if (actionHandlers.length <= actionHandlerIndex + skip)
		{
			throw new IndexOutOfBoundsException("" + (actionHandlerIndex + skip));
		}
		actionHandlerIndex += skip;
	}

}
