Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

com.opensymphony.oscache.web.filter
Class ResponseContent

java.lang.Object
  extended by com.opensymphony.oscache.web.filter.ResponseContent
All Implemented Interfaces:
Serializable
public class ResponseContent
extends Object
implements Serializable

Holds the servlet response in a byte array so that it can be held in the cache (and, since this class is serializable, optionally persisted to disk).

Version:
$Revision: 486 $
Author:
Serge Knystautas
See Also:
Serialized Form

Constructor Summary
ResponseContent()
           
 
Method Summary
 void commit()
          Called once the response has been written in its entirety.
 String getContentDisposition()
           
 String getContentEncoding()
           
 String getContentType()
           
 String getETag()
           
 long getExpires()
           
 long getLastModified()
           
 long getMaxAge()
          Returns the max age of the content in milliseconds.
 OutputStream getOutputStream()
          Get an output stream.
 int getSize()
          Gets the size of this cached content.
 boolean isContentGZiped()
           
 void setContentDisposition(String contentDisposition)
           
 void setContentEncoding(String contentEncoding)
           
 void setContentType(String value)
          Set the content type.
 void setETag(String etag)
           
 void setExpires(long value)
          Sets the expires date and time in milliseconds.
 void setLastModified(long value)
           
 void setLocale(Locale value)
          Set the Locale.
 void setMaxAge(long value)
          Sets the max age date and time in milliseconds.
 void writeTo(ServletResponse response)
          Writes this cached data out to the supplied ServletResponse.
 void writeTo(ServletResponse response, boolean fragment, boolean acceptsGZip)
          Writes this cached data out to the supplied ServletResponse.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ResponseContent

public ResponseContent()
Method Detail

getContentType

public String getContentType()

setContentType

public void setContentType(String value)
Set the content type. We capture this so that when we serve this data from cache, we can set the correct content type on the response.

getLastModified

public long getLastModified()

setLastModified

public void setLastModified(long value)

getContentEncoding

public String getContentEncoding()

setContentEncoding

public void setContentEncoding(String contentEncoding)

getETag

public String getETag()

setETag

public void setETag(String etag)

getContentDisposition

public String getContentDisposition()

setContentDisposition

public void setContentDisposition(String contentDisposition)

setLocale

public void setLocale(Locale value)
Set the Locale. We capture this so that when we serve this data from cache, we can set the correct locale on the response.

getExpires

public long getExpires()
Returns:
the expires date and time in milliseconds when the content will be stale

setExpires

public void setExpires(long value)
Sets the expires date and time in milliseconds.

Parameters:
value - time in milliseconds when the content will expire

getMaxAge

public long getMaxAge()
Returns the max age of the content in milliseconds. If expires header and cache control are enabled both, both will be equal.

Returns:
the max age of the content in milliseconds, if -1 max-age is disabled

setMaxAge

public void setMaxAge(long value)
Sets the max age date and time in milliseconds. If the parameter is -1, the max-age parameter won't be set by default in the Cache-Control header.

Parameters:
value - sets the intial

getOutputStream

public OutputStream getOutputStream()
Get an output stream. This is used by the SplitServletOutputStream to capture the original (uncached) response into a byte array.

Returns:
the original (uncached) response, returns null if response is already committed.

getSize

public int getSize()
Gets the size of this cached content.

Returns:
The size of the content, in bytes. If no content exists, this method returns -1.

commit

public void commit()
Called once the response has been written in its entirety. This method commits the response output stream by converting the output stream into a byte array.

writeTo

public void writeTo(ServletResponse response)
             throws IOException
Writes this cached data out to the supplied ServletResponse.

Parameters:
response - The servlet response to output the cached content to.
Throws:
IOException

writeTo

public void writeTo(ServletResponse response,
                    boolean fragment,
                    boolean acceptsGZip)
             throws IOException
Writes this cached data out to the supplied ServletResponse.

Parameters:
response - The servlet response to output the cached content to.
fragment - is true if this content a fragment or part of a page
acceptsGZip - is true if client browser supports gzip compression
Throws:
IOException

isContentGZiped

public boolean isContentGZiped()
Returns:
true if the content is GZIP compressed
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
OSCache Project Page
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
Copyright 2000-2005 - OpenSymphony