|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.apache.catalina.connector.ResponseBase
org.apache.catalina.connector.HttpResponseBase
Convenience base implementation of the HttpResponse interface, which
can be used for the Response implementation required by most
Connectors that deal with HTTP. Only the connector-specific
methods need to be implemented.
| Nested Class Summary | |
protected class |
HttpResponseBase.PrivilegedFlushBuffer
Deprecated. |
| Field Summary | |
protected java.util.ArrayList |
cookies
Deprecated. The set of Cookies associated with this Response. |
protected HttpResponseFacade |
facade
Deprecated. The facade associated with this response. |
protected java.text.SimpleDateFormat |
format
Deprecated. The date format we will use for creating date headers. |
protected java.util.HashMap |
headers
Deprecated. The HTTP headers explicitly added via addHeader(), but not including those to be added with setContentLength(), setContentType(), and so on. |
protected static java.lang.String |
info
Deprecated. Descriptive information about this HttpResponse implementation. |
protected java.lang.String |
message
Deprecated. The error message set by sendError(). |
protected int |
status
Deprecated. The HTTP status code associated with this Response. |
protected static java.util.TimeZone |
zone
Deprecated. The time zone with which to construct date headers. |
| Fields inherited from class org.apache.catalina.connector.ResponseBase |
appCommitted, buffer, bufferCount, committed, connector, contentCount, contentLength, contentType, context, encoding, error, included, locale, output, request, sm, stream, suspended, writer |
| 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_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 | |
HttpResponseBase()
Deprecated. |
|
| Method Summary | |
void |
addCookie(javax.servlet.http.Cookie cookie)
Deprecated. Add the specified Cookie to those that will be included with this Response. |
void |
addDateHeader(java.lang.String name,
long value)
Deprecated. Add the specified date header to the specified value. |
void |
addHeader(java.lang.String name,
java.lang.String value)
Deprecated. Add the specified header to the specified value. |
void |
addIntHeader(java.lang.String name,
int value)
Deprecated. Add the specified integer header to the specified value. |
boolean |
containsHeader(java.lang.String name)
Deprecated. Has the specified header been set already in this response? |
java.lang.String |
encodeRedirectUrl(java.lang.String url)
Deprecated. As of Version 2.1 of the Java Servlet API, use encodeRedirectURL() instead. |
java.lang.String |
encodeRedirectURL(java.lang.String url)
Deprecated. Encode the session identifier associated with this response into the specified redirect URL, if necessary. |
java.lang.String |
encodeUrl(java.lang.String url)
Deprecated. As of Version 2.1 of the Java Servlet API, use encodeURL() instead. |
java.lang.String |
encodeURL(java.lang.String url)
Deprecated. Encode the session identifier associated with this response into the specified URL, if necessary. |
void |
finishResponse()
Deprecated. Perform whatever actions are required to flush and close the output stream or writer, in a single operation. |
void |
flushBuffer()
Deprecated. Flush the buffer and commit this response. |
javax.servlet.http.Cookie[] |
getCookies()
Deprecated. Return an array of all cookies set for this response, or a zero-length array if no cookies have been set. |
java.lang.String |
getHeader(java.lang.String name)
Deprecated. Return the value for the specified header, or null if this
header has not been set. |
java.lang.String[] |
getHeaderNames()
Deprecated. Return an array of all the header names set for this response, or a zero-length array if no headers have been set. |
java.lang.String[] |
getHeaderValues(java.lang.String name)
Deprecated. Return an array of all the header values associated with the specified header name, or an zero-length array if there are no such header values. |
java.lang.String |
getMessage()
Deprecated. Return the error message that was set with sendError()
for this Response. |
protected java.lang.String |
getProtocol()
Deprecated. Return the HTTP protocol version implemented by this response object. |
javax.servlet.ServletResponse |
getResponse()
Deprecated. Return the ServletResponse for which this object
is the facade. |
int |
getStatus()
Deprecated. Return the HTTP status code associated with this Response. |
protected java.lang.String |
getStatusMessage(int status)
Deprecated. Returns a default status message for the specified HTTP status code. |
void |
recycle()
Deprecated. Release all object references, and initialize instance variables, in preparation for reuse of this object. |
void |
reset()
Deprecated. Clear any content written to the buffer. |
void |
reset(int status,
java.lang.String message)
Deprecated. Reset this response, and specify the values for the HTTP status code and corresponding message. |
void |
sendAcknowledgement()
Deprecated. Send an acknowledgment of a request. |
void |
sendError(int status)
Deprecated. Send an error response with the specified status and a default message. |
void |
sendError(int status,
java.lang.String message)
Deprecated. Send an error response with the specified status and message. |
protected void |
sendHeaders()
Deprecated. Send the HTTP response headers, if this has not already occurred. |
void |
sendRedirect(java.lang.String location)
Deprecated. Send a temporary redirect to the specified redirect location URL. |
void |
setContentLength(int length)
Deprecated. Set the content length (in bytes) for this Response. |
void |
setContentType(java.lang.String type)
Deprecated. Set the content type for this Response. |
void |
setDateHeader(java.lang.String name,
long value)
Deprecated. Set the specified date header to the specified value. |
void |
setHeader(java.lang.String name,
java.lang.String value)
Deprecated. Set the specified header to the specified value. |
void |
setIntHeader(java.lang.String name,
int value)
Deprecated. Set the specified integer header to the specified value. |
void |
setLocale(java.util.Locale locale)
Deprecated. Set the Locale that is appropriate for this response, including setting the appropriate character encoding. |
void |
setStatus(int status)
Deprecated. Set the HTTP status to be returned with this response. |
void |
setStatus(int status,
java.lang.String message)
Deprecated. As of Version 2.1 of the Java Servlet API, this method has been deprecated due to the ambiguous meaning of the message parameter. |
| Methods inherited from class org.apache.catalina.connector.ResponseBase |
createOutputStream, getBufferSize, getCharacterEncoding, getConnector, getContentCount, getContentLength, getContentType, getContext, getIncluded, getInfo, getLocale, getOutputStream, getReporter, getRequest, getStream, getWriter, isAppCommitted, isCommitted, isError, isSuspended, resetBuffer, setAppCommitted, setBufferSize, setConnector, setContext, setError, setIncluded, setRequest, setStream, setSuspended, write, write, write |
| Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Methods inherited from interface org.apache.catalina.Response |
createOutputStream, getConnector, getContentCount, getContentLength, getContentType, getContext, getIncluded, getInfo, getReporter, getRequest, getStream, isAppCommitted, isError, isSuspended, resetBuffer, setAppCommitted, setConnector, setContext, setError, setIncluded, setRequest, setStream, setSuspended |
| Methods inherited from interface javax.servlet.ServletResponse |
getBufferSize, getCharacterEncoding, getLocale, getOutputStream, getWriter, isCommitted, resetBuffer, setBufferSize |
| Field Detail |
protected java.util.ArrayList cookies
protected final java.text.SimpleDateFormat format
protected HttpResponseFacade facade
protected java.util.HashMap headers
protected static final java.lang.String info
protected java.lang.String message
sendError().
protected int status
protected static final java.util.TimeZone zone
| Constructor Detail |
public HttpResponseBase()
| Method Detail |
public javax.servlet.ServletResponse getResponse()
ServletResponse for which this object
is the facade.
getResponse in interface ResponsegetResponse in class ResponseBase
public void finishResponse()
throws java.io.IOException
finishResponse in interface ResponsefinishResponse in class ResponseBasejava.io.IOException - if an input/output error occurspublic javax.servlet.http.Cookie[] getCookies()
getCookies in interface HttpResponsepublic java.lang.String getHeader(java.lang.String name)
null if this
header has not been set. If more than one value was added for this
name, only the first is returned; use getHeaderValues() to retrieve all
of them.
getHeader in interface HttpResponsename - Header name to look uppublic java.lang.String[] getHeaderNames()
getHeaderNames in interface HttpResponsepublic java.lang.String[] getHeaderValues(java.lang.String name)
getHeaderValues in interface HttpResponsename - Header name to look uppublic java.lang.String getMessage()
sendError()
for this Response.
getMessage in interface HttpResponsepublic int getStatus()
getStatus in interface HttpResponsepublic void recycle()
recycle in interface Responserecycle in class ResponseBase
public void reset(int status,
java.lang.String message)
reset in interface HttpResponsejava.lang.IllegalStateException - if this response has already been
committedprotected java.lang.String getStatusMessage(int status)
status - The status code for which a message is desiredprotected java.lang.String getProtocol()
protected void sendHeaders()
throws java.io.IOException
java.io.IOException
public void flushBuffer()
throws java.io.IOException
flushBuffer in interface javax.servlet.ServletResponseflushBuffer in class ResponseBasejava.io.IOException - if an input/output error occurspublic void reset()
reset in interface javax.servlet.ServletResponsereset in class ResponseBasejava.lang.IllegalStateException - if this response has already
been committedpublic void setContentLength(int length)
setContentLength in interface javax.servlet.ServletResponsesetContentLength in class ResponseBaselength - The new content lengthpublic void setContentType(java.lang.String type)
setContentType in interface javax.servlet.ServletResponsesetContentType in class ResponseBasetype - The new content typepublic void setLocale(java.util.Locale locale)
setLocale in interface javax.servlet.ServletResponsesetLocale in class ResponseBaselocale - The new localepublic void addCookie(javax.servlet.http.Cookie cookie)
addCookie in interface javax.servlet.http.HttpServletResponsecookie - Cookie to be added
public void addDateHeader(java.lang.String name,
long value)
addDateHeader in interface javax.servlet.http.HttpServletResponsename - Name of the header to setvalue - Date value to be set
public void addHeader(java.lang.String name,
java.lang.String value)
addHeader in interface javax.servlet.http.HttpServletResponsename - Name of the header to setvalue - Value to be set
public void addIntHeader(java.lang.String name,
int value)
addIntHeader in interface javax.servlet.http.HttpServletResponsename - Name of the header to setvalue - Integer value to be setpublic boolean containsHeader(java.lang.String name)
containsHeader in interface javax.servlet.http.HttpServletResponsename - Name of the header to checkpublic java.lang.String encodeRedirectURL(java.lang.String url)
encodeRedirectURL in interface javax.servlet.http.HttpServletResponseurl - URL to be encodedpublic java.lang.String encodeRedirectUrl(java.lang.String url)
encodeRedirectURL() instead.
encodeRedirectUrl in interface javax.servlet.http.HttpServletResponseurl - URL to be encodedpublic java.lang.String encodeURL(java.lang.String url)
encodeURL in interface javax.servlet.http.HttpServletResponseurl - URL to be encodedpublic java.lang.String encodeUrl(java.lang.String url)
encodeURL() instead.
encodeUrl in interface javax.servlet.http.HttpServletResponseurl - URL to be encoded
public void sendAcknowledgement()
throws java.io.IOException
sendAcknowledgement in interface Responsejava.io.IOException - if an input/output error occurs
public void sendError(int status)
throws java.io.IOException
sendError in interface javax.servlet.http.HttpServletResponsestatus - HTTP status code to send
java.lang.IllegalStateException - if this response has
already been committed
java.io.IOException - if an input/output error occurs
public void sendError(int status,
java.lang.String message)
throws java.io.IOException
sendError in interface javax.servlet.http.HttpServletResponsestatus - HTTP status code to sendmessage - Corresponding message to send
java.lang.IllegalStateException - if this response has
already been committed
java.io.IOException - if an input/output error occurs
public void sendRedirect(java.lang.String location)
throws java.io.IOException
sendRedirect in interface javax.servlet.http.HttpServletResponselocation - Location URL to redirect to
java.lang.IllegalStateException - if this response has
already been committed
java.io.IOException - if an input/output error occurs
public void setDateHeader(java.lang.String name,
long value)
setDateHeader in interface javax.servlet.http.HttpServletResponsename - Name of the header to setvalue - Date value to be set
public void setHeader(java.lang.String name,
java.lang.String value)
setHeader in interface javax.servlet.http.HttpServletResponsename - Name of the header to setvalue - Value to be set
public void setIntHeader(java.lang.String name,
int value)
setIntHeader in interface javax.servlet.http.HttpServletResponsename - Name of the header to setvalue - Integer value to be setpublic void setStatus(int status)
setStatus in interface javax.servlet.http.HttpServletResponsestatus - The new HTTP status
public void setStatus(int status,
java.lang.String message)
setStatus in interface javax.servlet.http.HttpServletResponsestatus - The new HTTP statusmessage - The associated text message
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||