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 setUncacheable(boolean value)
          This sets the page to be uncachebale
 
Methods inherited from interface javax.servlet.http.HttpServletRequest
getAuthType, getContextPath, getCookies, getDateHeader, getHeader, getHeaderNames, getHeaders, getIntHeader, getMethod, getPathInfo, getPathTranslated, getQueryString, getRemoteUser, getRequestedSessionId, getRequestURI, getRequestURL, getServletPath, getSession, getSession, getUserPrincipal, isRequestedSessionIdFromCookie, isRequestedSessionIdFromUrl, isRequestedSessionIdFromURL, isRequestedSessionIdValid, isUserInRole
 
Methods inherited from interface javax.servlet.ServletRequest
getAttributeNames, getCharacterEncoding, getContentLength, getContentType, getInputStream, getLocale, getLocales, getParameter, getParameterMap, getParameterNames, getParameterValues, getProtocol, getReader, getRealPath, getRemoteAddr, getRemoteHost, getRequestDispatcher, getScheme, getServerName, getServerPort, isSecure, removeAttribute, setCharacterEncoding
 

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 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

public 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

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

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

isUncacheable

public 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.

 

WebSphere is a trademark of the IBM Corporation in the United States, other countries, or both.

 

IBM is a trademark of the IBM Corporation in the United States, other countries, or both.