com.ibm.websphere.servlet.cache
Interface ServletCacheRequest

All Superinterfaces:
javax.servlet.http.HttpServletRequest, javax.servlet.ServletRequest

public interface ServletCacheRequest
extends javax.servlet.http.HttpServletRequest

This class is a proxy for the WebSphere request object. It has features added to enable caching.


Method Summary
 java.lang.Object getAttribute(java.lang.String key)
          This overrides the method in the WebSphere request.
 java.util.Hashtable getAttributeTable()
          This returns a Hashtable containing the request attributes as they were just prior to exectuion of the entry.
 FragmentInfo getFragmentInfo()
          This returns the FragmentInfo for this entry, which contains the caching metadata for the entry.
 boolean getInclude()
          This gets the include variable.
 void setAttribute(java.lang.String key, java.lang.Object value)
          This overrides the method in the WebSphere request.
 
Methods inherited from interface javax.servlet.http.HttpServletRequest
getAuthType, getContextPath, getCookies, getDateHeader, getHeader, getHeaderNames, getHeaders, getIntHeader, getMethod, getPathInfo, getPathTranslated, getQueryString, getRemoteUser, getRequestedSessionId, getRequestURI, getServletPath, getSession, getSession, getUserPrincipal, isRequestedSessionIdFromCookie, isRequestedSessionIdFromUrl, isRequestedSessionIdFromURL, isRequestedSessionIdValid, isUserInRole
 
Methods inherited from interface javax.servlet.ServletRequest
getAttributeNames, getCharacterEncoding, getContentLength, getContentType, getInputStream, getLocale, getLocales, getParameter, getParameterNames, getParameterValues, getProtocol, getReader, getRealPath, getRemoteAddr, getRemoteHost, getRequestDispatcher, getScheme, getServerName, getServerPort, isSecure, removeAttribute
 

Method Detail

getFragmentInfo

public FragmentInfo getFragmentInfo()
This returns the FragmentInfo for this entry, which contains the caching metadata for the entry.
Returns:
The caching metadata for this entry.

getInclude

public boolean getInclude()
This gets the include variable.
Returns:
True indicates that the include call was used to create this fragment. False indicates that the forward call was used.

getAttributeTable

public java.util.Hashtable getAttributeTable()
This returns a Hashtable containing the request attributes as they were just prior to exectuion of the entry. It also creates the Hashtable if it did not already exist.
Returns:
The hashtable of attributes.

getAttribute

public java.lang.Object getAttribute(java.lang.String key)
This overrides the method in the WebSphere request. It returns the request attribute with the specified key.
Specified by:
getAttribute in interface javax.servlet.ServletRequest
Parameters:
key - The attribute key.
Returns:
The attribute value.

setAttribute

public void setAttribute(java.lang.String key,
                         java.lang.Object value)
This overrides the method in the WebSphere request. It returns sets request attribute key-value pair.
Specified by:
setAttribute in interface javax.servlet.ServletRequest
Parameters:
key - The attribute key.
value - The attribute value.