org.apache.struts.taglib.logic

Class ForwardTag

java.lang.Object

javax.servlet.jsp.tagext.TagSupport

org.apache.struts.taglib.logic.ForwardTag

All Implemented Interfaces:

java.io.Serializable, javax.servlet.jsp.tagext.IterationTag, javax.servlet.jsp.tagext.JspTag, javax.servlet.jsp.tagext.Tag

Direct Known Subclasses:

ELForwardTag

public class ForwardTag
extends javax.servlet.jsp.tagext.TagSupport

Perform a forward or redirect to a page that is looked up in the configuration information associated with our application.

Version:

$Rev: 471754 $ $Date: 2004-10-16 12:38:42 -0400 (Sat, 16 Oct 2004) $

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected static MessageResources	messages The message resources for this package.
protected java.lang.String	name The logical name of the ActionForward entry to be looked up.

Fields inherited from class javax.servlet.jsp.tagext.TagSupport

id, pageContext

Fields inherited from interface javax.servlet.jsp.tagext.IterationTag

EVAL_BODY_AGAIN

Fields inherited from interface javax.servlet.jsp.tagext.Tag

EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE

Constructor Summary

Constructors

Constructor and Description
ForwardTag()

Method Summary

Modifier and Type	Method and Description
int	doEndTag() Look up the ActionForward associated with the specified name, and perform a forward or redirect to that path as indicated.
protected void	doForward(java.lang.String path) Forward to the given path converting exceptions to JspException.
protected void	doRedirect(java.lang.String path) Redirect to the given path converting exceptions to JspException.
int	doStartTag() Defer processing until the end of this tag is encountered.
java.lang.String	getName()
void	release() Release all allocated resources.
void	setName(java.lang.String name)

Methods inherited from class javax.servlet.jsp.tagext.TagSupport

doAfterBody, findAncestorWithClass, getId, getParent, getValue, getValues, removeValue, setId, setPageContext, setParent, setValue

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

messages

protected static MessageResources messages

The message resources for this package.

name

protected java.lang.String name

The logical name of the ActionForward entry to be looked up.

Constructor Detail

ForwardTag

public ForwardTag()

Method Detail

getName

public java.lang.String getName()

setName

public void setName(java.lang.String name)

doStartTag

public int doStartTag()
               throws javax.servlet.jsp.JspException

Defer processing until the end of this tag is encountered.

Specified by:

doStartTag in interface javax.servlet.jsp.tagext.Tag

Overrides:

doStartTag in class javax.servlet.jsp.tagext.TagSupport

Throws:

javax.servlet.jsp.JspException - if a JSP exception has occurred

doEndTag

public int doEndTag()
             throws javax.servlet.jsp.JspException

Look up the ActionForward associated with the specified name, and perform a forward or redirect to that path as indicated.

Specified by:

doEndTag in interface javax.servlet.jsp.tagext.Tag

Overrides:

doEndTag in class javax.servlet.jsp.tagext.TagSupport

Throws:

javax.servlet.jsp.JspException - if a JSP exception has occurred

doForward

protected void doForward(java.lang.String path)
                  throws javax.servlet.jsp.JspException

Forward to the given path converting exceptions to JspException.

Parameters:

path - The path to forward to.

Throws:

javax.servlet.jsp.JspException

Since:

Struts 1.2

doRedirect

protected void doRedirect(java.lang.String path)
                   throws javax.servlet.jsp.JspException

Redirect to the given path converting exceptions to JspException.

Parameters:

path - The path to redirect to.

Throws:

javax.servlet.jsp.JspException

Since:

Struts 1.2

release

public void release()

Release all allocated resources.

Specified by:

release in interface javax.servlet.jsp.tagext.Tag

Overrides:

release in class javax.servlet.jsp.tagext.TagSupport