org.apache.xmlrpc.webserver

Class HttpServletResponseImpl

Implemented Interfaces:
HttpServletResponse

public class HttpServletResponseImpl
extends java.lang.Object
implements HttpServletResponse

Stub implementation of a javax.servlet.http.HttpServletResponse with lots of unimplemented methods. I implemented only those, which are required for testing the XmlRpcServlet. Perhaps someone else is adding more at a later time?

Constructor Summary

HttpServletResponseImpl(Socket pSocket)
Creates a new instance.

Method Summary

void
addCookie(Cookie pCookie)
void
addDateHeader(String pHeader, long pDate)
void
addHeader(String pHeader, String pValue)
void
addIntHeader(String pHeader, int pValue)
boolean
containsHeader(String pHeader)
String
encodeRedirectURL(String pURL)
String
encodeRedirectUrl(String pURL)
String
encodeURL(String pURL)
String
encodeUrl(String pURL)
void
flushBuffer()
int
getBufferSize()
String
getCharacterEncoding()
String
getContentType()
Returns the content type used for the MIME body sent in this response.
Locale
getLocale()
ServletOutputStream
getOutputStream()
static String
getStatusMessage(int pStatusCode)
Returns a default message for a given HTTP status code.
PrintWriter
getWriter()
boolean
isCommitted()
void
reset()
void
resetBuffer()
void
sendError(int pStatusCode)
void
sendError(int pStatusCode, String pMessage)
protected void
sendError(int pStatusCode, String pMessage, String pDescription)
void
sendRedirect(String arg0)
void
setBufferSize(int pBufferSize)
void
setCharacterEncoding(String pCharset)
Sets the character encoding (MIME charset) of the response being sent to the client, for example, to UTF-8.
void
setContentLength(int pContentLength)
void
setContentType(String pType)
void
setDateHeader(String arg0, long arg1)
void
setHeader(String pHeader, String pValue)
void
setIntHeader(String pHeader, int pValue)
void
setLocale(Locale pLocale)
void
setStatus(int pStatusCode)
void
setStatus(int pStatusCode, String pMessage)

Constructor Details

HttpServletResponseImpl

public HttpServletResponseImpl(Socket pSocket)
            throws IOException
Creates a new instance.
Parameters:
pSocket - The clients socket.

Method Details

addCookie

public void addCookie(Cookie pCookie)

addDateHeader

public void addDateHeader(String pHeader,
                          long pDate)

addHeader

public void addHeader(String pHeader,
                      String pValue)

addIntHeader

public void addIntHeader(String pHeader,
                         int pValue)

containsHeader

public boolean containsHeader(String pHeader)

encodeRedirectURL

public String encodeRedirectURL(String pURL)

encodeRedirectUrl

public String encodeRedirectUrl(String pURL)

encodeURL

public String encodeURL(String pURL)

encodeUrl

public String encodeUrl(String pURL)

flushBuffer

public void flushBuffer()
            throws IOException

getBufferSize

public int getBufferSize()

getCharacterEncoding

public String getCharacterEncoding()

getContentType

public String getContentType()
Returns the content type used for the MIME body sent in this response. The content type proper must have been specified using setContentType(java.lang.String) before the response is committed. If no content type has been specified, this method returns null. If a content type has been specified and a character encoding has been explicitly or implicitly specified as described in getCharacterEncoding(), the charset parameter is included in the string returned. If no character encoding has been specified, the charset parameter is omitted.
Returns:
A String specifying the content type, for example, text/html; charset=UTF-8, or null
Since:
Servlet API 2.4

getLocale

public Locale getLocale()

getOutputStream

public ServletOutputStream getOutputStream()
            throws IOException

getStatusMessage

public static String getStatusMessage(int pStatusCode)
Returns a default message for a given HTTP status code.
Parameters:
pStatusCode - The status code being queried.
Returns:
The default message.

getWriter

public PrintWriter getWriter()
            throws IOException

isCommitted

public boolean isCommitted()

reset

public void reset()

resetBuffer

public void resetBuffer()

sendError

public void sendError(int pStatusCode)
            throws IOException

sendError

public void sendError(int pStatusCode,
                      String pMessage)
            throws IOException

sendError

protected void sendError(int pStatusCode,
                         String pMessage,
                         String pDescription)
            throws IOException

sendRedirect

public void sendRedirect(String arg0)
            throws IOException

setBufferSize

public void setBufferSize(int pBufferSize)

setCharacterEncoding

public void setCharacterEncoding(String pCharset)
Sets the character encoding (MIME charset) of the response being sent to the client, for example, to UTF-8. If the character encoding has already been set by setContentType(java.lang.String) or setLocale(java.util.Locale), this method overrides it. Calling setContentType(java.lang.String) with the String of text/html and calling this method with the String of UTF-8 is equivalent with calling setContentType with the String of text/html; charset=UTF-8.

This method can be called repeatedly to change the character encoding. This method has no effect if it is called after getWriter has been called or after the response has been committed.

Containers must communicate the character encoding used for the servlet response's writer to the client if the protocol provides a way for doing so. In the case of HTTP, the character encoding is communicated as part of the Content-Type header for text media types. Note that the character encoding cannot be communicated via HTTP headers if the servlet does not specify a content type; however, it is still used to encode text written via the servlet response's writer.

Parameters:
pCharset - A String specifying only the character set defined by IANA Character Sets (http://www.iana.org/assignments/character-sets)
Since:
Servlet API 2.4

setContentLength

public void setContentLength(int pContentLength)

setContentType

public void setContentType(String pType)

setDateHeader

public void setDateHeader(String arg0,
                          long arg1)

setHeader

public void setHeader(String pHeader,
                      String pValue)

setIntHeader

public void setIntHeader(String pHeader,
                         int pValue)

setLocale

public void setLocale(Locale pLocale)

setStatus

public void setStatus(int pStatusCode)

setStatus

public void setStatus(int pStatusCode,
                      String pMessage)

Copyright © 2001-2007 Apache Software Foundation. All Rights Reserved.