public class PageWebResourceRequest extends HttpServletRequestWrapper implements IPageWebResourceRequest
IServiceInterfaceRequest implementation that is used by the service container.| Modifier and Type | Field and Description |
|---|---|
protected IPortalMode |
mode |
BASIC_AUTH, CLIENT_CERT_AUTH, DIGEST_AUTH, FORM_AUTH| Constructor and Description |
|---|
PageWebResourceRequest(SessionConfig sessionConfig,
PageWebResource webResource,
HttpServletRequest request,
Map<String,FileParameter> fileParameters) |
| Modifier and Type | Method and Description |
|---|---|
String |
getApplicationRequestedPath()
Returns the path requested by the browser relative to the current
website base URL. |
Object |
getAttribute(String key)
Returns the value of the named attribute as an
Object, or null if no attribute of the
given name exists. |
Enumeration<String> |
getAttributeNames()
Returns an
Enumeration containing the names of the attributes available to this request. |
IBusinessContext |
getBusinessContext()
Returns the business context for this request.
|
Cookie |
getCookie(String cookieName)
Returns the requested cookie or
null if the cookie does not exist in request. |
FileParameter |
getFileParameter(String parameterName)
Returns the uploaded file by the given parameter name.
|
PageWebResource |
getPageWebResource()
Returns the
PageWebResource of this request. |
String |
getParameter(String name)
Returns the value of a request parameter as a
String, or null if the parameter does not
exist. |
Map<String,String[]> |
getParameterMap()
Returns a
Map of the parameters of this request. |
Enumeration<String> |
getParameterNames()
Returns an
Enumeration of String objects containing the names of the parameters
contained in this request. |
String[] |
getParameterValues(String name)
Returns an array of
String objects containing all of the values the given request parameter has, or
null if the parameter does not exist. |
IPortalMode |
getPortalMode()
Returns the requested portal mode.
|
SessionConfig |
getSessionConfig()
Returns the session of the user that has performed the request.
|
IWebsiteBaseURL |
getWebsiteBaseURL()
Returns the website's base URL accessed to generate this request.
|
boolean |
isPageCachedInFile()
Returns whether the requested page is cached in file.
|
boolean |
isPreview()
Returns whether the request is in preview mode.
|
void |
removeAttribute(String key)
Removes an attribute from this request.
|
void |
setAttribute(String key,
Object value)
Stores an attribute in this request.
|
protected void |
setPageWebResource(PageWebResource pageWebResource)
Sets the page web resource.
|
authenticate, getAuthType, getContextPath, getCookies, getDateHeader, getHeader, getHeaderNames, getHeaders, getIntHeader, getMethod, getPart, getParts, getPathInfo, getPathTranslated, getQueryString, getRemoteUser, getRequestedSessionId, getRequestURI, getRequestURL, getServletPath, getSession, getSession, getUserPrincipal, isRequestedSessionIdFromCookie, isRequestedSessionIdFromUrl, isRequestedSessionIdFromURL, isRequestedSessionIdValid, isUserInRole, login, logoutgetAsyncContext, getCharacterEncoding, getContentLength, getContentType, getDispatcherType, getInputStream, getLocalAddr, getLocale, getLocales, getLocalName, getLocalPort, getProtocol, getReader, getRealPath, getRemoteAddr, getRemoteHost, getRemotePort, getRequest, getRequestDispatcher, getScheme, getServerName, getServerPort, getServletContext, isAsyncStarted, isAsyncSupported, isSecure, isWrapperFor, isWrapperFor, setCharacterEncoding, setRequest, startAsync, startAsyncclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitgetContextPath, getCookies, getHeader, getScheme, getServerName, getServerPort, isSecuregetAsyncContext, getCharacterEncoding, getContentLength, getContentType, getDispatcherType, getInputStream, getLocalAddr, getLocale, getLocales, getLocalName, getLocalPort, getProtocol, getReader, getRealPath, getRemoteAddr, getRemoteHost, getRemotePort, getRequestDispatcher, getScheme, getServerName, getServerPort, getServletContext, isAsyncStarted, isAsyncSupported, isSecure, setCharacterEncoding, startAsync, startAsyncprotected IPortalMode mode
public PageWebResourceRequest(SessionConfig sessionConfig, PageWebResource webResource, HttpServletRequest request, Map<String,FileParameter> fileParameters)
public String getParameter(String name)
IPageWebResourceRequestString, or null if the parameter does not
exist. Request parameters are extra information sent with the request. The returned parameter are
"x-www-form-urlencoded" decoded.
This method should only be used if the parameter has only one value. If the parameter might have more than one
value, use IPageWebResourceRequest.getParameterValues(java.lang.String).
If this method is used with a multivalued parameter, the value returned is equal to the first value in the array
returned by getParameterValues.
getParameter in interface ServletRequestgetParameter in interface IPageWebResourceRequestgetParameter in class ServletRequestWrappername - a String specifying the name of the parameterString representing the single value of the parameterIPageWebResourceRequest.getParameterValues(java.lang.String)public Enumeration<String> getParameterNames()
IPageWebResourceRequestEnumeration of String objects containing the names of the parameters
contained in this request. If the request has no parameters, the method returns an empty Enumeration
.getParameterNames in interface ServletRequestgetParameterNames in interface IPageWebResourceRequestgetParameterNames in class ServletRequestWrapperEnumeration of String objects, each String containing the name
of a request parameter; or an empty Enumeration if the request has no parameters.public String[] getParameterValues(String name)
IPageWebResourceRequestString objects containing all of the values the given request parameter has, or
null if the parameter does not exist. The returned parameters are "x-www-form-urlencoded" decoded.
If the parameter has a single value, the array has a length of 1.
getParameterValues in interface ServletRequestgetParameterValues in interface IPageWebResourceRequestgetParameterValues in class ServletRequestWrappername - a String containing the name of the parameter the value of which is requestedString objects containing the parameter values.IPageWebResourceRequest.getParameter(java.lang.String)public Map<String,String[]> getParameterMap()
IPageWebResourceRequestMap of the parameters of this request. Request parameters are extra information sent with
the request. The returned parameters are "x-www-form-urlencoded" decoded.
The values in the returned Map are from type String array (String[]).
If no parameters exist this method returns an empty Map.
getParameterMap in interface ServletRequestgetParameterMap in interface IPageWebResourceRequestgetParameterMap in class ServletRequestWrapperMap containing parameter names as keys and parameter values as map values, or
an empty Map if no parameters exist. The keys in the parameter map are of type String. The
values in the parameter map are of type String array (String[]).public Enumeration<String> getAttributeNames()
IPageWebResourceRequestEnumeration containing the names of the attributes available to this request. This method
returns an empty Enumeration if the request has no attributes available to it.getAttributeNames in interface ServletRequestgetAttributeNames in interface IPageWebResourceRequestgetAttributeNames in class ServletRequestWrapperEnumeration of strings containing the names of the request attributes, or an empty
Enumeration if the request has no attributes available to it.public Object getAttribute(String key)
IPageWebResourceRequestObject, or null if no attribute of the
given name exists.getAttribute in interface ServletRequestgetAttribute in interface IPageWebResourceRequestgetAttribute in class ServletRequestWrapperkey - a String specifying the name of the attributeObject containing the value of the attribute, or null if the attribute does
not exist.public void setAttribute(String key, Object value)
IPageWebResourceRequestsetAttribute in interface ServletRequestsetAttribute in interface IPageWebResourceRequestsetAttribute in class ServletRequestWrapperkey - a String specifying the name of the attributevalue - the Object to be storedpublic void removeAttribute(String key)
IPageWebResourceRequestremoveAttribute in interface ServletRequestremoveAttribute in interface IPageWebResourceRequestremoveAttribute in class ServletRequestWrapperkey - a String specifying the name of the attribute to be removedpublic PageWebResource getPageWebResource()
IPageWebResourceRequestPageWebResource of this request.getPageWebResource in interface IPageWebResourceRequestPageWebResource of this request.public IWebsiteBaseURL getWebsiteBaseURL()
IPageWebResourceRequestgetWebsiteBaseURL in interface IPageWebResourceRequestpublic SessionConfig getSessionConfig()
IPageWebResourceRequestgetSessionConfig in interface IPageWebResourceRequestpublic Cookie getCookie(String cookieName)
IPageWebResourceRequestnull if the cookie does not exist in request.getCookie in interface IPageWebResourceRequestcookieName - the requested cookie name.null if the cookie does not exist in request.public FileParameter getFileParameter(String parameterName)
IPageWebResourceRequestgetFileParameter in interface IPageWebResourceRequestparameterName - the parameter name.public boolean isPreview()
IPageWebResourceRequestisPreview in interface IPageWebResourceRequestpublic IBusinessContext getBusinessContext()
IPageWebResourceRequestgetBusinessContext in interface IPageWebResourceRequestpublic IPortalMode getPortalMode()
IPageWebResourceRequestgetPortalMode in interface IPageWebResourceRequestpublic boolean isPageCachedInFile()
IPageWebResourceRequestisPageCachedInFile in interface IPageWebResourceRequestpublic String getApplicationRequestedPath()
IPageWebResourceRequestwebsite base URL.getApplicationRequestedPath in interface IPageWebResourceRequestwebsite base URL.protected void setPageWebResource(PageWebResource pageWebResource)
pageWebResource - the page web resource.LumisXP 12.3.0.200408 - Copyright © 2006–2020 Lumis EIP Tecnologia da Informação LTDA. All Rights Reserved.