org.apache.struts.taglib.logic

Class RedirectTag

public class RedirectTag extends 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) $

Field Summary
protected String	action The module-relative action (beginning with a slash) which will be called by this link
protected String	anchor The anchor to be added to the end of the generated hyperlink.
protected String	forward The logical forward name from which to retrieve the redirect URI.
protected String	href The redirect URI.
protected static MessageResources	messages The message resources for this package.
protected String	module The module prefix (beginning with a slash) which will be used to find the action for this link.
protected String	name The JSP bean name for query parameters.
protected String	page The module-relative page URL (beginning with a slash) to which this redirect will be rendered.
protected String	paramId The single-parameter request parameter name to generate.
protected String	paramName The single-parameter JSP bean name.
protected String	paramProperty The single-parameter JSP bean property.
protected String	paramScope The single-parameter JSP bean scope.
protected String	property The JSP bean property name for query parameters.
protected 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?

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

Field Detail

action

protected String action

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

anchor

protected String anchor

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

forward

protected String forward

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

href

protected String href

The redirect URI.

messages

protected static MessageResources messages

The message resources for this package.

module

protected String module

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

name

protected String name

The JSP bean name for query parameters.

page

protected String page

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

paramId

protected String paramId

The single-parameter request parameter name to generate.

paramName

protected String paramName

The single-parameter JSP bean name.

paramProperty

protected String paramProperty

The single-parameter JSP bean property.

paramScope

protected String paramScope

The single-parameter JSP bean scope.

property

protected String property

The JSP bean property name for query parameters.

scope

protected 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?

Method Detail

doEndTag

public int doEndTag()

Render the redirect and skip the remainder of this page.

Throws: JspException if a JSP exception has occurred

doRedirect

protected void doRedirect(String url)

Redirect to the given url converting exceptions to JspException.

Parameters: url The path to redirect to.

Throws: JspException

Since: Struts 1.2

doStartTag

public int doStartTag()

Defer generation until the end of this tag is encountered.

Throws: JspException if a JSP exception has occurred

generateRedirectURL

protected String generateRedirectURL()

Calculate the url to redirect to.

Throws: JspException

Since: Struts 1.2

getAction

public String getAction()

getAnchor

public String getAnchor()

getForward

public String getForward()

getHref

public String getHref()

getModule

public String getModule()

getName

public String getName()

getPage

public String getPage()

getParamId

public String getParamId()

getParamName

public String getParamName()

getParamProperty

public String getParamProperty()

getParamScope

public String getParamScope()

getProperty

public String getProperty()

getScope

public String getScope()

getTransaction

public boolean getTransaction()

isUseLocalEncoding

public boolean isUseLocalEncoding()

release

public void release()

Release any acquired resources.

setAction

public void setAction(String action)

setAnchor

public void setAnchor(String anchor)

setForward

public void setForward(String forward)

setHref

public void setHref(String href)

setModule

public void setModule(String module)

setName

public void setName(String name)

setPage

public void setPage(String page)

setParamId

public void setParamId(String paramId)

setParamName

public void setParamName(String paramName)

setParamProperty

public void setParamProperty(String paramProperty)

setParamScope

public void setParamScope(String paramScope)

setProperty

public void setProperty(String property)

setScope

public void setScope(String scope)

setTransaction

public void setTransaction(boolean transaction)

setUseLocalEncoding

public void setUseLocalEncoding(boolean b)