| /* |
| * ==================================================================== |
| * The Apache Software License, Version 1.1 |
| * |
| * Copyright (c) 2002 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://www.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" and |
| * "Apache 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", |
| * "Apache Tapestry", nor may "Apache" 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 APACHE SOFTWARE FOUNDATION OR |
| * ITS 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. |
| * ==================================================================== |
| * |
| * 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 net.sf.tapestry; |
| |
| import java.net.URLEncoder; |
| import java.util.ArrayList; |
| import java.util.List; |
| |
| /** |
| * A Gesture represents a possible action within the client web browser; |
| * either clicking a link or submitting a form. A full URL for the Gesture |
| * can be generated, or the query parameters for the Gesture can be extracted |
| * (seperately from the servlet path). The latter case is used when submitting |
| * forms. |
| * |
| * <p>Note: This class was changed signficantly in a non-backwards compatible |
| * way in release 2.2. |
| * |
| * @author Howard Lewis Ship |
| * @version $Id$ |
| * @since 1.0.3 |
| * |
| **/ |
| |
| public class Gesture |
| { |
| private static final int DEFAULT_HTTP_PORT = 80; |
| |
| private IRequestCycle _cycle; |
| private String _serviceName; |
| private String _serviceContext; |
| private String[] _serviceParameters; |
| private boolean _stateful; |
| |
| /** |
| * Creates a new Gesture. A Gesture always names a service to be activated |
| * by the Gesture, has an optional list of service context strings, |
| * an optional list of service parameter strings and may be stateful |
| * or stateless. |
| * |
| * <p>ServiceLink parameter strings may contain any characters. |
| * |
| * <p>ServiceLink context strings must be URL safe, and may not contain |
| * slash ('/') characters. Typically, only letters, numbers and simple |
| * punctuation ('.', '-', '_') is recommended (no checks are currently made, |
| * however). Context strings are generally built from page names |
| * and component ids, which are limited to safe characters. |
| * |
| * @param cycle The {@link IRequestCycle} the Gesture is to be created for. |
| * @param serviceName The name of the service to be invoked by the Gesture. |
| * @param serviceContext an optional array of strings to be provided |
| * to the service to provide a context for executing the service. May be null |
| * or empty. <b>Note: copied, not retained.</b> |
| * @param serviceParameters An array of parameters, may be |
| * null or empty. <b>Note: retained, not copied.</b> |
| * @param stateful if true, the service which generated the Gesture |
| * is stateful and expects that the final URL will be passed through |
| * {@link IRequestCycle#encodeURL(String)}. |
| **/ |
| |
| public Gesture( |
| IRequestCycle cycle, |
| String serviceName, |
| String[] serviceContext, |
| String[] serviceParameters, |
| boolean stateful) |
| { |
| _cycle = cycle; |
| _serviceName = serviceName; |
| _serviceContext = constructContext(serviceContext); |
| _serviceParameters = serviceParameters; |
| _stateful = stateful; |
| } |
| |
| private String constructContext(String[] serviceContext) |
| { |
| int count = Tapestry.size(serviceContext); |
| |
| if (count == 0) |
| return null; |
| |
| StringBuffer buffer = new StringBuffer(); |
| |
| for (int i = 0; i < count; i++) |
| { |
| if (i > 0) |
| buffer.append('/'); |
| |
| buffer.append(serviceContext[i]); |
| } |
| |
| return buffer.toString(); |
| } |
| |
| /** |
| * Returns the URI for the Gesture, exclusing any service parameters. |
| * This is used (for example) by {@link net.sf.tapestry.form.Form} which encodes |
| * the service parameters as hidden form fields. The URL is encoded |
| * if the service is stateful. |
| * |
| * @since 2.2 |
| * |
| **/ |
| |
| public String getBareURL() |
| { |
| return constructURL(new StringBuffer(), false); |
| } |
| |
| /** |
| * Something of a misnomer; returns the URI, relative to the server's root. |
| * If the Gesture is stateful, then the URI is filtered |
| * through {@link IRequestCycle#encodeURL(String)}. |
| * |
| **/ |
| |
| public String getURL() |
| { |
| return constructURL(new StringBuffer(), true); |
| } |
| |
| /** |
| * Constructs an absolute URL, including scheme, server and port. |
| * This is often useful when the URL will be included in a client-side script. |
| * |
| **/ |
| |
| public String getAbsoluteURL() |
| { |
| return getAbsoluteURL(null, null, 0); |
| } |
| |
| /** |
| * Generates a complete URL. |
| * @param scheme if non-null, used as the scheme (instead of the scheme defined by the cycle) |
| * @param server if non-null, used as the server (instead of the server defined by the cycle) |
| * @param port if non-zero, used as the port (instead of the port defined by the cycle) |
| * |
| **/ |
| |
| public String getAbsoluteURL(String scheme, String server, int port) |
| { |
| StringBuffer buffer = new StringBuffer(); |
| RequestContext context = _cycle.getRequestContext(); |
| |
| if (scheme == null) |
| scheme = context.getScheme(); |
| |
| buffer.append(scheme); |
| buffer.append("://"); |
| |
| if (server == null) |
| server = context.getServerName(); |
| |
| buffer.append(server); |
| |
| if (port == 0) |
| port = context.getServerPort(); |
| |
| if (!(scheme.equals("http") && port == DEFAULT_HTTP_PORT)) |
| { |
| buffer.append(':'); |
| buffer.append(port); |
| } |
| |
| // Add the servlet path and the rest of the URL & query parameters. |
| // The servlet path starts with a leading slash. |
| |
| return constructURL(buffer, true); |
| } |
| |
| private String constructURL(StringBuffer buffer, boolean includeParameters) |
| { |
| buffer.append(_cycle.getEngine().getServletPath()); |
| |
| if (includeParameters) |
| { |
| buffer.append('?'); |
| buffer.append(IEngineService.SERVICE_QUERY_PARAMETER_NAME); |
| buffer.append('='); |
| buffer.append(_serviceName); |
| |
| if (_serviceContext != null) |
| { |
| buffer.append('&'); |
| buffer.append(IEngineService.CONTEXT_QUERY_PARMETER_NAME); |
| buffer.append('='); |
| buffer.append(_serviceContext); |
| } |
| |
| int count = Tapestry.size(_serviceParameters); |
| |
| for (int i = 0; i < count; i++) |
| { |
| buffer.append('&'); |
| |
| buffer.append(IEngineService.PARAMETERS_QUERY_PARAMETER_NAME); |
| buffer.append('='); |
| |
| try |
| { |
| // We use the older, deprecated version of this method, which is compatible |
| // with the JDK 1.2.2. |
| |
| String encoded = URLEncoder.encode(_serviceParameters[i]); |
| |
| buffer.append(encoded); |
| } |
| catch (Exception ex) |
| { |
| // JDK1.2.2 claims this throws Exception. It doesn't |
| // and we ignore it. |
| } |
| } |
| } |
| |
| String result = buffer.toString(); |
| |
| if (_stateful) |
| result = _cycle.encodeURL(result); |
| |
| return result; |
| } |
| |
| /** |
| * Returns the names of any parameters that should be encoded |
| * into a <form>. This is used by the |
| * {@link net.sf.tapestry.form.Form} component. |
| * |
| * @see #getParameterValues(String) |
| * |
| * @since 2.2 |
| * |
| **/ |
| |
| public String[] getParameterNames() |
| { |
| List list = new ArrayList(); |
| |
| list.add(IEngineService.SERVICE_QUERY_PARAMETER_NAME); |
| |
| if (_serviceContext != null) |
| list.add(IEngineService.CONTEXT_QUERY_PARMETER_NAME); |
| |
| if (Tapestry.size(_serviceParameters) != 0) |
| list.add(IEngineService.PARAMETERS_QUERY_PARAMETER_NAME); |
| |
| return (String[]) list.toArray(new String[list.size()]); |
| } |
| |
| /** |
| * Returns an array of strings to be encoded into the <form> |
| * (as hidden form elements). |
| * |
| * @see #getParameterNames() |
| * @since 2.2 |
| * |
| **/ |
| |
| public String[] getParameterValues(String name) |
| { |
| if (name.equals(IEngineService.SERVICE_QUERY_PARAMETER_NAME)) |
| { |
| return new String[] { _serviceName }; |
| } |
| |
| if (name.equals(IEngineService.CONTEXT_QUERY_PARMETER_NAME)) |
| { |
| return new String[] { _serviceContext }; |
| } |
| |
| if (name.equals(IEngineService.PARAMETERS_QUERY_PARAMETER_NAME)) |
| { |
| return _serviceParameters; |
| } |
| |
| throw new IllegalArgumentException(Tapestry.getString("Gesture.unknown-parameter-name", name)); |
| |
| } |
| |
| public String toString() |
| { |
| StringBuffer buffer = new StringBuffer("Gesture["); |
| |
| buffer.append(getBareURL()); |
| buffer.append(' '); |
| |
| int count = Tapestry.size(_serviceParameters); |
| |
| for (int i = 0; i < count; i++) |
| { |
| if (i == 0) |
| buffer.append(" parameters="); |
| else |
| buffer.append(','); |
| |
| buffer.append(_serviceParameters[i]); |
| } |
| |
| if (_stateful) |
| buffer.append(" (stateful)"); |
| |
| buffer.append(']'); |
| |
| return buffer.toString(); |
| } |
| |
| } |
