Module com.aoapps.taglib

Package com.aoapps.taglib

Class DispatchTag

java.lang.Object

javax.servlet.jsp.tagext.SimpleTagSupport

com.aoapps.taglib.DispatchTag

All Implemented Interfaces:

PageAttribute, ParamsAttribute, DynamicAttributes, JspTag, SimpleTag

Direct Known Subclasses:

ForwardTag, IncludeTag, RedirectTag

public abstract class DispatchTag
extends SimpleTagSupport
implements DynamicAttributes, PageAttribute, ParamsAttribute

The base class for any tag that may call a request dispatcher.

Author:

AO Industries, Inc.

Field Summary

Fields

Modifier and Type	Field	Description
protected static final ScopeEE.Request.Attribute<Boolean>	FORWARDED_REQUEST_ATTRIBUTE	Deprecated. Please use ScopeEE.Request.FORWARD_SERVLET_PATH directly.
protected String	page
protected MutableURIParameters	params

Constructor Summary

Constructors

Constructor	Description
DispatchTag()

Method Summary

Modifier and Type	Method	Description
protected boolean	addDynamicAttribute(String uri, String localName, Object value, List<String> expectedPatterns)	Adds a dynamic attribute.
void	addParam(String name, Object value)	Adds a parameter.
void	doTag()	Deprecated. You should probably be implementing in dispatch(javax.servlet.RequestDispatcher, javax.servlet.jsp.JspWriter, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)
protected void	doTag(String servletPath)	Subclass hook to intercept request after servlet paths have been determined and before dispatch is called.
protected abstract Map<String,?>	getArgs()	Gets the arguments that will be passed on dispatch.
protected abstract WildcardPatternMatcher	getClearParamsMatcher()
static HttpServletRequest	getParameterAlteredRequest(HttpServletRequest request, URIParameters params, Map<String,String[]> oldMap, WildcardPatternMatcher clearParamsMatcher)
protected void	invoke(JspFragment body)	Invokes the body.
static boolean	isForwarded(ServletRequest req)	Deprecated. Please use ScopeEE.Request.FORWARD_SERVLET_PATH directly.
void	setDynamicAttribute(String uri, String localName, Object value)	Deprecated. You should probably be implementing in addDynamicAttribute(java.lang.String, java.lang.String, java.lang.Object, java.util.List)
void	setPage(String page)

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

findAncestorWithClass, getJspBody, getJspContext, getParent, setJspBody, setJspContext, setParent

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.aoapps.taglib.ParamsAttribute

addParam

Field Details

FORWARDED_REQUEST_ATTRIBUTE

@Deprecated
protected static final ScopeEE.Request.Attribute<Boolean> FORWARDED_REQUEST_ATTRIBUTE

Deprecated.

Please use ScopeEE.Request.FORWARD_SERVLET_PATH directly.

Tracks if the request has been forwarded.

page

protected String page

params

protected MutableURIParameters params

Constructor Details

DispatchTag

public DispatchTag()

Method Details

isForwarded

@Deprecated
public static boolean isForwarded(ServletRequest req)

Deprecated.

Please use ScopeEE.Request.FORWARD_SERVLET_PATH directly.

Checks if the request has been forwarded.

getParameterAlteredRequest

public static HttpServletRequest getParameterAlteredRequest(HttpServletRequest request,
 URIParameters params,
 Map<String,String[]> oldMap,
 WildcardPatternMatcher clearParamsMatcher)

setPage

public void setPage(String page)

Specified by:

setPage in interface PageAttribute

getClearParamsMatcher

protected abstract WildcardPatternMatcher getClearParamsMatcher()

addParam

public void addParam(String name,
 Object value)

Description copied from interface: ParamsAttribute

Adds a parameter.

The conversion to string may be deferred, or the value may be streamed instead of being converted to a string. It is incorrect to change the state of the provided value; doing so may or may not affect the value of the resulting parameter.

When the value is an Enum, the parameter value is obtained from Enum.name() instead of Enum.toString(). This is to intuitively use enums as parameters when Enum.toString() is overridden.

Default method is for backward compatibility only. Implementations should override this version.

Specified by:

addParam in interface ParamsAttribute

addDynamicAttribute

protected boolean addDynamicAttribute(String uri,
 String localName,
 Object value,
 List<String> expectedPatterns)
                               throws JspTagException

Adds a dynamic attribute.

Returns:

true when added, or false when attribute not expected and has not been added.

Throws:

JspTagException

See Also:

• ParamUtils.addDynamicAttribute(java.lang.String, java.lang.String, java.lang.Object, java.util.List, com.aoapps.taglib.ParamsAttribute)
• setDynamicAttribute(java.lang.String, java.lang.String, java.lang.Object)

setDynamicAttribute

@Deprecated
public void setDynamicAttribute(String uri,
 String localName,
 Object value)
                         throws JspException

Deprecated.

You should probably be implementing in addDynamicAttribute(java.lang.String, java.lang.String, java.lang.Object, java.util.List)

Sets a dynamic attribute.

Specified by:

setDynamicAttribute in interface DynamicAttributes

Throws:

JspException

See Also:

• addDynamicAttribute(java.lang.String, java.lang.String, java.lang.Object, java.util.List)

getArgs

protected abstract Map<String,?> getArgs()

Gets the arguments that will be passed on dispatch. For no arguments, return null.

doTag

protected void doTag(String servletPath)
              throws IOException,
JspException,
SkipPageException

Subclass hook to intercept request after servlet paths have been determined and before dispatch is called.

This default implementation does nothing.

Throws:

SkipPageException - If the implementation has handled the request, must throw SkipPageException.

IOException

JspException

doTag

@Deprecated
public void doTag()
           throws JspException,
IOException

Deprecated.

You should probably be implementing in dispatch(javax.servlet.RequestDispatcher, javax.servlet.jsp.JspWriter, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)

Specified by:

doTag in interface SimpleTag

Overrides:

doTag in class SimpleTagSupport

Throws:

JspException

IOException

See Also:

• dispatch(javax.servlet.RequestDispatcher, javax.servlet.jsp.JspWriter, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)

invoke

protected void invoke(JspFragment body)
               throws JspException,
IOException

Invokes the body. This is only called when a body exists. Subclasses may override this to perform actions before and/or after invoking the body. Any overriding implementation should call super.invoke(JspFragment) to invoke the body.

Discards all nested output, since this will not use the output and this output could possibly fill the response buffer and prevent the dispatch from functioning.

Throws:

JspException

IOException