|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.felix.httplite.servlet.HttpServletResponseImpl
public class HttpServletResponseImpl
This class represents an HTTP response and handles sending properly formatted responses to HTTP requests.
Field Summary |
---|
Fields inherited from interface javax.servlet.http.HttpServletResponse |
---|
SC_ACCEPTED, SC_BAD_GATEWAY, SC_BAD_REQUEST, SC_CONFLICT, SC_CONTINUE, SC_CREATED, SC_EXPECTATION_FAILED, SC_FORBIDDEN, SC_FOUND, SC_GATEWAY_TIMEOUT, SC_GONE, SC_HTTP_VERSION_NOT_SUPPORTED, SC_INTERNAL_SERVER_ERROR, SC_LENGTH_REQUIRED, SC_METHOD_NOT_ALLOWED, SC_MOVED_PERMANENTLY, SC_MOVED_TEMPORARILY, SC_MULTIPLE_CHOICES, SC_NO_CONTENT, SC_NON_AUTHORITATIVE_INFORMATION, SC_NOT_ACCEPTABLE, SC_NOT_FOUND, SC_NOT_IMPLEMENTED, SC_NOT_MODIFIED, SC_OK, SC_PARTIAL_CONTENT, SC_PAYMENT_REQUIRED, SC_PRECONDITION_FAILED, SC_PROXY_AUTHENTICATION_REQUIRED, SC_REQUEST_ENTITY_TOO_LARGE, SC_REQUEST_TIMEOUT, SC_REQUEST_URI_TOO_LONG, SC_REQUESTED_RANGE_NOT_SATISFIABLE, SC_RESET_CONTENT, SC_SEE_OTHER, SC_SERVICE_UNAVAILABLE, SC_SWITCHING_PROTOCOLS, SC_TEMPORARY_REDIRECT, SC_UNAUTHORIZED, SC_UNSUPPORTED_MEDIA_TYPE, SC_USE_PROXY |
Constructor Summary | |
---|---|
HttpServletResponseImpl(java.io.OutputStream outputStream)
Constructs an HTTP response for the specified server and request. |
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)
|
static byte[] |
buildResponse(int code)
|
static byte[] |
buildResponse(int code,
java.util.Map headers,
java.lang.String userMessage,
java.lang.String htmlStartTag)
Build a response given input parameters. |
static byte[] |
buildResponse(int code,
java.lang.String userMessage)
|
boolean |
containsHeader(java.lang.String name)
|
static void |
copy(java.io.InputStream input,
java.io.OutputStream output)
Copy an input stream to an output stream. |
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.lang.String |
getContentType()
|
java.util.Locale |
getLocale()
|
javax.servlet.ServletOutputStream |
getOutputStream()
|
java.io.PrintWriter |
getWriter()
|
boolean |
isCommitted()
|
void |
reset()
|
void |
resetBuffer()
|
void |
sendContinueResponse()
Static utility method to send a continue response. |
void |
sendError(int sc)
|
void |
sendError(int sc,
java.lang.String msg)
|
void |
sendMissingHostResponse()
Static utility method to send a missing host response. |
void |
sendMovedPermanently(java.lang.String hostname,
int port,
java.lang.String newURI)
Static utility method to send a moved permanently response. |
void |
sendNotFoundResponse()
Static utility method to send a Not Found (404) response. |
void |
sendNotImplementedResponse()
Static utility method to send a not implemented response. |
void |
sendRedirect(java.lang.String location)
|
void |
setBufferSize(int arg0)
|
void |
setCharacterEncoding(java.lang.String arg0)
|
void |
setConnectionType(java.lang.String type)
Can be 'close' or 'Keep-Alive'. |
void |
setContentLength(int arg0)
|
void |
setContentType(java.lang.String arg0)
|
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 arg0)
|
void |
setStatus(int sc)
|
void |
setStatus(int sc,
java.lang.String sm)
|
void |
writeToOutputStream(java.io.InputStream inputStream,
boolean close)
Copy the contents of the input to the output stream, then close the input stream. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public HttpServletResponseImpl(java.io.OutputStream outputStream)
outputStream
- The output stream for the client.Method Detail |
---|
public void writeToOutputStream(java.io.InputStream inputStream, boolean close) throws java.io.IOException
inputStream
- input streamclose
- if connection should be closed
java.io.IOException
- on I/O errorpublic static void copy(java.io.InputStream input, java.io.OutputStream output) throws java.io.IOException
input
- InputStreamoutput
- OutputStream
java.io.IOException
- on I/O error.public void sendContinueResponse() throws java.io.IOException
java.io.IOException
- If any I/O error occurs.public void sendMissingHostResponse() throws java.io.IOException
java.io.IOException
- If any I/O error occurs.public void sendNotImplementedResponse() throws java.io.IOException
java.io.IOException
- If any I/O error occurs.public void sendMovedPermanently(java.lang.String hostname, int port, java.lang.String newURI) throws java.io.IOException
hostname
- The hostname of the new location.port
- The port of the new location.newURI
- The path of the new location.
java.io.IOException
- If any I/O error occurs.public void sendNotFoundResponse() throws java.io.IOException
java.io.IOException
- If any I/O error occurs.public void flushBuffer() throws java.io.IOException
flushBuffer
in interface javax.servlet.ServletResponse
java.io.IOException
public int getBufferSize()
getBufferSize
in interface javax.servlet.ServletResponse
public java.lang.String getCharacterEncoding()
getCharacterEncoding
in interface javax.servlet.ServletResponse
public java.lang.String getContentType()
getContentType
in interface javax.servlet.ServletResponse
public java.util.Locale getLocale()
getLocale
in interface javax.servlet.ServletResponse
public javax.servlet.ServletOutputStream getOutputStream() throws java.io.IOException
getOutputStream
in interface javax.servlet.ServletResponse
java.io.IOException
public java.io.PrintWriter getWriter() throws java.io.IOException
getWriter
in interface javax.servlet.ServletResponse
java.io.IOException
public boolean isCommitted()
isCommitted
in interface javax.servlet.ServletResponse
public void reset()
reset
in interface javax.servlet.ServletResponse
public void resetBuffer()
resetBuffer
in interface javax.servlet.ServletResponse
public void setBufferSize(int arg0)
setBufferSize
in interface javax.servlet.ServletResponse
public void setCharacterEncoding(java.lang.String arg0)
setCharacterEncoding
in interface javax.servlet.ServletResponse
public void setContentLength(int arg0)
setContentLength
in interface javax.servlet.ServletResponse
public void setConnectionType(java.lang.String type)
type
- public void setContentType(java.lang.String arg0)
setContentType
in interface javax.servlet.ServletResponse
public void setLocale(java.util.Locale arg0)
setLocale
in interface javax.servlet.ServletResponse
public void addCookie(javax.servlet.http.Cookie cookie)
addCookie
in interface javax.servlet.http.HttpServletResponse
public boolean containsHeader(java.lang.String name)
containsHeader
in interface javax.servlet.http.HttpServletResponse
public java.lang.String encodeURL(java.lang.String url)
encodeURL
in interface javax.servlet.http.HttpServletResponse
public java.lang.String encodeRedirectURL(java.lang.String url)
encodeRedirectURL
in interface javax.servlet.http.HttpServletResponse
public java.lang.String encodeUrl(java.lang.String url)
encodeUrl
in interface javax.servlet.http.HttpServletResponse
public java.lang.String encodeRedirectUrl(java.lang.String url)
encodeRedirectUrl
in interface javax.servlet.http.HttpServletResponse
public void sendError(int sc, java.lang.String msg) throws java.io.IOException
sendError
in interface javax.servlet.http.HttpServletResponse
java.io.IOException
public void sendError(int sc) throws java.io.IOException
sendError
in interface javax.servlet.http.HttpServletResponse
java.io.IOException
public void sendRedirect(java.lang.String location) throws java.io.IOException
sendRedirect
in interface javax.servlet.http.HttpServletResponse
java.io.IOException
public void setDateHeader(java.lang.String name, long date)
setDateHeader
in interface javax.servlet.http.HttpServletResponse
public void addDateHeader(java.lang.String name, long date)
addDateHeader
in interface javax.servlet.http.HttpServletResponse
public void setHeader(java.lang.String name, java.lang.String value)
setHeader
in interface javax.servlet.http.HttpServletResponse
public void addHeader(java.lang.String name, java.lang.String value)
addHeader
in interface javax.servlet.http.HttpServletResponse
public void setIntHeader(java.lang.String name, int value)
setIntHeader
in interface javax.servlet.http.HttpServletResponse
public void addIntHeader(java.lang.String name, int value)
addIntHeader
in interface javax.servlet.http.HttpServletResponse
public void setStatus(int sc)
setStatus
in interface javax.servlet.http.HttpServletResponse
public void setStatus(int sc, java.lang.String sm)
setStatus
in interface javax.servlet.http.HttpServletResponse
public static byte[] buildResponse(int code)
code
- HTTP code
public static byte[] buildResponse(int code, java.lang.String userMessage)
code
- HTTP codeuserMessage
- user message
public static byte[] buildResponse(int code, java.util.Map headers, java.lang.String userMessage, java.lang.String htmlStartTag)
code
- HTTP codeheaders
- Map of HTTP headersuserMessage
- user messagehtmlStartTag
- custom HTML document start
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |