Apache Struts API Documentation: Class RedirectTag

Apache Struts API

previous page next page

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: INNER | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.apache.struts.taglib.logic Class RedirectTag

java.lang.Object
  |
  +--javax.servlet.jsp.tagext.TagSupport
        |
        +--org.apache.struts.taglib.logic.RedirectTag

All Implemented Interfaces:: java.io.Serializable, javax.servlet.jsp.tagext.Tag

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

Generate a URL-encoded redirect to the specified URI.

Version:: $Rev: 54929 $ $Date: 2004-10-16 17:38:42 +0100 (Sat, 16 Oct 2004) $
See Also:: Serialized Form

Field Summary
`protected java.lang.String`	`action` The module-relative action (beginning with a slash) which will be called by this link
`protected java.lang.String`	`anchor` The anchor to be added to the end of the generated hyperlink.
`protected java.lang.String`	`forward` The logical forward name from which to retrieve the redirect URI.
`protected java.lang.String`	`href` The redirect URI.
`protected static MessageResources`	`messages` The message resources for this package.
`protected java.lang.String`	`module` The module prefix (beginning with a slash) which will be used to find the action for this link.
`protected java.lang.String`	`name` The JSP bean name for query parameters.
`protected java.lang.String`	`page` The module-relative page URL (beginning with a slash) to which this redirect will be rendered.
`protected java.lang.String`	`paramId` The single-parameter request parameter name to generate.
`protected java.lang.String`	`paramName` The single-parameter JSP bean name.
`protected java.lang.String`	`paramProperty` The single-parameter JSP bean property.
`protected java.lang.String`	`paramScope` The single-parameter JSP bean scope.
`protected java.lang.String`	`property` The JSP bean property name for query parameters.
`protected java.lang.String`	`scope` The scope of the bean specified by the name property, if any.
`protected boolean`	`transaction` Include our transaction control token?
`protected boolean`	`useLocalEncoding` Use character encoding from ServletResponse#getCharacterEncoding to get bytes of the url string for urlencoding?

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

id, pageContext, parent, values

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

EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE

Constructor Summary
`RedirectTag()`

Method Summary
`int`	`doEndTag()` Render the redirect and skip the remainder of this page.
`protected void`	`doRedirect(java.lang.String url)` Redirect to the given url converting exceptions to JspException.
`int`	`doStartTag()` Defer generation until the end of this tag is encountered.
`protected java.lang.String`	`generateRedirectURL()` Calculate the url to redirect to.
`java.lang.String`	`getAction()`
`java.lang.String`	`getAnchor()`
`java.lang.String`	`getForward()`
`java.lang.String`	`getHref()`
`java.lang.String`	`getModule()`
`java.lang.String`	`getName()`
`java.lang.String`	`getPage()`
`java.lang.String`	`getParamId()`
`java.lang.String`	`getParamName()`
`java.lang.String`	`getParamProperty()`
`java.lang.String`	`getParamScope()`
`java.lang.String`	`getProperty()`
`java.lang.String`	`getScope()`
`boolean`	`getTransaction()`
`boolean`	`isUseLocalEncoding()`
`void`	`release()` Release any acquired resources.
`void`	`setAction(java.lang.String action)`
`void`	`setAnchor(java.lang.String anchor)`
`void`	`setForward(java.lang.String forward)`
`void`	`setHref(java.lang.String href)`
`void`	`setModule(java.lang.String module)`
`void`	`setName(java.lang.String name)`
`void`	`setPage(java.lang.String page)`
`void`	`setParamId(java.lang.String paramId)`
`void`	`setParamName(java.lang.String paramName)`
`void`	`setParamProperty(java.lang.String paramProperty)`
`void`	`setParamScope(java.lang.String paramScope)`
`void`	`setProperty(java.lang.String property)`
`void`	`setScope(java.lang.String scope)`
`void`	`setTransaction(boolean transaction)`
`void`	`setUseLocalEncoding(boolean b)`

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

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

Methods inherited from class java.lang.Object

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

Field Detail

anchor

protected java.lang.String anchor

The anchor to be added to the end of the generated hyperlink.

forward

protected java.lang.String forward

The logical forward name from which to retrieve the redirect URI.

href

protected java.lang.String href

The redirect URI.

messages

protected static MessageResources messages

The message resources for this package.

name

protected java.lang.String name

The JSP bean name for query parameters.

page

protected java.lang.String page

The module-relative page URL (beginning with a slash) to which this redirect will be rendered.

action

protected java.lang.String action

The module-relative action (beginning with a slash) which will be called by this link

module

protected java.lang.String module

The module prefix (beginning with a slash) which will be used to find the action for this link.

paramId

protected java.lang.String paramId

The single-parameter request parameter name to generate.

paramName

protected java.lang.String paramName

The single-parameter JSP bean name.

paramProperty

protected java.lang.String paramProperty

The single-parameter JSP bean property.

paramScope

protected java.lang.String paramScope

The single-parameter JSP bean scope.

property

protected java.lang.String property

The JSP bean property name for query parameters.

scope

protected java.lang.String scope

The scope of the bean specified by the name property, if any.

transaction

protected boolean transaction

Include our transaction control token?

useLocalEncoding

protected boolean useLocalEncoding

Use character encoding from ServletResponse#getCharacterEncoding to get bytes of the url string for urlencoding?

Constructor Detail

RedirectTag

public RedirectTag()

Method Detail

getAnchor

public java.lang.String getAnchor()

setAnchor

public void setAnchor(java.lang.String anchor)

getForward

public java.lang.String getForward()

setForward

public void setForward(java.lang.String forward)

getHref

public java.lang.String getHref()

setHref

public void setHref(java.lang.String href)

getName

public java.lang.String getName()

setName

public void setName(java.lang.String name)

getPage

public java.lang.String getPage()

setPage

public void setPage(java.lang.String page)

getAction

public java.lang.String getAction()

setAction

public void setAction(java.lang.String action)

getModule

public java.lang.String getModule()

setModule

public void setModule(java.lang.String module)

getParamId

public java.lang.String getParamId()

setParamId

public void setParamId(java.lang.String paramId)

getParamName

public java.lang.String getParamName()

setParamName

public void setParamName(java.lang.String paramName)

getParamProperty

public java.lang.String getParamProperty()

setParamProperty

public void setParamProperty(java.lang.String paramProperty)

getParamScope

public java.lang.String getParamScope()

setParamScope

public void setParamScope(java.lang.String paramScope)

getProperty

public java.lang.String getProperty()

setProperty

public void setProperty(java.lang.String property)

getScope

public java.lang.String getScope()

setScope

public void setScope(java.lang.String scope)

getTransaction

public boolean getTransaction()

setTransaction

public void setTransaction(boolean transaction)

isUseLocalEncoding

public boolean isUseLocalEncoding()

setUseLocalEncoding

public void setUseLocalEncoding(boolean b)

doStartTag

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

Defer generation until the end of this tag is encountered.

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

Render the redirect and skip the remainder of this page.

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

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

generateRedirectURL

protected java.lang.String generateRedirectURL()
                                        throws javax.servlet.jsp.JspException

Calculate the url to redirect to.

Throws:: javax.servlet.jsp.JspException -
Since:: Struts 1.2

doRedirect

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

Redirect to the given url converting exceptions to JspException.

Parameters:: url - The path to redirect to.
Throws:: javax.servlet.jsp.JspException -
Since:: Struts 1.2

release

public void release()

Release any acquired resources.

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