public class TLcdHttpServletResponseWrapper extends java.lang.Object implements ILcdResponse
HttpServletResponse
objects.Modifier and Type | Field and Description |
---|---|
protected javax.servlet.http.HttpServletResponse |
fHttpServletResponse |
protected java.io.PrintWriter |
fWriter |
Constructor and Description |
---|
TLcdHttpServletResponseWrapper(javax.servlet.http.HttpServletResponse aHttpServletResponse)
Creates a new wrapper object.
|
Modifier and Type | Method and Description |
---|---|
void |
addDateHeader(java.lang.String aName,
long aValue)
Adds a response header with the given name and date-value.
|
void |
addHeader(java.lang.String aName,
java.lang.String aValue)
Adds a response header with the given name and value.
|
void |
addIntHeader(java.lang.String aName,
int aValue)
Adds a response header with the given name and integer value.
|
boolean |
containsHeader(java.lang.String aName)
Returns true if the response header with the given name has already been set.
|
void |
flush()
Flushes all pending data being written for this response.
|
javax.servlet.http.HttpServletResponse |
getHttpServletResponse() |
java.io.OutputStream |
getOutputStream()
Returns an
OutputStream to which the server can write its
response. |
java.io.PrintWriter |
getWriter()
Returns a
PrintWriter to which the server can write its
response. |
void |
setContentLength(int aContentLength)
Specifies the size of the data returned by this response.
|
void |
setContentType(java.lang.String aContentType)
Sets the content type (MIME type) of the response.
|
void |
setDateHeader(java.lang.String aName,
long aValue)
Sets a response header with the given name and date-value.
|
void |
setHeader(java.lang.String aName,
java.lang.String aValue)
Sets a response header with the given name and value.
|
void |
setIntHeader(java.lang.String aName,
int aValue)
Sets a response header with the given name and integer value.
|
void |
setStatus(int aStatus)
Sets the HTTP status code for this response.
|
protected javax.servlet.http.HttpServletResponse fHttpServletResponse
protected java.io.PrintWriter fWriter
public TLcdHttpServletResponseWrapper(javax.servlet.http.HttpServletResponse aHttpServletResponse)
aHttpServletResponse
- The HttpServletResponse
object around which to build a wrapper.public boolean containsHeader(java.lang.String aName)
aName
- the header namepublic void setDateHeader(java.lang.String aName, long aValue)
setDateHeader
in interface ILcdResponse
aName
- the name of the header to setaValue
- the assigned date valuepublic void addDateHeader(java.lang.String aName, long aValue)
aName
- the name of the header to setaValue
- the assigned date valuepublic void setIntHeader(java.lang.String aName, int aValue)
aName
- the name of the header to setaValue
- the assigned integer valuepublic void addIntHeader(java.lang.String aName, int aValue)
aName
- the name of the header to setaValue
- the assigned integer valuepublic void setHeader(java.lang.String aName, java.lang.String aValue)
containsHeader(String)
can be used to test for the presence of a header before setting its value.setHeader
in interface ILcdResponse
aName
- the header nameaValue
- the header valuepublic void addHeader(java.lang.String aName, java.lang.String aValue)
aName
- the header nameaValue
- the header valuepublic java.io.OutputStream getOutputStream() throws java.io.IOException
ILcdResponse
OutputStream
to which the server can write its
response.getOutputStream
in interface ILcdResponse
OutputStream
java.io.IOException
- if the output stream cannot be retrievedpublic void setContentType(java.lang.String aContentType)
ILcdResponse
setContentType
in interface ILcdResponse
aContentType
- A MIME type, e.g. "text/xml".public void setContentLength(int aContentLength)
ILcdResponse
setContentLength
in interface ILcdResponse
aContentLength
- The data size of the response.public void setStatus(int aStatus)
setStatus
in interface ILcdResponse
aStatus
- the HTTP status code for this response.public java.io.PrintWriter getWriter() throws java.io.IOException
ILcdResponse
PrintWriter
to which the server can write its
response.getWriter
in interface ILcdResponse
PrintWriter
java.io.IOException
- if the PrintWriter
cannot be created.public void flush() throws java.io.IOException
ILcdResponse
flush
in interface ILcdResponse
java.io.IOException
- if the flush operation fails.public javax.servlet.http.HttpServletResponse getHttpServletResponse()