package org.apache.jetspeed.services.jsp.tags;
/* ====================================================================
* The Apache Software License, Version 1.1
*
* Copyright (c) 2000-2001 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 Jetspeed" 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
* "Apache Jetspeed", 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/>.
*/
// Servlet API
import javax.servlet.jsp.JspException;
import javax.servlet.jsp.PageContext;
import javax.servlet.jsp.tagext.TagSupport;
// Turbine Classes
import org.apache.turbine.util.Log;
import org.apache.turbine.util.DynamicURI;
import org.apache.turbine.services.jsp.JspService;
// ECS support
import org.apache.ecs.ConcreteElement;
import org.apache.ecs.StringElement;
// Jetspeed support
import org.apache.jetspeed.services.rundata.JetspeedRunData;
import org.apache.jetspeed.services.forward.ForwardService;
import org.apache.jetspeed.util.ServiceUtil;
/**
* Supporting class for the forward tag. Enables forwarding navigation to other pages or panes
* in the portal. If "name" and "target" are both specified, the "name" is assumed to be a portlet.
* If only "name" is specified, the name is assumed to be a logical forward name.
*
* @author <a href="mailto:morciuch@apache.org">Mark Orciuch</a>
* @version $Id: JetspeedForwardTag.java,v 1.1 2003/04/25 20:42:42 morciuch Exp $
* @see org.apache.jetspeed.services.forward.ForwardService#forward(RunData rundata, String forwardName)
* @see org.apache.jetspeed.services.forward.ForwardService#forward(RunData rundata, String portlet, String target)
* @since 1.4b4
*/
public class JetspeedForwardTag extends TagSupport
{
private String name = null;
private String target = null;
public void setName(String name)
{
this.name = name;
}
public String getName()
{
return this.name;
}
public void setTarget(String target)
{
this.target = target;
}
public String getTarget()
{
return this.target;
}
/**
* Method called when the tag is encountered to send attributes to the
* output stream
*
* @return SKIP_BODY, as it is intended to be a single tag.
*/
public int doStartTag() throws JspException
{
JetspeedRunData data = (JetspeedRunData) pageContext.getAttribute(JspService.RUNDATA, PageContext.REQUEST_SCOPE);
try
{
ConcreteElement result = null;
DynamicURI uri = null;
ForwardService service = (ForwardService) ServiceUtil.getServiceByName(ForwardService.SERVICE_NAME);
if (this.name != null && this.target != null)
{
uri = service.forward(data, this.name, this.target);
}
else if (this.getName() != null)
{
uri = service.forward(data, this.name);
}
if (uri != null)
{
result = new StringElement(uri.toString());
}
// Output the result
if (result != null)
{
pageContext.getOut().print(result);
}
}
catch (Exception e)
{
String message = "Error processing name '" + name + "'.";
Log.error(message, e);
try
{
data.getOut().print("Error processing forward name '" + name + "'. See log for more information.");
}
catch (java.io.IOException ioe)
{
}
}
return EVAL_BODY_INCLUDE;
}
}