|
Oracle Fusion Middleware Java API for Oracle WebLogic Portal 10g Release 3 (10.3.2) E14255-01 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object
javax.servlet.ServletRequestWrapper
javax.servlet.http.HttpServletRequestWrapper
org.apache.beehive.netui.pageflow.scoping.internal.ScopedRequestImpl
public class ScopedRequestImpl
A wrapper around HttpServletRequest, associated with a given scope-key. All calls to setAttribute, getAttribute, removeAttribute, etc. are scoped to this object, while most other functionality delegates to the wrapped HttpServletRequest. Instances of this class also keep track of their own request-URIs, which are independent of the wrapped request-URIs.
Field Summary |
---|
Fields inherited from interface org.apache.beehive.netui.pageflow.scoping.ScopedRequest |
---|
AUTOSCOPE_PREFIX |
Fields inherited from interface javax.servlet.http.HttpServletRequest |
---|
BASIC_AUTH, CLIENT_CERT_AUTH, DIGEST_AUTH, FORM_AUTH |
Constructor Summary | |
---|---|
ScopedRequestImpl(javax.servlet.http.HttpServletRequest req, String overrideRequestURI, Object scopeKey, javax.servlet.ServletContext context) Deprecated Use ScopedRequestImpl(HttpServletRequest, String, Object, ServletContext, boolean) . |
|
ScopedRequestImpl(javax.servlet.http.HttpServletRequest req, String overrideRequestURI, Object scopeKey, javax.servlet.ServletContext servletContext, boolean seeOuterRequestAttributes) |
Method Summary | |
---|---|
void |
addListenScope(Object scopeKey) Adds a scope to "listen" to. |
void |
addParameter(String name, String value) Add a parameter to the request. |
boolean |
didRedirect() Deprecated Use ScopedResponseImpl.didRedirect() instead. |
void |
doForward() |
Object |
getAttribute(String attrName) |
Object |
getAttribute(String attrName, boolean allowOuterRequestAttributes) Same as getAttribute , but allows outer request attributes to be hidden explicitly, even if the implementation of getAttribute shows them by default. |
Map |
getAttributeMap() Get the current map of request attributes. |
Enumeration |
getAttributeNames() |
String |
getForwardedURI() |
String |
getListenScopeParameter(String paramName) Get the parameter from the listen scoped requests |
String |
getLocalParameter(String paramName) Get the parameter from the scoped request only (don't check in listen scoped requests) |
List |
getNamesOfRemovableAttributes() Returns names of attributes that do not need to be saved in a session or restored later for a follow up refresh request. |
javax.servlet.http.HttpServletRequest |
getOuterRequest() |
String |
getParameter(String paramName) |
Map |
getParameterMap() |
Enumeration |
getParameterNames() |
String[] |
getParameterValues(String paramName) |
String |
getPathInfo() |
javax.servlet.RequestDispatcher |
getRequestDispatcher(String uri) |
String |
getRequestedSessionId() |
String |
getRequestURI() |
StringBuffer |
getRequestURL() |
String |
getScopedName(String baseName) |
Object |
getScopeKey() |
String |
getServletPath() |
boolean |
hasListenScopes() see if this scoped request is listening to any other scoped request |
void |
persistAttributes() Deprecated Moved the persisting of attributes out of the beehive NetUI layer. Use getAttributeMap() to get the attributes. |
void |
registerOuterAttribute(String attrName) |
void |
removeAttribute(String attrName) |
void |
renameScope(Object newScopeKey) |
static void |
renameSessionScope(Object oldScopeKey, Object newScopeKey, javax.servlet.http.HttpServletRequest outerRequest) |
void |
restoreAttributes() Deprecated Moved the persisting of attributes out of the beehive NetUI layer. Use setAttributeMap(java.util.Map) to set/merge the attributes. |
void |
setActiveRequest() Makes this request listen to specially-prefixed request parameters. |
void |
setAttribute(String attrName, Object o) |
void |
setAttributeMap(Map savedAttrs) Set/merge the map of request attributes from a given map. |
void |
setForwardedURI(String uri) Simply stores the URI that was being forwarded to. |
void |
setPathInfo(String pathInfo) |
void |
setRequestURI(String uri) |
void |
setRequestURI(String contextPath, String servletPath) |
Methods inherited from class javax.servlet.http.HttpServletRequestWrapper |
---|
getAuthType, getContextPath, getCookies, getDateHeader, getHeader, getHeaderNames, getHeaders, getIntHeader, getMethod, getPathTranslated, getQueryString, getRemoteUser, getSession, getSession, getUserPrincipal, isRequestedSessionIdFromCookie, isRequestedSessionIdFromUrl, isRequestedSessionIdFromURL, isRequestedSessionIdValid, isUserInRole |
Methods inherited from class javax.servlet.ServletRequestWrapper |
---|
getCharacterEncoding, getContentLength, getContentType, getInputStream, getLocalAddr, getLocale, getLocales, getLocalName, getLocalPort, getProtocol, getReader, getRealPath, getRemoteAddr, getRemoteHost, getRemotePort, getRequest, getScheme, getServerName, getServerPort, isSecure, setCharacterEncoding, setRequest |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface javax.servlet.http.HttpServletRequest |
---|
getAuthType, getContextPath, getCookies, getDateHeader, getHeader, getHeaderNames, getHeaders, getIntHeader, getMethod, getPathTranslated, getQueryString, getRemoteUser, getSession, getSession, getUserPrincipal, isRequestedSessionIdFromCookie, isRequestedSessionIdFromUrl, isRequestedSessionIdFromURL, isRequestedSessionIdValid, isUserInRole |
Methods inherited from interface javax.servlet.ServletRequest |
---|
getCharacterEncoding, getContentLength, getContentType, getInputStream, getLocalAddr, getLocale, getLocales, getLocalName, getLocalPort, getProtocol, getReader, getRealPath, getRemoteAddr, getRemoteHost, getRemotePort, getScheme, getServerName, getServerPort, isSecure, setCharacterEncoding |
Constructor Detail |
---|
public ScopedRequestImpl(javax.servlet.http.HttpServletRequest req, String overrideRequestURI, Object scopeKey, javax.servlet.ServletContext servletContext, boolean seeOuterRequestAttributes)
public ScopedRequestImpl(javax.servlet.http.HttpServletRequest req, String overrideRequestURI, Object scopeKey, javax.servlet.ServletContext context)
ScopedRequestImpl(HttpServletRequest, String, Object, ServletContext, boolean)
.Method Detail |
---|
public String getRequestedSessionId()
getRequestedSessionId
in interface javax.servlet.http.HttpServletRequest
getRequestedSessionId
in class javax.servlet.http.HttpServletRequestWrapper
public String getRequestURI()
getRequestURI
in interface javax.servlet.http.HttpServletRequest
getRequestURI
in class javax.servlet.http.HttpServletRequestWrapper
public void setRequestURI(String uri)
setRequestURI
in interface ScopedRequest
public void setRequestURI(String contextPath, String servletPath)
public StringBuffer getRequestURL()
getRequestURL
in interface javax.servlet.http.HttpServletRequest
getRequestURL
in class javax.servlet.http.HttpServletRequestWrapper
public String getServletPath()
getServletPath
in interface javax.servlet.http.HttpServletRequest
getServletPath
in class javax.servlet.http.HttpServletRequestWrapper
public String getParameter(String paramName)
getParameter
in interface javax.servlet.ServletRequest
getParameter
in class javax.servlet.ServletRequestWrapper
public void addParameter(String name, String value)
name
- the parameter name.value
- the parameter value.public String getLocalParameter(String paramName)
getLocalParameter
in interface ScopedRequest
paramName
-public String getListenScopeParameter(String paramName)
getListenScopeParameter
in interface ScopedRequest
paramName
-public Enumeration getParameterNames()
getParameterNames
in interface javax.servlet.ServletRequest
getParameterNames
in class javax.servlet.ServletRequestWrapper
public String[] getParameterValues(String paramName)
getParameterValues
in interface javax.servlet.ServletRequest
getParameterValues
in class javax.servlet.ServletRequestWrapper
public Map getParameterMap()
getParameterMap
in interface javax.servlet.ServletRequest
getParameterMap
in class javax.servlet.ServletRequestWrapper
public void addListenScope(Object scopeKey)
addListenScope
in interface ScopedRequest
public javax.servlet.RequestDispatcher getRequestDispatcher(String uri)
getRequestDispatcher
in interface javax.servlet.ServletRequest
getRequestDispatcher
in class javax.servlet.ServletRequestWrapper
public void doForward()
doForward
in interface ScopedRequest
public void setForwardedURI(String uri)
setForwardedURI
in interface ScopedRequest
uri
-public String getForwardedURI()
getForwardedURI
in interface ScopedRequest
public boolean didRedirect()
ScopedResponseImpl.didRedirect()
instead.didRedirect
in interface ScopedRequest
public void persistAttributes()
getAttributeMap()
to get the attributes.persistAttributes
in interface ScopedRequest
public void restoreAttributes()
setAttributeMap(java.util.Map)
to set/merge the attributes.restoreAttributes
in interface ScopedRequest
public Map getAttributeMap()
getAttributeMap
in interface ScopedRequest
public void setAttributeMap(Map savedAttrs)
setAttributeMap
in interface ScopedRequest
savedAttrs
- the Map of attributes to set or merge with the current map of request attributespublic List getNamesOfRemovableAttributes()
getNamesOfRemovableAttributes
in interface ScopedRequest
public final javax.servlet.http.HttpServletRequest getOuterRequest()
getOuterRequest
in interface ScopedRequest
public final Object getAttribute(String attrName)
getAttribute
in interface javax.servlet.ServletRequest
getAttribute
in class javax.servlet.ServletRequestWrapper
public final Object getAttribute(String attrName, boolean allowOuterRequestAttributes)
ScopedRequest
getAttribute
, but allows outer request attributes to be hidden explicitly, even if the implementation of getAttribute shows them by default.getAttribute
in interface ScopedRequest
public final void setAttribute(String attrName, Object o)
setAttribute
in interface javax.servlet.ServletRequest
setAttribute
in class javax.servlet.ServletRequestWrapper
public final Enumeration getAttributeNames()
getAttributeNames
in interface javax.servlet.ServletRequest
getAttributeNames
in class javax.servlet.ServletRequestWrapper
public final void removeAttribute(String attrName)
removeAttribute
in interface javax.servlet.ServletRequest
removeAttribute
in class javax.servlet.ServletRequestWrapper
public void registerOuterAttribute(String attrName)
registerOuterAttribute
in interface ScopedRequest
public final Object getScopeKey()
getScopeKey
in interface ScopedRequest
public void renameScope(Object newScopeKey)
renameScope
in interface ScopedRequest
public static void renameSessionScope(Object oldScopeKey, Object newScopeKey, javax.servlet.http.HttpServletRequest outerRequest)
public String getPathInfo()
getPathInfo
in interface javax.servlet.http.HttpServletRequest
getPathInfo
in class javax.servlet.http.HttpServletRequestWrapper
public void setPathInfo(String pathInfo)
public void setActiveRequest()
setActiveRequest
in interface ScopedRequest
public final String getScopedName(String baseName)
getScopedName
in interface ScopedRequest
public boolean hasListenScopes()
hasListenScopes
in interface ScopedRequest
|
Oracle Fusion Middleware Java API for Oracle WebLogic Portal 10g Release 3 (10.3.2) E14255-01 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Copyright © 2010, Oracle. All rights reserved.