org.apache.taglibs.standard.tag.common.core.RedirectSupport Maven / Gradle / Ivy
The newest version!
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright 1997-2008 Sun Microsystems, Inc. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can obtain
* a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html
* or glassfish/bootstrap/legal/LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at glassfish/bootstrap/legal/LICENSE.txt.
* Sun designates this particular file as subject to the "Classpath" exception
* as provided by Sun in the GPL Version 2 section of the License file that
* accompanied this code. If applicable, add the following below the License
* Header, with the fields enclosed by brackets [] replaced by your own
* identifying information: "Portions Copyrighted [year]
* [name of copyright owner]"
*
* Contributor(s):
*
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*
*
* This file incorporates work covered by the following copyright and
* permission notice:
*
* Copyright 2004 The Apache Software Foundation
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.taglibs.standard.tag.common.core;
import javax.servlet.http.HttpServletResponse;
import javax.servlet.jsp.JspException;
import javax.servlet.jsp.JspTagException;
import javax.servlet.jsp.PageContext;
import javax.servlet.jsp.tagext.BodyTagSupport;
/**
* Support for tag handlers for <redirect>, JSTL 1.0's tag
* for redirecting to a new URL (with optional query parameters).
*
* @author Shawn Bayern
*/
public abstract class RedirectSupport extends BodyTagSupport
implements ParamParent {
//*********************************************************************
// Protected state
protected String url; // 'url' attribute
protected String context; // 'context' attribute
//*********************************************************************
// Private state
private String var; // 'var' attribute
private int scope; // processed 'scope' attr
private ParamSupport.ParamManager params; // added parameters
//*********************************************************************
// Constructor and initialization
public RedirectSupport() {
super();
init();
}
private void init() {
url = var = null;
params = null;
scope = PageContext.PAGE_SCOPE;
}
//*********************************************************************
// Tag attributes known at translation time
public void setVar(String var) {
this.var = var;
}
public void setScope(String scope) {
this.scope = Util.getScope(scope);
}
//*********************************************************************
// Collaboration with subtags
// inherit Javadoc
public void addParameter(String name, String value) {
params.addParameter(name, value);
}
//*********************************************************************
// Tag logic
// resets any parameters that might be sent
public int doStartTag() throws JspException {
params = new ParamSupport.ParamManager();
return EVAL_BODY_BUFFERED;
}
// gets the right value, encodes it, and prints or stores it
public int doEndTag() throws JspException {
String result; // the eventual result
// add (already encoded) parameters
String baseUrl = UrlSupport.resolveUrl(url, context, pageContext);
result = params.aggregateParams(baseUrl);
// if the URL is relative, rewrite it with 'redirect' encoding rules
HttpServletResponse response =
((HttpServletResponse) pageContext.getResponse());
if (!ImportSupport.isAbsoluteUrl(result))
result = response.encodeRedirectURL(result);
// redirect!
try {
response.sendRedirect(result);
} catch (java.io.IOException ex) {
throw new JspTagException(ex.toString(), ex);
}
return SKIP_PAGE;
}
// Releases any resources we may have (or inherit)
public void release() {
init();
}
}