|
|||||||||
前のクラス 次のクラス | フレームあり フレームなし | ||||||||
概要: 内部クラス | フィールド | コンストラクタ | メソッド | 詳細: フィールド | コンストラクタ | メソッド |
java.lang.Object | +--org.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.
フィールドの概要 | |
protected java.util.ArrayList |
cookies
The set of Cookies associated with this Response. |
protected HttpResponseFacade |
facade
The facade associated with this response. |
protected java.text.SimpleDateFormat |
format
The date format we will use for creating date headers. |
protected java.util.HashMap |
headers
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
Descriptive information about this HttpResponse implementation. |
protected java.lang.String |
message
The error message set by sendError() . |
protected int |
status
The HTTP status code associated with this Response. |
protected static java.util.TimeZone |
zone
The time zone with which to construct date headers. |
クラス org.apache.catalina.connector.ResponseBase から継承したフィールド |
appCommitted, buffer, bufferCount, committed, connector, contentCount, contentLength, contentType, context, encoding, error, included, locale, output, request, sm, stream, suspended, writer |
インタフェース 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 |
コンストラクタの概要 | |
HttpResponseBase()
|
メソッドの概要 | |
void |
addCookie(javax.servlet.http.Cookie cookie)
Add the specified Cookie to those that will be included with this Response. |
void |
addDateHeader(java.lang.String name,
long value)
Add the specified date header to the specified value. |
void |
addHeader(java.lang.String name,
java.lang.String value)
Add the specified header to the specified value. |
void |
addIntHeader(java.lang.String name,
int value)
Add the specified integer header to the specified value. |
boolean |
containsHeader(java.lang.String name)
Has the specified header been set already in this response? |
java.lang.String |
encodeRedirectUrl(java.lang.String url)
推奨されていません。 As of Version 2.1 of the Java Servlet API, use encodeRedirectURL() instead. |
java.lang.String |
encodeRedirectURL(java.lang.String url)
Encode the session identifier associated with this response into the specified redirect URL, if necessary. |
java.lang.String |
encodeUrl(java.lang.String url)
推奨されていません。 As of Version 2.1 of the Java Servlet API, use encodeURL() instead. |
java.lang.String |
encodeURL(java.lang.String url)
Encode the session identifier associated with this response into the specified URL, if necessary. |
void |
finishResponse()
Perform whatever actions are required to flush and close the output stream or writer, in a single operation. |
void |
flushBuffer()
Flush the buffer and commit this response. |
javax.servlet.http.Cookie[] |
getCookies()
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)
Return the value for the specified header, or null if this
header has not been set. |
java.lang.String[] |
getHeaderNames()
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)
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()
Return the error message that was set with sendError()
for this Response. |
protected java.lang.String |
getProtocol()
Return the HTTP protocol version implemented by this response object. |
javax.servlet.ServletResponse |
getResponse()
Return the ServletResponse for which this object
is the facade. |
int |
getStatus()
Return the HTTP status code associated with this Response. |
protected java.lang.String |
getStatusMessage(int status)
Returns a default status message for the specified HTTP status code. |
void |
recycle()
Release all object references, and initialize instance variables, in preparation for reuse of this object. |
void |
reset()
Clear any content written to the buffer. |
void |
reset(int status,
java.lang.String message)
Reset this response, and specify the values for the HTTP status code and corresponding message. |
void |
sendError(int status)
Send an error response with the specified status and a default message. |
void |
sendError(int status,
java.lang.String message)
Send an error response with the specified status and message. |
protected void |
sendHeaders()
Send the HTTP response headers, if this has not already occurred. |
void |
sendRedirect(java.lang.String location)
Send a temporary redirect to the specified redirect location URL. |
void |
setContentLength(int length)
Set the content length (in bytes) for this Response. |
void |
setContentType(java.lang.String type)
Set the content type for this Response. |
void |
setDateHeader(java.lang.String name,
long value)
Set the specified date header to the specified value. |
void |
setHeader(java.lang.String name,
java.lang.String value)
Set the specified header to the specified value. |
void |
setIntHeader(java.lang.String name,
int value)
Set the specified integer header to the specified value. |
void |
setLocale(java.util.Locale locale)
Set the Locale that is appropriate for this response, including setting the appropriate character encoding. |
void |
setStatus(int status)
Set the HTTP status to be returned with this response. |
void |
setStatus(int status,
java.lang.String message)
推奨されていません。 As of Version 2.1 of the Java Servlet API, this method has been deprecated due to the ambiguous meaning of the message parameter. |
クラス 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 |
クラス java.lang.Object から継承したメソッド |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
インタフェース 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 |
インタフェース javax.servlet.ServletResponse から継承したメソッド |
getBufferSize, getCharacterEncoding, getLocale, getOutputStream, getWriter, isCommitted, resetBuffer, setBufferSize |
フィールドの詳細 |
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
コンストラクタの詳細 |
public HttpResponseBase()
メソッドの詳細 |
public javax.servlet.ServletResponse getResponse()
ServletResponse
for which this object
is the facade.Response
内の getResponse
ResponseBase
内の getResponse
public void finishResponse() throws java.io.IOException
Response
内の finishResponse
ResponseBase
内の finishResponse
java.io.IOException
- if an input/output error occurspublic javax.servlet.http.Cookie[] getCookies()
HttpResponse
内の getCookies
public 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.HttpResponse
内の getHeader
name
- Header name to look uppublic java.lang.String[] getHeaderNames()
HttpResponse
内の getHeaderNames
public java.lang.String[] getHeaderValues(java.lang.String name)
HttpResponse
内の getHeaderValues
name
- Header name to look uppublic java.lang.String getMessage()
sendError()
for this Response.HttpResponse
内の getMessage
public int getStatus()
HttpResponse
内の getStatus
public void recycle()
Response
内の recycle
ResponseBase
内の recycle
public void reset(int status, java.lang.String message)
HttpResponse
内の reset
java.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
public void flushBuffer() throws java.io.IOException
javax.servlet.ServletResponse
内の flushBuffer
ResponseBase
内の flushBuffer
java.io.IOException
- if an input/output error occurspublic void reset()
javax.servlet.ServletResponse
内の reset
ResponseBase
内の reset
java.lang.IllegalStateException
- if this response has already
been committedpublic void setContentLength(int length)
javax.servlet.ServletResponse
内の setContentLength
ResponseBase
内の setContentLength
length
- The new content lengthpublic void setContentType(java.lang.String type)
javax.servlet.ServletResponse
内の setContentType
ResponseBase
内の setContentType
type
- The new content typepublic void setLocale(java.util.Locale locale)
javax.servlet.ServletResponse
内の setLocale
ResponseBase
内の setLocale
locale
- The new localepublic void addCookie(javax.servlet.http.Cookie cookie)
javax.servlet.http.HttpServletResponse
内の addCookie
cookie
- Cookie to be addedpublic void addDateHeader(java.lang.String name, long value)
javax.servlet.http.HttpServletResponse
内の addDateHeader
name
- Name of the header to setvalue
- Date value to be setpublic void addHeader(java.lang.String name, java.lang.String value)
javax.servlet.http.HttpServletResponse
内の addHeader
name
- Name of the header to setvalue
- Value to be setpublic void addIntHeader(java.lang.String name, int value)
javax.servlet.http.HttpServletResponse
内の addIntHeader
name
- Name of the header to setvalue
- Integer value to be setpublic boolean containsHeader(java.lang.String name)
javax.servlet.http.HttpServletResponse
内の containsHeader
name
- Name of the header to checkpublic java.lang.String encodeRedirectURL(java.lang.String url)
javax.servlet.http.HttpServletResponse
内の encodeRedirectURL
url
- URL to be encodedpublic java.lang.String encodeRedirectUrl(java.lang.String url)
encodeRedirectURL()
instead.
javax.servlet.http.HttpServletResponse
内の encodeRedirectUrl
url
- URL to be encodedpublic java.lang.String encodeURL(java.lang.String url)
javax.servlet.http.HttpServletResponse
内の encodeURL
url
- URL to be encodedpublic java.lang.String encodeUrl(java.lang.String url)
encodeURL()
instead.
javax.servlet.http.HttpServletResponse
内の encodeUrl
url
- URL to be encodedpublic void sendError(int status) throws java.io.IOException
javax.servlet.http.HttpServletResponse
内の sendError
status
- HTTP status code to sendjava.lang.IllegalStateException
- if this response has
already been committedjava.io.IOException
- if an input/output error occurspublic void sendError(int status, java.lang.String message) throws java.io.IOException
javax.servlet.http.HttpServletResponse
内の sendError
status
- HTTP status code to sendmessage
- Corresponding message to sendjava.lang.IllegalStateException
- if this response has
already been committedjava.io.IOException
- if an input/output error occurspublic void sendRedirect(java.lang.String location) throws java.io.IOException
javax.servlet.http.HttpServletResponse
内の sendRedirect
location
- Location URL to redirect tojava.lang.IllegalStateException
- if this response has
already been committedjava.io.IOException
- if an input/output error occurspublic void setDateHeader(java.lang.String name, long value)
javax.servlet.http.HttpServletResponse
内の setDateHeader
name
- Name of the header to setvalue
- Date value to be setpublic void setHeader(java.lang.String name, java.lang.String value)
javax.servlet.http.HttpServletResponse
内の setHeader
name
- Name of the header to setvalue
- Value to be setpublic void setIntHeader(java.lang.String name, int value)
javax.servlet.http.HttpServletResponse
内の setIntHeader
name
- Name of the header to setvalue
- Integer value to be setpublic void setStatus(int status)
javax.servlet.http.HttpServletResponse
内の setStatus
status
- The new HTTP statuspublic void setStatus(int status, java.lang.String message)
javax.servlet.http.HttpServletResponse
内の setStatus
status
- The new HTTP statusmessage
- The associated text message
|
|||||||||
前のクラス 次のクラス | フレームあり フレームなし | ||||||||
概要: 内部クラス | フィールド | コンストラクタ | メソッド | 詳細: フィールド | コンストラクタ | メソッド |