|
Enhydra 5.1 API | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--org.enhydra.servlet.connectionMethods.https.HttpsResponse
Implementation of a HTTP servlet response for the HTTP connection method.
javax.servlet.http.HttpsServletResponse
,
ServletResponse
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_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 | |
HttpsResponse()
|
Method Summary | |
void |
addCookie(javax.servlet.http.Cookie cookie)
Adds the specified cookie to the response. |
void |
addDateHeader(java.lang.String name,
long value)
|
void |
addHeader(java.lang.String name,
java.lang.String value)
|
void |
addIntHeader(java.lang.String name,
int value)
|
void |
addMimeHeaders(org.apache.tomcat.util.MimeHeaders headers)
|
protected void |
close()
Close the socket associate with this object. |
boolean |
containsHeader(java.lang.String name)
Checks whether the response message header has a field with the specified name. |
void |
doWrite(byte[] buffer,
int pos,
int count)
Write a chunk of bytes. |
java.lang.String |
encodeRedirectUrl(java.lang.String url)
Encodes the specified URL for use in the sendRedirect method. |
java.lang.String |
encodeRedirectURL(java.lang.String url)
|
java.lang.String |
encodeUrl(java.lang.String url)
Encodes the specified URL by including the session ID in it, or, if encoding is not needed, returns the URL unchanged. |
java.lang.String |
encodeURL(java.lang.String url)
|
void |
endHeaders()
Signal that we're done with the headers, and body will follow. |
void |
endResponse()
Signal that we're done with a particular request, the server can go on and read more requests or close the socket |
protected void |
finish()
Indicate the end of handing a request. |
void |
flushBuffer()
|
int |
getBufferSize()
|
java.lang.String |
getCharacterEncoding()
Returns the character set encoding used for this MIME body. |
java.util.Locale |
getLocale()
|
javax.servlet.ServletOutputStream |
getOutputStream()
Returns an output stream for writing binary response data. |
javax.servlet.ServletOutputStream |
getServletOutputStream()
|
java.io.PrintWriter |
getWriter()
Returns a print writer for writing formatted text responses. |
protected boolean |
haveHeadersBeenWritten()
Check if headers have been written to the socket. |
boolean |
isCommitted()
|
protected boolean |
keepAlivePossible()
Determine if keep alive is possible. |
protected void |
next(boolean keepAliveRequested)
Initialize for the next response on a socket. |
void |
recycle()
|
void |
reset()
|
void |
sendError(int sc)
Sends an error response to the client using the specified status code and a default message. |
void |
sendError(int sc,
java.lang.String msg)
Sends an error response to the client using the specified status code and descriptive message. |
void |
sendRedirect(java.lang.String location)
Sends a temporary redirect response to the client using the specified redirect location URL. |
void |
setBufferSize(int size)
|
protected void |
setConnection(java.net.Socket responseSocket)
Associate a connected socket with this object. |
void |
setContentLength(int len)
Sets the content length for this response. |
void |
setContentType(java.lang.String type)
Sets the content type for this response. |
void |
setDateHeader(java.lang.String name,
long date)
Adds a field to the response header with the given name and date-valued field. |
void |
setHeader(java.lang.String name,
java.lang.String value)
Adds a field to the response header with the given name and value. |
void |
setIntHeader(java.lang.String name,
int value)
Adds a field to the response header with the given name and integer value. |
void |
setLocale(java.util.Locale locale)
|
void |
setStatus(int sc)
Sets the status code for this response. |
void |
setStatus(int sc,
java.lang.String sm)
Sets the status code and message for this response. |
protected void |
writeHeaders()
Write out the headers. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public HttpsResponse()
Method Detail |
protected void setConnection(java.net.Socket responseSocket) throws java.io.IOException
next
function must be called before a
response can be processed.
responseSocket
- The HTTP connected socket.
java.io.IOException
- If an error occured setting up the socket
input stream.protected void close() throws java.io.IOException
java.io.IOException
- If an error occured setting up the socket
input stream.public void setContentLength(int len)
setContentLength
in interface javax.servlet.ServletResponse
len
- The content length.public void setContentType(java.lang.String type)
setContentType
in interface javax.servlet.ServletResponse
public javax.servlet.ServletOutputStream getOutputStream() throws java.io.IOException
getOutputStream
in interface javax.servlet.ServletResponse
java.lang.IllegalStateException
- if getWriter has been
called on this same request.
java.io.IOException
- if an I/O exception has occurred.public java.io.PrintWriter getWriter() throws java.io.IOException
getWriter
in interface javax.servlet.ServletResponse
UnsupportedEncodingException
- if no such encoding can
be provided.
java.lang.IllegalStateException
- if getOutputStream has been
called on this same request.
java.io.IOException
- on other errors.public java.lang.String getCharacterEncoding()
getCharacterEncoding
in interface javax.servlet.ServletResponse
public void addCookie(javax.servlet.http.Cookie cookie)
addCookie
in interface javax.servlet.http.HttpServletResponse
cookie
- The Cookie to return to the client.public boolean containsHeader(java.lang.String name)
containsHeader
in interface javax.servlet.http.HttpServletResponse
name
- The header field name.
public void setStatus(int sc, java.lang.String sm)
setStatus
in interface javax.servlet.http.HttpServletResponse
sc
- The status code.sm
- The status message.public void setStatus(int sc)
setStatus
in interface javax.servlet.http.HttpServletResponse
sc
- the status codepublic void setHeader(java.lang.String name, java.lang.String value)
setHeader
in interface javax.servlet.http.HttpServletResponse
name
- The name of the header field.value
- The header field's value.public void setIntHeader(java.lang.String name, int value)
setIntHeader
in interface javax.servlet.http.HttpServletResponse
name
- The name of the header field.value
- The header field's integer value.public void setDateHeader(java.lang.String name, long date)
setDateHeader
in interface javax.servlet.http.HttpServletResponse
name
- The name of the header field.public void sendError(int sc, java.lang.String msg) throws java.io.IOException
sendError
in interface javax.servlet.http.HttpServletResponse
sc
- The status codemsg
- The generate a HTML response with this message.
java.io.IOException
- If an I/O error has occurred.public void sendError(int sc) throws java.io.IOException
sendError
in interface javax.servlet.http.HttpServletResponse
sc
- The status code.
java.io.IOException
- If an I/O error has occurred.public void sendRedirect(java.lang.String location) throws java.io.IOException
sendRedirect
in interface javax.servlet.http.HttpServletResponse
location
- the redirect location URL.
java.io.IOException
- If an I/O error has occurred.public java.lang.String encodeUrl(java.lang.String url)
encodeUrl
in interface javax.servlet.http.HttpServletResponse
url
- The url to be encoded.
public java.lang.String encodeRedirectUrl(java.lang.String url)
sendRedirect
method.
encodeRedirectUrl
in interface javax.servlet.http.HttpServletResponse
url
- The url to be encoded.
protected void next(boolean keepAliveRequested) throws java.io.IOException
keepAliveRequested
- Indicates if a keep-alive connection has
been requested by the client.
java.io.IOException
- If an I/O error occurs.protected void writeHeaders() throws java.io.IOException
java.io.IOException
- If an I/O error occurs writing the headers.protected void finish() throws java.io.IOException
java.io.IOException
- If an I/O error occurs writing the headers.protected boolean keepAlivePossible()
protected boolean haveHeadersBeenWritten()
public java.util.Locale getLocale()
getLocale
in interface javax.servlet.ServletResponse
public void flushBuffer()
flushBuffer
in interface javax.servlet.ServletResponse
public java.lang.String encodeURL(java.lang.String url)
encodeURL
in interface javax.servlet.http.HttpServletResponse
public boolean isCommitted()
isCommitted
in interface javax.servlet.ServletResponse
public int getBufferSize()
getBufferSize
in interface javax.servlet.ServletResponse
public void reset()
reset
in interface javax.servlet.ServletResponse
public java.lang.String encodeRedirectURL(java.lang.String url)
encodeRedirectURL
in interface javax.servlet.http.HttpServletResponse
public void addIntHeader(java.lang.String name, int value)
addIntHeader
in interface javax.servlet.http.HttpServletResponse
public void addDateHeader(java.lang.String name, long value)
addDateHeader
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 setBufferSize(int size)
setBufferSize
in interface javax.servlet.ServletResponse
public void setLocale(java.util.Locale locale)
setLocale
in interface javax.servlet.ServletResponse
public void addMimeHeaders(org.apache.tomcat.util.MimeHeaders headers) throws java.io.IOException
addMimeHeaders
in interface org.apache.tomcat.core.ResponseAdapter
java.io.IOException
public void endResponse() throws java.io.IOException
endResponse
in interface org.apache.tomcat.core.ResponseAdapter
java.io.IOException
public void endHeaders() throws java.io.IOException
endHeaders
in interface org.apache.tomcat.core.ResponseAdapter
java.io.IOException
public javax.servlet.ServletOutputStream getServletOutputStream() throws java.io.IOException
getServletOutputStream
in interface org.apache.tomcat.core.ResponseAdapter
java.io.IOException
public void recycle()
recycle
in interface org.apache.tomcat.core.ResponseAdapter
public void doWrite(byte[] buffer, int pos, int count) throws java.io.IOException
doWrite
in interface org.apache.tomcat.core.ResponseAdapter
java.io.IOException
|
Enhydra 5.1 API | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |