|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--org.apache.struts.util.RequestUtils
General purpose utility methods related to processing a servlet request in the Struts controller framework.
Field Summary | |
protected static org.apache.commons.logging.Log |
log
Commons Logging instance. |
Constructor Summary | |
RequestUtils()
|
Method Summary | |
static java.net.URL |
absoluteURL(javax.servlet.http.HttpServletRequest request,
java.lang.String path)
Create and return an absolute URL for the specified context-relative path, based on the server and context information in the specified request. |
static java.lang.String |
actionURL(javax.servlet.http.HttpServletRequest request,
ActionConfig action,
java.lang.String pattern)
Return the context-relative URL that corresponds to the specified ActionConfig , relative to the module associated
with the current modules's ModuleConfig . |
static java.lang.Class |
applicationClass(java.lang.String className)
Return the Class object for the specified fully qualified
class name, from this web application's class loader. |
static java.lang.Object |
applicationInstance(java.lang.String className)
Return a new instance of the specified fully qualified class name, after loading the class from this web application's class loader. |
private static boolean |
canReuseActionForm(ActionForm instance,
FormBeanConfig config)
Determine whether instance of ActionForm is
suitable for re-use as an instance of the form described by
config . |
static java.util.Map |
computeParameters(javax.servlet.jsp.PageContext pageContext,
java.lang.String paramId,
java.lang.String paramName,
java.lang.String paramProperty,
java.lang.String paramScope,
java.lang.String name,
java.lang.String property,
java.lang.String scope,
boolean transaction)
Deprecated. This will be removed after Struts 1.2. Use TagUtils.computeParameters(PageContext,String,String,String,String,String,String,String,boolean) instead. |
static java.lang.String |
computeURL(javax.servlet.jsp.PageContext pageContext,
java.lang.String forward,
java.lang.String href,
java.lang.String page,
java.util.Map params,
java.lang.String anchor,
boolean redirect)
Deprecated. This will be removed after Struts 1.2 Use computeURL(PageContext, String, String, String, String, Map, String, boolean) instead. |
static java.lang.String |
computeURL(javax.servlet.jsp.PageContext pageContext,
java.lang.String forward,
java.lang.String href,
java.lang.String page,
java.lang.String action,
java.util.Map params,
java.lang.String anchor,
boolean redirect)
Deprecated. This will be removed after Struts 1.2. Use TagUtils.computeURL(PageContext,String,String,String,String,String,Map,String, boolean) instead. |
static java.lang.String |
computeURL(javax.servlet.jsp.PageContext pageContext,
java.lang.String forward,
java.lang.String href,
java.lang.String page,
java.lang.String action,
java.util.Map params,
java.lang.String anchor,
boolean redirect,
boolean encodeSeparator)
Deprecated. This will be removed after Struts 1.2. Use TagUtils.computeURL(PageContext,String,String,String,String,String,Map,String,boolean,boolean) instead. |
static ActionForm |
createActionForm(FormBeanConfig config,
ActionServlet servlet)
Create and return an ActionForm instance appropriate
to the information in config . |
static ActionForm |
createActionForm(javax.servlet.http.HttpServletRequest request,
ActionMapping mapping,
ModuleConfig moduleConfig,
ActionServlet servlet)
Create (if necessary) and return an ActionForm instance appropriate
for this request. |
static java.lang.StringBuffer |
createServerStringBuffer(java.lang.String scheme,
java.lang.String server,
int port)
Return StringBuffer representing the scheme, server, and port number of
the current request. |
static java.lang.StringBuffer |
createServerUriStringBuffer(java.lang.String scheme,
java.lang.String server,
int port,
java.lang.String uri)
Return StringBuffer representing the scheme, server, and port number of
the current request. |
static java.lang.String |
encodeURL(java.lang.String url)
Deprecated. Use TagUtils.encodeURL(String) instead.
This will be removed after Struts 1.2. |
static java.lang.String |
forwardURL(javax.servlet.http.HttpServletRequest request,
ForwardConfig forward)
Return the context-relative URL that corresponds to the specified ForwardConfig . |
static java.lang.String |
forwardURL(javax.servlet.http.HttpServletRequest request,
ForwardConfig forward,
ModuleConfig moduleConfig)
Return the context-relative URL that corresponds to the specified ForwardConfig . |
static ActionErrors |
getActionErrors(javax.servlet.jsp.PageContext pageContext,
java.lang.String paramName)
Deprecated. Use TagUtils.getActionErrors(PageContext,String) instead.
This will be removed after Struts 1.2. |
static java.lang.String |
getActionMappingName(java.lang.String action)
Deprecated. This will be removed after Struts 1.2. Use TagUtils.getActionMappingName(String) instead. |
static java.lang.String |
getActionMappingURL(java.lang.String action,
javax.servlet.jsp.PageContext pageContext)
Deprecated. This will be removed after Struts 1.2. Use TagUtils.getActionMappingURL(String,PageContext) instead. |
static ActionMessages |
getActionMessages(javax.servlet.jsp.PageContext pageContext,
java.lang.String paramName)
Deprecated. Use TagUtils.getActionMessages(PageContext,String) instead.
This will be removed after Struts 1.2. |
private static java.util.Map |
getAllParametersForMultipartRequest(javax.servlet.http.HttpServletRequest request,
MultipartRequestHandler multipartHandler)
Create a Map containing all of the parameters supplied for a multipart
request, keyed by parameter name. |
static ModuleConfig |
getModuleConfig(javax.servlet.http.HttpServletRequest request,
javax.servlet.ServletContext context)
Deprecated. Use ModuleUtils.getModuleConfig(HttpServletRequest,ServletContext) instead.
This will be removed after Struts 1.2. |
static ModuleConfig |
getModuleConfig(javax.servlet.jsp.PageContext pageContext)
Deprecated. Use TagUtils.getModuleConfig(PageContext) instead.
This will be removed after Struts 1.2. |
static java.lang.String |
getModuleName(javax.servlet.http.HttpServletRequest request,
javax.servlet.ServletContext context)
Deprecated. Use Use ModuleUtils.getModuleName(HttpServletRequest,ServletContext) instead.
This will be removed after Struts 1.2. |
static java.lang.String |
getModuleName(java.lang.String matchPath,
javax.servlet.ServletContext context)
Deprecated. Use ModuleUtils.getModuleName(String,ServletContext) instead.
This will be removed after Struts 1.2. |
static java.lang.String[] |
getModulePrefixes(javax.servlet.ServletContext context)
Deprecated. Use ModuleUtils.getModulePrefixes(ServletContext) instead.
This will be removed after Struts 1.2. |
private static MultipartRequestHandler |
getMultipartHandler(javax.servlet.http.HttpServletRequest request)
Try to locate a multipart request handler for this request. |
static ModuleConfig |
getRequestModuleConfig(javax.servlet.http.HttpServletRequest request)
Deprecated. Use ModuleUtils.getModuleConfig(HttpServletRequest) instead.
This will be removed after Struts 1.2. |
static int |
getScope(java.lang.String scopeName)
Deprecated. This will be removed after Struts 1.2. Use TagUtils.getScope(String) instead. |
static java.util.Locale |
getUserLocale(javax.servlet.http.HttpServletRequest request,
java.lang.String locale)
Look up and return current user locale, based on the specified parameters. |
static boolean |
isXhtml(javax.servlet.jsp.PageContext pageContext)
Deprecated. Use TagUtils.isXhtml(PageContext) instead.
This will be removed after Struts 1.2. |
static java.lang.Object |
lookup(javax.servlet.jsp.PageContext pageContext,
java.lang.String name,
java.lang.String scopeName)
Deprecated. This will be removed after Struts 1.2. Use TagUtils.lookup(PageContext,String,String) instead. |
static java.lang.Object |
lookup(javax.servlet.jsp.PageContext pageContext,
java.lang.String name,
java.lang.String property,
java.lang.String scope)
Deprecated. This will be removed after Struts 1.2. Use TagUtils.lookup(PageContext,String,String,String) instead. |
private static ActionForm |
lookupActionForm(javax.servlet.http.HttpServletRequest request,
java.lang.String attribute,
java.lang.String scope)
|
static java.lang.String |
message(javax.servlet.jsp.PageContext pageContext,
java.lang.String bundle,
java.lang.String locale,
java.lang.String key)
Deprecated. Use TagUtils.message(PageContext,String,String,String) instead.
This will be removed after Struts 1.2. |
static java.lang.String |
message(javax.servlet.jsp.PageContext pageContext,
java.lang.String bundle,
java.lang.String locale,
java.lang.String key,
java.lang.Object[] args)
Deprecated. Use TagUtils.message(PageContext,String,String,String,Object[]) instead.
This will be removed after Struts 1.2. |
static java.lang.String |
pageURL(javax.servlet.http.HttpServletRequest request,
java.lang.String page)
Deprecated. Use TagUtils.pageURL(HttpServletRequest request, String page, ModuleConfig moduleConfig) instead.
This will be removed after Struts 1.2. |
static void |
populate(java.lang.Object bean,
javax.servlet.http.HttpServletRequest request)
Populate the properties of the specified JavaBean from the specified HTTP request, based on matching each parameter name against the corresponding JavaBeans "property setter" methods in the bean's class. |
static void |
populate(java.lang.Object bean,
java.lang.String prefix,
java.lang.String suffix,
javax.servlet.http.HttpServletRequest request)
Populate the properties of the specified JavaBean from the specified HTTP request, based on matching each parameter name (plus an optional prefix and/or suffix) against the corresponding JavaBeans "property setter" methods in the bean's class. |
static boolean |
present(javax.servlet.jsp.PageContext pageContext,
java.lang.String bundle,
java.lang.String locale,
java.lang.String key)
Deprecated. Use TagUtils.present(PageContext ,String,String,String) instead.
This will be removed after Struts 1.2. |
static java.lang.String |
printableURL(java.net.URL url)
Compute the printable representation of a URL, leaving off the scheme/host/port part if no host is specified. |
static java.lang.StringBuffer |
requestToServerStringBuffer(javax.servlet.http.HttpServletRequest request)
Return StringBuffer representing the scheme, server, and port number of
the current request. |
static java.lang.StringBuffer |
requestToServerUriStringBuffer(javax.servlet.http.HttpServletRequest request)
Return the string representing the scheme, server, and port number of the current request. |
static java.net.URL |
requestURL(javax.servlet.http.HttpServletRequest request)
Return the URL representing the current request. |
static java.util.Locale |
retrieveUserLocale(javax.servlet.jsp.PageContext pageContext,
java.lang.String locale)
Deprecated. This will be removed after Struts 1.2. Use TagUtils.getUserLocale(PageContext,String) instead. |
static void |
saveException(javax.servlet.jsp.PageContext pageContext,
java.lang.Throwable exception)
Deprecated. Use TagUtils.saveException(PageContext,Throwable) instead.
This will be removed after Struts 1.2. |
static void |
selectModule(javax.servlet.http.HttpServletRequest request,
javax.servlet.ServletContext context)
Deprecated. Use ModuleUtils.selectModule(HttpServletRequest,ServletContext) instead.
This will be removed after Struts 1.2. |
static void |
selectModule(java.lang.String prefix,
javax.servlet.http.HttpServletRequest request,
javax.servlet.ServletContext context)
Deprecated. Use ModuleUtils.selectModule(String,HttpServletRequest,ServletContext) instead.
This will be removed after Struts 1.2. |
static java.net.URL |
serverURL(javax.servlet.http.HttpServletRequest request)
Return the URL representing the scheme, server, and port number of the current request. |
Methods inherited from class java.lang.Object |
|
Field Detail |
protected static org.apache.commons.logging.Log log
Commons Logging instance.
Constructor Detail |
public RequestUtils()
Method Detail |
public static java.net.URL absoluteURL(javax.servlet.http.HttpServletRequest request, java.lang.String path) throws java.net.MalformedURLException
Create and return an absolute URL for the specified context-relative path, based on the server and context information in the specified request.
request
- The servlet request we are processingpath
- The context-relative path (must start with '/')java.net.MalformedURLException
- if we cannot create an absolute URLpublic static java.lang.Class applicationClass(java.lang.String className) throws java.lang.ClassNotFoundException
Return the Class
object for the specified fully qualified
class name, from this web application's class loader.
className
- Fully qualified class name to be loadedjava.lang.ClassNotFoundException
- if the class cannot be foundpublic static java.lang.Object applicationInstance(java.lang.String className) throws java.lang.ClassNotFoundException, java.lang.IllegalAccessException, java.lang.InstantiationException
Return a new instance of the specified fully qualified class name, after loading the class from this web application's class loader. The specified class MUST have a public zero-arguments constructor.
className
- Fully qualified class name to usejava.lang.ClassNotFoundException
- if the class cannot be foundjava.lang.IllegalAccessException
- if the class or its constructor
is not accessiblejava.lang.InstantiationException
- if this class represents an
abstract class, an interface, an array class, a primitive type,
or voidjava.lang.InstantiationException
- if this class has no
zero-arguments constructorpublic static ActionForm createActionForm(javax.servlet.http.HttpServletRequest request, ActionMapping mapping, ModuleConfig moduleConfig, ActionServlet servlet)
Create (if necessary) and return an ActionForm
instance appropriate
for this request. If no ActionForm
instance is required, return
null
.
request
- The servlet request we are processingmapping
- The action mapping for this requestmoduleConfig
- The configuration for this moduleservlet
- The action servletprivate static ActionForm lookupActionForm(javax.servlet.http.HttpServletRequest request, java.lang.String attribute, java.lang.String scope)
private static boolean canReuseActionForm(ActionForm instance, FormBeanConfig config) throws java.lang.ClassNotFoundException
Determine whether instance
of ActionForm
is
suitable for re-use as an instance of the form described by
config
.
instance
- an instance of ActionForm
which was found,
probably in either request or session scope.config
- the configuration for the ActionForm which is needed.FormBeanConfig
; false if not, or if instance
is null.java.lang.ClassNotFoundException
- if the type
property of
config
is not a valid Class name.public static ActionForm createActionForm(FormBeanConfig config, ActionServlet servlet)
Create and return an ActionForm
instance appropriate
to the information in config
.
Does not perform any checks to see if an existing ActionForm exists which could be reused.
config
- The configuration for the Form bean which is to be created.servlet
- The action servletpublic static java.util.Locale getUserLocale(javax.servlet.http.HttpServletRequest request, java.lang.String locale)
Look up and return current user locale, based on the specified parameters.
request
- The request used to lookup the Localelocale
- Name of the session attribute for our user's Locale. If this is
null
, the default locale key is used for the lookup.public static void populate(java.lang.Object bean, javax.servlet.http.HttpServletRequest request) throws javax.servlet.ServletException
Populate the properties of the specified JavaBean from the specified
HTTP request, based on matching each parameter name against the
corresponding JavaBeans "property setter" methods in the bean's class.
Suitable conversion is done for argument types as described under
convert()
.
bean
- The JavaBean whose properties are to be setrequest
- The HTTP request whose parameters are to be used
to populate bean propertiesjavax.servlet.ServletException
- if an exception is thrown while setting
property valuespublic static void populate(java.lang.Object bean, java.lang.String prefix, java.lang.String suffix, javax.servlet.http.HttpServletRequest request) throws javax.servlet.ServletException
Populate the properties of the specified JavaBean from the specified
HTTP request, based on matching each parameter name (plus an optional
prefix and/or suffix) against the corresponding JavaBeans "property
setter" methods in the bean's class. Suitable conversion is done for
argument types as described under setProperties
.
If you specify a non-null prefix
and a non-null
suffix
, the parameter name must match both
conditions for its value(s) to be used in populating bean properties.
If the request's content type is "multipart/form-data" and the
method is "POST", the HttpServletRequest
object will be wrapped in
a MultipartRequestWrapper
bean
- The JavaBean whose properties are to be setprefix
- The prefix (if any) to be prepend to bean property
names when looking for matching parameterssuffix
- The suffix (if any) to be appended to bean property
names when looking for matching parametersrequest
- The HTTP request whose parameters are to be used
to populate bean propertiesjavax.servlet.ServletException
- if an exception is thrown while setting
property valuesprivate static MultipartRequestHandler getMultipartHandler(javax.servlet.http.HttpServletRequest request) throws javax.servlet.ServletException
Try to locate a multipart request handler for this request. First, look for a mapping-specific handler stored for us under an attribute. If one is not present, use the global multipart handler, if there is one.
request
- The HTTP request for which the multipart handler should
be found.javax.servlet.ServletException
- if any exception is thrown while attempting
to locate the multipart handler.private static java.util.Map getAllParametersForMultipartRequest(javax.servlet.http.HttpServletRequest request, MultipartRequestHandler multipartHandler)
Create a Map
containing all of the parameters supplied for a multipart
request, keyed by parameter name. In addition to text and file elements
from the multipart body, query string parameters are included as well.
request
- The (wrapped) HTTP request whose parameters are to be
added to the map.multipartHandler
- The multipart handler used to parse the request.public static java.lang.String printableURL(java.net.URL url)
Compute the printable representation of a URL, leaving off the scheme/host/port part if no host is specified. This will typically be the case for URLs that were originally created from relative or context-relative URIs.
url
- URL to render in a printable representationpublic static java.lang.String actionURL(javax.servlet.http.HttpServletRequest request, ActionConfig action, java.lang.String pattern)
Return the context-relative URL that corresponds to the specified
ActionConfig
, relative to the module associated
with the current modules's ModuleConfig
.
request
- The servlet request we are processingaction
- ActionConfig to be evaluatedpattern
- URL pattern used to map the controller servletpublic static java.lang.String forwardURL(javax.servlet.http.HttpServletRequest request, ForwardConfig forward)
Return the context-relative URL that corresponds to the specified
ForwardConfig
. The URL is calculated based on the properties
of the ForwardConfig
instance as follows:
contextRelative
property is set, it is
assumed that the path
property contains a path
that is already context-relative:
path
property value starts with a slash,
it is returned unmodified.path
property value does not start
with a slash, a slash is prepended.forwardPattern
property from the
ControllerConfig
for the application module used
to process this request. If no pattern was configured, default
to a pattern of $M$P
, which is compatible with the
hard-coded mapping behavior in Struts 1.0.forwardPattern
, performing the
following substitutions:
path
property of the specified ForwardConfig
, prepended
with a slash if it does not start with one.request
- The servlet request we are processingforward
- ForwardConfig to be evaluatedpublic static java.lang.String forwardURL(javax.servlet.http.HttpServletRequest request, ForwardConfig forward, ModuleConfig moduleConfig)
Return the context-relative URL that corresponds to the specified
ForwardConfig
. The URL is calculated based on the properties
of the ForwardConfig
instance as follows:
contextRelative
property is set, it is
assumed that the path
property contains a path
that is already context-relative:
path
property value starts with a slash,
it is returned unmodified.path
property value does not start
with a slash, a slash is prepended.forwardPattern
property from the
ControllerConfig
for the application module used
to process this request. If no pattern was configured, default
to a pattern of $M$P
, which is compatible with the
hard-coded mapping behavior in Struts 1.0.forwardPattern
, performing the
following substitutions:
path
property of the specified ForwardConfig
, prepended
with a slash if it does not start with one.request
- The servlet request we are processingforward
- ForwardConfig to be evaluatedmoduleConfig
- Base forward on this module config.public static java.net.URL requestURL(javax.servlet.http.HttpServletRequest request) throws java.net.MalformedURLException
Return the URL representing the current request. This is equivalent
to HttpServletRequest.getRequestURL
in Servlet 2.3.
request
- The servlet request we are processingjava.net.MalformedURLException
- if a URL cannot be createdpublic static java.net.URL serverURL(javax.servlet.http.HttpServletRequest request) throws java.net.MalformedURLException
Return the URL representing the scheme, server, and port number of the current request. Server-relative URLs can be created by simply appending the server-relative path (starting with '/') to this.
request
- The servlet request we are processingjava.net.MalformedURLException
- if a URL cannot be createdpublic static java.lang.StringBuffer requestToServerUriStringBuffer(javax.servlet.http.HttpServletRequest request)
Return the string representing the scheme, server, and port number of the current request. Server-relative URLs can be created by simply appending the server-relative path (starting with '/') to this.
request
- The servlet request we are processingpublic static java.lang.StringBuffer requestToServerStringBuffer(javax.servlet.http.HttpServletRequest request)
Return StringBuffer
representing the scheme, server, and port number of
the current request. Server-relative URLs can be created by simply
appending the server-relative path (starting with '/') to this.
request
- The servlet request we are processingpublic static java.lang.StringBuffer createServerStringBuffer(java.lang.String scheme, java.lang.String server, int port)
Return StringBuffer
representing the scheme, server, and port number of
the current request.
scheme
- The scheme name to useserver
- The server name to useport
- The port value to usepublic static java.lang.StringBuffer createServerUriStringBuffer(java.lang.String scheme, java.lang.String server, int port, java.lang.String uri)
Return StringBuffer
representing the scheme, server, and port number of
the current request.
scheme
- The scheme name to useserver
- The server name to useport
- The port value to useuri
- The uri value to usepublic static void selectModule(java.lang.String prefix, javax.servlet.http.HttpServletRequest request, javax.servlet.ServletContext context)
ModuleUtils.selectModule(String,HttpServletRequest,ServletContext)
instead.
This will be removed after Struts 1.2.
Select the module to which the specified request belongs, and add corresponding request attributes to this request.
prefix
- The module prefix of the desired modulerequest
- The servlet request we are processingcontext
- The ServletContext for this web applicationpublic static void selectModule(javax.servlet.http.HttpServletRequest request, javax.servlet.ServletContext context)
ModuleUtils.selectModule(HttpServletRequest,ServletContext)
instead.
This will be removed after Struts 1.2.
Select the module to which the specified request belongs, and add corresponding request attributes to this request.
request
- The servlet request we are processingcontext
- The ServletContext for this web applicationpublic static java.lang.String getModuleName(javax.servlet.http.HttpServletRequest request, javax.servlet.ServletContext context)
ModuleUtils.getModuleName(HttpServletRequest,ServletContext)
instead.
This will be removed after Struts 1.2.
request
- The servlet request we are processingcontext
- The ServletContext for this web applicationpublic static java.lang.String getModuleName(java.lang.String matchPath, javax.servlet.ServletContext context)
ModuleUtils.getModuleName(String,ServletContext)
instead.
This will be removed after Struts 1.2.
Get the module name to which the specified uri belong.
matchPath
- The uri from which we want the module name.context
- The ServletContext for this web applicationpublic static ModuleConfig getRequestModuleConfig(javax.servlet.http.HttpServletRequest request)
ModuleUtils.getModuleConfig(HttpServletRequest)
instead.
This will be removed after Struts 1.2.
Return the current ModuleConfig
object stored in request,
if it exists, null otherwise.
This method can be used by a PlugIn
to
retrieve the current module config object. If no moduleConfig is found,
this means that the request hasn't hit the server through the Struts servlet.
The appropriate module config can be set and found with
.selectModule(HttpServletRequest, ServletContext)
request
- The servlet request we are processingpublic static ModuleConfig getModuleConfig(javax.servlet.http.HttpServletRequest request, javax.servlet.ServletContext context)
ModuleUtils.getModuleConfig(HttpServletRequest,ServletContext)
instead.
This will be removed after Struts 1.2.
Return the ModuleConfig object is it exists, null otherwise.
request
- The servlet request we are processingcontext
- The ServletContext for this web applicationpublic static java.lang.String[] getModulePrefixes(javax.servlet.ServletContext context)
ModuleUtils.getModulePrefixes(ServletContext)
instead.
This will be removed after Struts 1.2.
Return the list of module prefixes that are defined for this web application. NOTE - the "" prefix for the default module is not included in this list.
context
- The ServletContext for this web application.public static java.util.Map computeParameters(javax.servlet.jsp.PageContext pageContext, java.lang.String paramId, java.lang.String paramName, java.lang.String paramProperty, java.lang.String paramScope, java.lang.String name, java.lang.String property, java.lang.String scope, boolean transaction) throws javax.servlet.jsp.JspException
TagUtils.computeParameters(PageContext,String,String,String,String,String,String,String,boolean)
instead.
Compute a set of query parameters that will be dynamically added to
a generated URL. The returned Map is keyed by parameter name, and the
values are either null (no value specified), a String (single value
specified), or a String[] array (multiple values specified). Parameter
names correspond to the corresponding attributes of the
<html:link>
tag. If no query parameters are
identified, return null
.
pageContext
- PageContext we are operating inparamId
- Single-value request parameter name (if any)paramName
- Bean containing single-value parameter valueparamProperty
- Property (of bean named by paramName
containing single-value parameter valueparamScope
- Scope containing bean named by
paramName
name
- Bean containing multi-value parameters Map (if any)property
- Property (of bean named by name
containing multi-value parameters Mapscope
- Scope containing bean named by
name
transaction
- Should we add our transaction control token?javax.servlet.jsp.JspException
- if we cannot look up the required beansjavax.servlet.jsp.JspException
- if a class cast exception occurs on a
looked-up bean or propertypublic static java.lang.String computeURL(javax.servlet.jsp.PageContext pageContext, java.lang.String forward, java.lang.String href, java.lang.String page, java.util.Map params, java.lang.String anchor, boolean redirect) throws java.net.MalformedURLException
computeURL(PageContext, String, String, String, String, Map, String, boolean)
instead.
Compute a hyperlink URL based on the forward
,
href
or page
parameter
that is not null.
pageContext
- PageContext for the tag making this callforward
- Logical forward name for which to look up
the context-relative URI (if specified)href
- URL to be utilized unmodified (if specified)page
- Module-relative page for which a URL should
be created (if specified)params
- Map of parameters to be dynamically included (if any)anchor
- Anchor to be dynamically included (if any)redirect
- Is this URL for a response.sendRedirect()
?java.net.MalformedURLException
- if a URL cannot be created
for the specified parameterspublic static java.lang.String computeURL(javax.servlet.jsp.PageContext pageContext, java.lang.String forward, java.lang.String href, java.lang.String page, java.lang.String action, java.util.Map params, java.lang.String anchor, boolean redirect) throws java.net.MalformedURLException
TagUtils.computeURL(PageContext,String,String,String,String,String,Map,String, boolean)
instead.
Compute a hyperlink URL based on the forward
,
href
, action
or page
parameter
that is not null.
The returned URL will have already been passed to
response.encodeURL()
for adding a session identifier.
pageContext
- PageContext for the tag making this callforward
- Logical forward name for which to look up
the context-relative URI (if specified)href
- URL to be utilized unmodified (if specified)page
- Module-relative page for which a URL should
be created (if specified)action
- Logical action name for which to look up
the context-relative URI (if specified)params
- Map of parameters to be dynamically included (if any)anchor
- Anchor to be dynamically included (if any)redirect
- Is this URL for a response.sendRedirect()
?java.net.MalformedURLException
- if a URL cannot be created
for the specified parameterspublic static java.lang.String computeURL(javax.servlet.jsp.PageContext pageContext, java.lang.String forward, java.lang.String href, java.lang.String page, java.lang.String action, java.util.Map params, java.lang.String anchor, boolean redirect, boolean encodeSeparator) throws java.net.MalformedURLException
TagUtils.computeURL(PageContext,String,String,String,String,String,Map,String,boolean,boolean)
instead.
Compute a hyperlink URL based on the forward
,
href
, action
or page
parameter
that is not null.
The returned URL will have already been passed to
response.encodeURL()
for adding a session identifier.
pageContext
- PageContext for the tag making this callforward
- Logical forward name for which to look up
the context-relative URI (if specified)href
- URL to be utilized unmodified (if specified)page
- Module-relative page for which a URL should
be created (if specified)action
- Logical action name for which to look up
the context-relative URI (if specified)params
- Map of parameters to be dynamically included (if any)anchor
- Anchor to be dynamically included (if any)redirect
- Is this URL for a response.sendRedirect()
?encodeSeparator
- This is only checked if redirect is set to false (never
encoded for a redirect). If true, query string parameter separators are encoded
as >amp;, else & is used.java.net.MalformedURLException
- if a URL cannot be created
for the specified parameterspublic static java.lang.String getActionMappingName(java.lang.String action)
TagUtils.getActionMappingName(String)
instead.
Return the form action converted into an action mapping path. The
value of the action
property is manipulated as follows in
computing the name of the requested mapping:
public static java.lang.String getActionMappingURL(java.lang.String action, javax.servlet.jsp.PageContext pageContext)
TagUtils.getActionMappingURL(String,PageContext)
instead.
Return the form action converted into a server-relative URL.
public static java.lang.Object lookup(javax.servlet.jsp.PageContext pageContext, java.lang.String name, java.lang.String scopeName) throws javax.servlet.jsp.JspException
TagUtils.lookup(PageContext,String,String)
instead.
Locate and return the specified bean, from an optionally specified
scope, in the specified page context. If no such bean is found,
return null
instead. If an exception is thrown, it will
have already been saved via a call to saveException
.
pageContext
- Page context to be searchedname
- Name of the bean to be retrievedscopeName
- Scope to be searched (page, request, session, application)
or null
to use findAttribute()
insteadjavax.servlet.jsp.JspException
- if an invalid scope name
is requestedpublic static int getScope(java.lang.String scopeName) throws javax.servlet.jsp.JspException
TagUtils.getScope(String)
instead.
Converts the scope name into its corresponding PageContext constant value.
scopeName
- Can be "page", "request", "session", or "application" in any
casejavax.servlet.jsp.JspException
- if the scopeName is not a valid name.public static java.lang.Object lookup(javax.servlet.jsp.PageContext pageContext, java.lang.String name, java.lang.String property, java.lang.String scope) throws javax.servlet.jsp.JspException
TagUtils.lookup(PageContext,String,String,String)
instead.
Locate and return the specified property of the specified bean, from
an optionally specified scope, in the specified page context. If an
exception is thrown, it will have already been saved via a call to
saveException
.
pageContext
- Page context to be searchedname
- Name of the bean to be retrievedproperty
- Name of the property to be retrieved, or
null
to retrieve the bean itselfscope
- Scope to be searched (page, request, session, application)
or null
to use findAttribute()
insteadjavax.servlet.jsp.JspException
- if an invalid scope name
is requestedjavax.servlet.jsp.JspException
- if the specified bean is not foundjavax.servlet.jsp.JspException
- if accessing this property causes an
IllegalAccessException, IllegalArgumentException,
InvocationTargetException, or NoSuchMethodExceptionpublic static java.util.Locale retrieveUserLocale(javax.servlet.jsp.PageContext pageContext, java.lang.String locale)
TagUtils.getUserLocale(PageContext,String)
instead.
Look up and return current user locale, based on the specified parameters.
pageContext
- The PageContext associated with this requestlocale
- Name of the session attribute for our user's Locale. If this is
null
, the default locale key is used for the lookup.public static java.lang.String message(javax.servlet.jsp.PageContext pageContext, java.lang.String bundle, java.lang.String locale, java.lang.String key) throws javax.servlet.jsp.JspException
TagUtils.message(PageContext,String,String,String)
instead.
This will be removed after Struts 1.2.
Look up and return a message string, based on the specified parameters.
pageContext
- The PageContext associated with this requestbundle
- Name of the servlet context attribute for our
message resources bundlelocale
- Name of the session attribute for our user's Localekey
- Message key to be looked up and returnedjavax.servlet.jsp.JspException
- if a lookup error occurs (will have been
saved in the request already)public static java.lang.String message(javax.servlet.jsp.PageContext pageContext, java.lang.String bundle, java.lang.String locale, java.lang.String key, java.lang.Object[] args) throws javax.servlet.jsp.JspException
TagUtils.message(PageContext,String,String,String,Object[])
instead.
This will be removed after Struts 1.2.
pageContext
- The PageContext associated with this requestbundle
- Name of the servlet context attribute for our
message resources bundlelocale
- Name of the session attribute for our user's Localekey
- Message key to be looked up and returnedargs
- Replacement parameters for this messagejavax.servlet.jsp.JspException
- if a lookup error occurs (will have been
saved in the request already)public static boolean present(javax.servlet.jsp.PageContext pageContext, java.lang.String bundle, java.lang.String locale, java.lang.String key) throws javax.servlet.jsp.JspException
TagUtils.present(PageContext ,String,String,String)
instead.
This will be removed after Struts 1.2.
Return true if a message string for the specified message key is present for the specified Locale.
pageContext
- The PageContext associated with this requestbundle
- Name of the servlet context attribute for our
message resources bundlelocale
- Name of the session attribute for our user's Localekey
- Message key to be looked up and returnedjavax.servlet.jsp.JspException
- if a lookup error occurs (will have been
saved in the request already)public static java.lang.String pageURL(javax.servlet.http.HttpServletRequest request, java.lang.String page)
TagUtils.pageURL(HttpServletRequest request, String page, ModuleConfig moduleConfig)
instead.
This will be removed after Struts 1.2.
Return the context-relative URL that corresponds to the specified
page
attribute value, calculated based on the
pagePattern
property of the current module's
ModuleConfig
.
request
- The servlet request we are processingpage
- The module-relative URL to be substituted in
to the pagePattern
pattern for the current module
(MUST start with a slash)public static void saveException(javax.servlet.jsp.PageContext pageContext, java.lang.Throwable exception)
TagUtils.saveException(PageContext,Throwable)
instead.
This will be removed after Struts 1.2.
Save the specified exception as a request attribute for later use.
pageContext
- The PageContext for the current pageexception
- The exception to be savedpublic static ModuleConfig getModuleConfig(javax.servlet.jsp.PageContext pageContext)
TagUtils.getModuleConfig(PageContext)
instead.
This will be removed after Struts 1.2.
Return the ModuleConfig
object if it exists, null if otherwise.
pageContext
- The page context.public static ActionMessages getActionMessages(javax.servlet.jsp.PageContext pageContext, java.lang.String paramName) throws javax.servlet.jsp.JspException
TagUtils.getActionMessages(PageContext,String)
instead.
This will be removed after Struts 1.2.
Retrieves the value from request scope and if it isn't already an
ActionMessages
some classes are converted to one.
pageContext
- The PageContext for the current pageparamName
- Key for parameter valuejavax.servlet.jsp.JspException
- public static ActionErrors getActionErrors(javax.servlet.jsp.PageContext pageContext, java.lang.String paramName) throws javax.servlet.jsp.JspException
TagUtils.getActionErrors(PageContext,String)
instead.
This will be removed after Struts 1.2.
Retrieves the value from request scope and if it isn't already an
ErrorMessages
some classes are converted to one.
pageContext
- The PageContext for the current pageparamName
- Key for parameter valuejavax.servlet.jsp.JspException
- public static java.lang.String encodeURL(java.lang.String url)
TagUtils.encodeURL(String)
instead.
This will be removed after Struts 1.2.
Use the new URLEncoder.encode
method from Java 1.4 if available, else
use the old deprecated version. This method uses reflection to find the appropriate
method; if the reflection operations throw exceptions, this will return the url
encoded with the old URLEncoder.encode
method.
public static boolean isXhtml(javax.servlet.jsp.PageContext pageContext)
TagUtils.isXhtml(PageContext)
instead.
This will be removed after Struts 1.2.
Returns true if the custom tags are in XHTML mode.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |