/* ====================================================================
* The Apache Software License, Version 1.1
*
* Copyright (c) 2000-2003 The Apache Software Foundation. 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. The end-user documentation included with the redistribution,
* if any, must include the following acknowledgment:
* "This product includes software developed by the
* Apache Software Foundation (http://apache.org/)."
* Alternately, this acknowledgment may appear in the software itself,
* if and wherever such third-party acknowledgments normally appear.
*
* 4. The names "Apache" and "Apache Software Foundation", "Tapestry"
* must not be used to endorse or promote products derived from this
* software without prior written permission. For written
* permission, please contact apache@apache.org.
*
* 5. Products derived from this software may not be called "Apache"
* or "Tapestry", nor may "Apache" or "Tapestry" appear in their
* name, without prior written permission of the Apache Software Foundation.
*
* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED 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 TAPESTRY CONTRIBUTOR COMMUNITY
* 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.
* ====================================================================
*
* This software consists of voluntary contributions made by many
* individuals on behalf of the Apache Software Foundation. For more
* information on the Apache Software Foundation, please see
* <http://www.apache.org/>.
*
*/
package org.apache.tapestry.engine;
import java.io.IOException;
import javax.servlet.ServletException;
import javax.servlet.http.HttpSession;
import org.apache.tapestry.ApplicationRuntimeException;
import org.apache.tapestry.IAction;
import org.apache.tapestry.IComponent;
import org.apache.tapestry.IPage;
import org.apache.tapestry.IRequestCycle;
import org.apache.tapestry.StaleSessionException;
import org.apache.tapestry.Tapestry;
import org.apache.tapestry.request.ResponseOutputStream;
/**
* A context-sensitive service related to {@link org.apache.tapestry.form.Form}
* and {@link org.apache.tapestry.link.ActionLink}. Encodes
* the page, component and an action id in the service context.
*
* @author Howard Lewis Ship
* @version $Id: ActionService.java,v 1.7 2003/05/28 13:41:39 hlship Exp $
* @since 1.0.9
*
**/
public class ActionService extends AbstractService
{
/**
* Encoded into URL if engine was stateful.
*
* @since 3.0
**/
private static final String STATEFUL_ON = "1";
/**
* Encoded into URL if engine was not stateful.
*
* @since 3.0
**/
private static final String STATEFUL_OFF = "0";
public ILink getLink(IRequestCycle cycle, IComponent component, Object[] parameters)
{
if (parameters == null || parameters.length != 1)
throw new IllegalArgumentException(
Tapestry.format("service-single-parameter", Tapestry.ACTION_SERVICE));
String stateful = cycle.getEngine().isStateful() ? STATEFUL_ON : STATEFUL_OFF;
IPage componentPage = component.getPage();
IPage responsePage = cycle.getPage();
boolean complex = (componentPage != responsePage);
String[] serviceContext = new String[complex ? 5 : 4];
int i = 0;
serviceContext[i++] = stateful;
serviceContext[i++] = responsePage.getPageName();
serviceContext[i++] = (String) parameters[0];
// Because of Block/InsertBlock, the component may not be on
// the same page as the response page and we need to make
// allowances for this.
if (complex)
serviceContext[i++] = componentPage.getPageName();
serviceContext[i++] = component.getIdPath();
return constructLink(cycle, Tapestry.ACTION_SERVICE, serviceContext, null, true);
}
public void service(
IEngineServiceView engine,
IRequestCycle cycle,
ResponseOutputStream output)
throws ServletException, IOException
{
IAction action = null;
String componentPageName;
int count = 0;
String[] serviceContext = getServiceContext(cycle.getRequestContext());
if (serviceContext != null)
count = serviceContext.length;
if (count != 4 && count != 5)
throw new ApplicationRuntimeException(
Tapestry.getMessage("ActionService.context-parameters"));
boolean complex = count == 5;
int i = 0;
String stateful = serviceContext[i++];
String pageName = serviceContext[i++];
String targetActionId = serviceContext[i++];
if (complex)
componentPageName = serviceContext[i++];
else
componentPageName = pageName;
String targetIdPath = serviceContext[i++];
IPage page = cycle.getPage(pageName);
// Setup the page for the rewind, then do the rewind.
cycle.activate(page);
IPage componentPage = cycle.getPage(componentPageName);
IComponent component = componentPage.getNestedComponent(targetIdPath);
try
{
action = (IAction) component;
}
catch (ClassCastException ex)
{
throw new ApplicationRuntimeException(
Tapestry.format("ActionService.component-wrong-type", component.getExtendedId()),
component,
null,
ex);
}
// Only perform the stateful check if the application was stateful
// when the URL was rendered.
if (stateful.equals(STATEFUL_ON) && action.getRequiresSession())
{
HttpSession session = cycle.getRequestContext().getSession();
if (session == null || session.isNew())
throw new StaleSessionException();
}
cycle.rewindPage(targetActionId, action);
// During the rewind, a component may change the page. This will take
// effect during the second render, which renders the HTML response.
// Render the response.
engine.renderResponse(cycle, output);
}
public String getName()
{
return Tapestry.ACTION_SERVICE;
}
}