IBM WebSphere Application ServerTM
Release 8

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 interface is a proxy for the WebSphere request object. It has features added to enable caching.


Field Summary
 
Fields inherited from interface javax.servlet.http.HttpServletRequest
BASIC_AUTH, CLIENT_CERT_AUTH, DIGEST_AUTH, FORM_AUTH
 
Method Summary
 java.lang.Object getAttribute(java.lang.String key)
          This returns the request attribute with the specified key.
 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.
 boolean isUncacheable()
          This returns true if the page is uncacheable
 void setAttribute(java.lang.String key, java.lang.Object value)
          This sets the request attribute key-value pair.
 void setGeneratingId(boolean b)
          This method prepares the javax.servlet.ServletInputStream to be read by the IdGenerator.
 void setUncacheable(boolean value)
          This sets the page to be uncachebale
 
Methods inherited from interface javax.servlet.http.HttpServletRequest
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, logout
 
Methods inherited from interface javax.servlet.ServletRequest
getAsyncContext, getAttributeNames, getCharacterEncoding, getContentLength, getContentType, getDispatcherType, getInputStream, getLocalAddr, getLocale, getLocales, getLocalName, getLocalPort, getParameter, getParameterMap, getParameterNames, getParameterValues, getProtocol, getReader, getRealPath, getRemoteAddr, getRemoteHost, getRemotePort, getRequestDispatcher, getScheme, getServerName, getServerPort, getServletContext, isAsyncStarted, isAsyncSupported, isSecure, removeAttribute, setCharacterEncoding, startAsync, startAsync
 

Method Detail

getFragmentInfo

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

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

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

java.lang.Object getAttribute(java.lang.String key)
This returns the request attribute with the specified key. It overrides the method in the WebSphere request.

Specified by:
getAttribute in interface javax.servlet.ServletRequest
Parameters:
key - The attribute key.
Returns:
The attribute value.

setAttribute

void setAttribute(java.lang.String key,
                  java.lang.Object value)
This sets the request attribute key-value pair. It overrides the method in the WebSphere request.

Specified by:
setAttribute in interface javax.servlet.ServletRequest
Parameters:
key - The attribute key.
value - The attribute value.

setUncacheable

void setUncacheable(boolean value)
This sets the page to be uncachebale

Parameters:
value - True if the page is to be set as uncacheable

isUncacheable

boolean isUncacheable()
This returns true if the page is uncacheable

Returns:
True indicates that the fragment is uncacheable and false indicates that the fragment is cacheable.

setGeneratingId

void setGeneratingId(boolean b)
This method prepares the javax.servlet.ServletInputStream to be read by the IdGenerator.
 Usage example: 
   servletCacheRequest.setGeneratingId(true);
   InputStream in = servletCacheRequest.getInputStream();
              :
   servletCacheRequest.setGeneratingId(false);
 

Parameters:
b - True or false

IBM WebSphere Application ServerTM
Release 8