org.jwarp.service.web.cache
Class CacheableResponse

org.jwarp.service.web.cache.CacheableResponse

All Implemented Interfaces:

ICacheableResponse

public class CacheableResponse

implements ICacheableResponse

Field Summary

(package private) int	contentLength
(package private) java.lang.String	contentType
(package private) java.util.List	cookies
(package private) java.util.Hashtable	dateHeaders
static int	ERROR
(package private) java.util.Hashtable	headers
(package private) java.util.Hashtable	intHeaders
(package private) boolean	isCacheable
(package private) java.util.Locale	locale
(package private) java.lang.String	message
static int	NORMAL
static int	REDIRECT
(package private) javax.servlet.http.HttpServletResponse	response
(package private) java.util.Hashtable	setdateHeaders
(package private) java.util.Hashtable	setheaders
(package private) java.util.Hashtable	setintHeaders
(package private) int	status
(package private) java.io.StringWriter	sw
(package private) int	type
(package private) java.lang.String	value
(package private) java.io.PrintWriter	writer

Constructor Summary

CacheableResponse(javax.servlet.http.HttpServletResponse res)

Method Summary

void	addCookie(javax.servlet.http.Cookie cookie)
void	addDateHeader(java.lang.String name, long date)
void	addHeader(java.lang.String name, java.lang.String value)
void	addIntHeader(java.lang.String name, int value)
boolean	containsHeader(java.lang.String name)
void	copyData(javax.servlet.http.HttpServletResponse res) Get a representaion object for this response.
java.lang.String	encodeRedirectUrl(java.lang.String url)
java.lang.String	encodeRedirectURL(java.lang.String url)
java.lang.String	encodeUrl(java.lang.String url)
java.lang.String	encodeURL(java.lang.String url)
void	flushBuffer()
int	getBufferSize()
java.lang.String	getCharacterEncoding()
java.util.Locale	getLocale()
javax.servlet.ServletOutputStream	getOutputStream()
java.io.PrintWriter	getWriter()
boolean	isCommitted()
void	reset()
void	sendError(int sc)
void	sendError(int sc, java.lang.String msg)
void	sendRedirect(java.lang.String location)
void	setBufferSize(int size)
void	setContentLength(int len)
void	setContentType(java.lang.String type)
void	setDateHeader(java.lang.String name, long date)
void	setHeader(java.lang.String name, java.lang.String value)
void	setIntHeader(java.lang.String name, int value)
void	setLocale(java.util.Locale l)
void	setStatus(int sc)
void	setStatus(int sc, java.lang.String sm)

Field Detail

NORMAL

public static final int NORMAL

REDIRECT

public static final int REDIRECT

ERROR

public static final int ERROR

isCacheable

boolean isCacheable

response

javax.servlet.http.HttpServletResponse response

contentType

java.lang.String contentType

contentLength

int contentLength

sw

java.io.StringWriter sw

writer

java.io.PrintWriter writer

type

int type

value

java.lang.String value

locale

java.util.Locale locale

status

int status

message

java.lang.String message

cookies

java.util.List cookies

dateHeaders

java.util.Hashtable dateHeaders

intHeaders

java.util.Hashtable intHeaders

headers

java.util.Hashtable headers

setdateHeaders

java.util.Hashtable setdateHeaders

setintHeaders

java.util.Hashtable setintHeaders

setheaders

java.util.Hashtable setheaders

Constructor Detail

CacheableResponse

public CacheableResponse(javax.servlet.http.HttpServletResponse res)

Method Detail

addCookie

public void addCookie(javax.servlet.http.Cookie cookie)

containsHeader

public boolean containsHeader(java.lang.String name)

encodeURL

public java.lang.String encodeURL(java.lang.String url)

encodeRedirectURL

public java.lang.String encodeRedirectURL(java.lang.String url)

encodeUrl

public java.lang.String encodeUrl(java.lang.String url)

encodeRedirectUrl

public java.lang.String encodeRedirectUrl(java.lang.String url)

sendError

public void sendError(int sc,
                      java.lang.String msg)
               throws java.io.IOException

sendError

public void sendError(int sc)
               throws java.io.IOException

sendRedirect

public void sendRedirect(java.lang.String location)
                  throws java.io.IOException

setDateHeader

public void setDateHeader(java.lang.String name,
                          long date)

addDateHeader

public void addDateHeader(java.lang.String name,
                          long date)

setHeader

public void setHeader(java.lang.String name,
                      java.lang.String value)

addHeader

public void addHeader(java.lang.String name,
                      java.lang.String value)

setIntHeader

public void setIntHeader(java.lang.String name,
                         int value)

addIntHeader

public void addIntHeader(java.lang.String name,
                         int value)

setStatus

public void setStatus(int sc)

setStatus

public void setStatus(int sc,
                      java.lang.String sm)

getCharacterEncoding

public java.lang.String getCharacterEncoding()

getOutputStream

public javax.servlet.ServletOutputStream getOutputStream()
                                                  throws java.io.IOException

getWriter

public java.io.PrintWriter getWriter()
                              throws java.io.IOException

setContentLength

public void setContentLength(int len)

setContentType

public void setContentType(java.lang.String type)

setBufferSize

public void setBufferSize(int size)

getBufferSize

public int getBufferSize()

getLocale

public java.util.Locale getLocale()

setLocale

public void setLocale(java.util.Locale l)

flushBuffer

public void flushBuffer()
                 throws java.io.IOException

isCommitted

public boolean isCommitted()

reset

public void reset()

copyData

public void copyData(javax.servlet.http.HttpServletResponse res)
              throws java.io.IOException

Description copied from interface: ICacheableResponse

Get a representaion object for this response. The representation object must contain all data needed for generating a full response. This representation object then will be cached for accelerating any web access.

Specified by:

copyData in interface ICacheableResponse

Following copied from interface: org.jwarp.service.web.cache.ICacheableResponse

Parameters:

res - The http respnse to be set with the cached data.

Throws:

java.io.IOException - If something went wrong