Overview  Package   Class  Use  Deprecated  Index
Home >> All >> servletunit >> [ struts overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---

servletunit.struts
Class StrutsResponseWrapper  

java.lang.Object
  servletunit.struts.StrutsResponseWrapper

All Implemented Interfaces:

javax.servlet.http.HttpServletResponse, javax.servlet.ServletResponse

---

public class StrutsResponseWrapper

extends java.lang.Object

implements javax.servlet.http.HttpServletResponse

A wrapper for the HttpServletResponse class. This is used in CactusStrutsTestCase so that we can retrieve the redirect URL set by the ActionServlet in processing an action. This allows us to use the ActionServlet as a black box, rather than mimic its behavior as was previously the case.

---

Field Summary
private  java.lang.String	redirectLocation
private  javax.servlet.http.HttpServletResponse	response

 

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

StrutsResponseWrapper(javax.servlet.http.HttpServletResponse response)

 

Method Summary
void	addCookie(javax.servlet.http.Cookie cookie)           Adds the specified cookie to the response.
void	addDateHeader(java.lang.String name, long date)           Adds a response header with the given name and date-value.
void	addHeader(java.lang.String name, java.lang.String value)           Adds a response header with the given name and value.
void	addIntHeader(java.lang.String name, int value)           Adds a response header with the given name and integer value.
boolean	containsHeader(java.lang.String name)           Returns a boolean indicating whether the named response header has already been set.
java.lang.String	encodeRedirectUrl(java.lang.String url)
java.lang.String	encodeRedirectURL(java.lang.String url)           Encodes the specified URL for use in the sendRedirect method or, if encoding is not needed, returns the URL unchanged.
java.lang.String	encodeUrl(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.
void	flushBuffer()           Forces any content in the buffer to be written to the client.
int	getBufferSize()           Returns the actual buffer size used for the response.
java.lang.String	getCharacterEncoding()           Returns the name of the character encoding (MIME charset) used for the body sent in this response.
java.util.Locale	getLocale()           Returns the locale specified for this response using the setLocale(java.util.Locale) 55 method.
javax.servlet.ServletOutputStream	getOutputStream()           Returns a javax.servlet.ServletOutputStream suitable for writing binary data in the response.
java.lang.String	getRedirectLocation()
java.io.PrintWriter	getWriter()           Returns a PrintWriter object that can send character text to the client.
boolean	isCommitted()           Returns a boolean indicating if the response has been committed.
void	reset()           Clears any data that exists in the buffer as well as the status code and headers.
void	resetBuffer()           Clears the content of the underlying buffer in the response without clearing headers or status code.
void	sendError(int sc)           Sends an error response to the client using the specified status code and clearing the buffer.
void	sendError(int sc, java.lang.String msg)           Sends an error response to the client using the specified status.
void	sendRedirect(java.lang.String location)           Sends a temporary redirect response to the client using the specified redirect location URL.
void	setBufferSize(int size)           Sets the preferred buffer size for the body of the response.
void	setContentLength(int len)           Sets the length of the content body in the response In HTTP servlets, this method sets the HTTP Content-Length header.
void	setContentType(java.lang.String type)           Sets the content type of the response being sent to the client, if the response has not been committed yet.
void	setDateHeader(java.lang.String name, long date)           Sets a response header with the given name and date-value.
void	setHeader(java.lang.String name, java.lang.String value)           Sets a response header with the given name and value.
void	setIntHeader(java.lang.String name, int value)           Sets a response header with the given name and integer value.
void	setLocale(java.util.Locale loc)           Sets the locale of the response, if the response has not been committed yet.
void	setStatus(int sc)           Sets the status code for this response.
void	setStatus(int sc, java.lang.String sm)

 

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

 

Methods inherited from interface javax.servlet.ServletResponse

getContentType, setCharacterEncoding

 

Field Detail

response

private javax.servlet.http.HttpServletResponse response

---

redirectLocation

private java.lang.String redirectLocation

Constructor Detail

StrutsResponseWrapper

public StrutsResponseWrapper(javax.servlet.http.HttpServletResponse response)

Method Detail

addCookie

public void addCookie(javax.servlet.http.Cookie cookie)

Description copied from interface: javax.servlet.http.HttpServletResponse

Adds the specified cookie to the response. This method can be called multiple times to set more than one cookie.

Specified by:

addCookie in interface javax.servlet.http.HttpServletResponse

---

addDateHeader

public void addDateHeader(java.lang.String name,
                          long date)

Description copied from interface: javax.servlet.http.HttpServletResponse

Adds a response header with the given name and date-value. The date is specified in terms of milliseconds since the epoch. This method allows response headers to have multiple values.

Specified by:

addDateHeader in interface javax.servlet.http.HttpServletResponse

---

addHeader

public void addHeader(java.lang.String name,
                      java.lang.String value)

Description copied from interface: javax.servlet.http.HttpServletResponse

Adds a response header with the given name and value. This method allows response headers to have multiple values.

Specified by:

addHeader in interface javax.servlet.http.HttpServletResponse

---

addIntHeader

public void addIntHeader(java.lang.String name,
                         int value)

Description copied from interface: javax.servlet.http.HttpServletResponse

Adds a response header with the given name and integer value. This method allows response headers to have multiple values.

Specified by:

addIntHeader in interface javax.servlet.http.HttpServletResponse

---

containsHeader

public boolean containsHeader(java.lang.String name)

Description copied from interface: javax.servlet.http.HttpServletResponse

Returns a boolean indicating whether the named response header has already been set.

Specified by:

containsHeader in interface javax.servlet.http.HttpServletResponse

---

encodeRedirectUrl

public java.lang.String encodeRedirectUrl(java.lang.String url)

Specified by:

encodeRedirectUrl in interface javax.servlet.http.HttpServletResponse

---

encodeRedirectURL

public java.lang.String encodeRedirectURL(java.lang.String url)

Description copied from interface: javax.servlet.http.HttpServletResponse

Encodes the specified URL for use in the sendRedirect method or, if encoding is not needed, returns the URL unchanged. The implementation of this method includes the logic to determine whether the session ID needs to be encoded in the URL. Because the rules for making this determination can differ from those used to decide whether to encode a normal link, this method is separated from the encodeURL method.

All URLs sent to the HttpServletResponse.sendRedirect method should be run through this method. Otherwise, URL rewriting cannot be used with browsers which do not support cookies.

Specified by:

encodeRedirectURL in interface javax.servlet.http.HttpServletResponse

---

encodeUrl

public java.lang.String encodeUrl(java.lang.String url)

Specified by:

encodeUrl in interface javax.servlet.http.HttpServletResponse

---

encodeURL

public java.lang.String encodeURL(java.lang.String url)

Description copied from interface: javax.servlet.http.HttpServletResponse

Encodes the specified URL by including the session ID in it, or, if encoding is not needed, returns the URL unchanged. The implementation of this method includes the logic to determine whether the session ID needs to be encoded in the URL. For example, if the browser supports cookies, or session tracking is turned off, URL encoding is unnecessary.

For robust session tracking, all URLs emitted by a servlet should be run through this method. Otherwise, URL rewriting cannot be used with browsers which do not support cookies.

Specified by:

encodeURL in interface javax.servlet.http.HttpServletResponse

---

flushBuffer

public void flushBuffer()
                 throws java.io.IOException

Description copied from interface: javax.servlet.ServletResponse

Forces any content in the buffer to be written to the client. A call to this method automatically commits the response, meaning the status code and headers will be written.

Specified by:

flushBuffer in interface javax.servlet.ServletResponse

---

getBufferSize

public int getBufferSize()

Description copied from interface: javax.servlet.ServletResponse

Returns the actual buffer size used for the response. If no buffering is used, this method returns 0.

Specified by:

getBufferSize in interface javax.servlet.ServletResponse

---

getCharacterEncoding

public java.lang.String getCharacterEncoding()

Description copied from interface: javax.servlet.ServletResponse

Returns the name of the character encoding (MIME charset) used for the body sent in this response. The character encoding may have been specified explicitly using the ServletResponse.setCharacterEncoding(java.lang.String)>ServletResponse.setCharacterEncoding(java.lang.String) 55 or ServletResponse.setContentType(java.lang.String)>ServletResponse.setContentType(java.lang.String) 55 methods, or implicitly using the ServletResponse.setLocale(java.util.Locale)>ServletResponse.setLocale(java.util.Locale) 55 method. Explicit specifications take precedence over implicit specifications. Calls made to these methods after getWriter has been called or after the response has been committed have no effect on the character encoding. If no character encoding has been specified, ISO-8859-1 is returned.

See RFC 2047 (http://www.ietf.org/rfc/rfc2047.txt) for more information about character encoding and MIME.

Specified by:

getCharacterEncoding in interface javax.servlet.ServletResponse

---

getLocale

public java.util.Locale getLocale()

Description copied from interface: javax.servlet.ServletResponse

Returns the locale specified for this response using the ServletResponse.setLocale(java.util.Locale)>ServletResponse.setLocale(java.util.Locale) 55 method. Calls made to setLocale after the response is committed have no effect. If no locale has been specified, the container's default locale is returned.

Specified by:

getLocale in interface javax.servlet.ServletResponse

---

getOutputStream

public javax.servlet.ServletOutputStream getOutputStream()
                                                  throws java.io.IOException

Description copied from interface: javax.servlet.ServletResponse

Returns a javax.servlet.ServletOutputStream suitable for writing binary data in the response. The servlet container does not encode the binary data.

Calling flush() on the ServletOutputStream commits the response. Either this method or ServletResponse.getWriter()>ServletResponse.getWriter() 55 may be called to write the body, not both.

Specified by:

getOutputStream in interface javax.servlet.ServletResponse

---

getWriter

public java.io.PrintWriter getWriter()
                              throws java.io.IOException

Description copied from interface: javax.servlet.ServletResponse

Returns a PrintWriter object that can send character text to the client. The PrintWriter uses the character encoding returned by ServletResponse.getCharacterEncoding()>ServletResponse.getCharacterEncoding() 55 . If the response's character encoding has not been specified as described in getCharacterEncoding (i.e., the method just returns the default value ISO-8859-1), getWriter updates it to ISO-8859-1.

Calling flush() on the PrintWriter commits the response.

Either this method or ServletResponse.getOutputStream()>ServletResponse.getOutputStream() 55 may be called to write the body, not both.

Specified by:

getWriter in interface javax.servlet.ServletResponse

---

isCommitted

public boolean isCommitted()

Description copied from interface: javax.servlet.ServletResponse

Returns a boolean indicating if the response has been committed. A committed response has already had its status code and headers written.

Specified by:

isCommitted in interface javax.servlet.ServletResponse

---

reset

public void reset()

Description copied from interface: javax.servlet.ServletResponse

Clears any data that exists in the buffer as well as the status code and headers. If the response has been committed, this method throws an IllegalStateException.

Specified by:

reset in interface javax.servlet.ServletResponse

---

resetBuffer

public void resetBuffer()

Description copied from interface: javax.servlet.ServletResponse

Clears the content of the underlying buffer in the response without clearing headers or status code. If the response has been committed, this method throws an IllegalStateException.

Specified by:

resetBuffer in interface javax.servlet.ServletResponse

---

sendError

public void sendError(int sc)
               throws java.io.IOException

Description copied from interface: javax.servlet.http.HttpServletResponse

Sends an error response to the client using the specified status code and clearing the buffer.

If the response has already been committed, this method throws an IllegalStateException. After using this method, the response should be considered to be committed and should not be written to.

Specified by:

sendError in interface javax.servlet.http.HttpServletResponse

---

sendError

public void sendError(int sc,
                      java.lang.String msg)
               throws java.io.IOException

Description copied from interface: javax.servlet.http.HttpServletResponse

Sends an error response to the client using the specified status. The server defaults to creating the response to look like an HTML-formatted server error page containing the specified message, setting the content type to "text/html", leaving cookies and other headers unmodified. If an error-page declaration has been made for the web application corresponding to the status code passed in, it will be served back in preference to the suggested msg parameter.

If the response has already been committed, this method throws an IllegalStateException. After using this method, the response should be considered to be committed and should not be written to.

Specified by:

sendError in interface javax.servlet.http.HttpServletResponse

---

sendRedirect

public void sendRedirect(java.lang.String location)
                  throws java.io.IOException

Description copied from interface: javax.servlet.http.HttpServletResponse

Sends a temporary redirect response to the client using the specified redirect location URL. This method can accept relative URLs; the servlet container must convert the relative URL to an absolute URL before sending the response to the client. If the location is relative without a leading '/' the container interprets it as relative to the current request URI. If the location is relative with a leading '/' the container interprets it as relative to the servlet container root.

If the response has already been committed, this method throws an IllegalStateException. After using this method, the response should be considered to be committed and should not be written to.

Specified by:

sendRedirect in interface javax.servlet.http.HttpServletResponse

---

setBufferSize

public void setBufferSize(int size)

Description copied from interface: javax.servlet.ServletResponse

Sets the preferred buffer size for the body of the response. The servlet container will use a buffer at least as large as the size requested. The actual buffer size used can be found using getBufferSize.

A larger buffer allows more content to be written before anything is actually sent, thus providing the servlet with more time to set appropriate status codes and headers. A smaller buffer decreases server memory load and allows the client to start receiving data more quickly.

This method must be called before any response body content is written; if content has been written or the response object has been committed, this method throws an IllegalStateException.

Specified by:

setBufferSize in interface javax.servlet.ServletResponse

---

setContentLength

public void setContentLength(int len)

Description copied from interface: javax.servlet.ServletResponse

Sets the length of the content body in the response In HTTP servlets, this method sets the HTTP Content-Length header.

Specified by:

setContentLength in interface javax.servlet.ServletResponse

---

setContentType

public void setContentType(java.lang.String type)

Description copied from interface: javax.servlet.ServletResponse

Sets the content type of the response being sent to the client, if the response has not been committed yet. The given content type may include a character encoding specification, for example, text/html;charset=UTF-8. The response's character encoding is only set from the given content type if this method is called before getWriter is called.

This method may be called repeatedly to change content type and character encoding. This method has no effect if called after the response has been committed. It does not set the response's character encoding if it is called after getWriter has been called or after the response has been committed.

Containers must communicate the content type and 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 Content-Type header is used.

Specified by:

setContentType in interface javax.servlet.ServletResponse

---

setDateHeader

public void setDateHeader(java.lang.String name,
                          long date)

Description copied from interface: javax.servlet.http.HttpServletResponse

Sets a response header with the given name and date-value. The date is specified in terms of milliseconds since the epoch. If the header had already been set, the new value overwrites the previous one. The containsHeader method can be used to test for the presence of a header before setting its value.

Specified by:

setDateHeader in interface javax.servlet.http.HttpServletResponse

---

setHeader

public void setHeader(java.lang.String name,
                      java.lang.String value)

Description copied from interface: javax.servlet.http.HttpServletResponse

Sets a response header with the given name and value. If the header had already been set, the new value overwrites the previous one. The containsHeader method can be used to test for the presence of a header before setting its value.

Specified by:

setHeader in interface javax.servlet.http.HttpServletResponse

---

setIntHeader

public void setIntHeader(java.lang.String name,
                         int value)

Description copied from interface: javax.servlet.http.HttpServletResponse

Sets a response header with the given name and integer value. If the header had already been set, the new value overwrites the previous one. The containsHeader method can be used to test for the presence of a header before setting its value.

Specified by:

setIntHeader in interface javax.servlet.http.HttpServletResponse

---

setStatus

public void setStatus(int sc)

Description copied from interface: javax.servlet.http.HttpServletResponse

Sets the status code for this response. This method is used to set the return status code when there is no error (for example, for the status codes SC_OK or SC_MOVED_TEMPORARILY). If there is an error, and the caller wishes to invoke an error-page defined in the web application, the sendError method should be used instead.

The container clears the buffer and sets the Location header, preserving cookies and other headers.

Specified by:

setStatus in interface javax.servlet.http.HttpServletResponse

---

setStatus

public void setStatus(int sc,
                      java.lang.String sm)

Specified by:

setStatus in interface javax.servlet.http.HttpServletResponse

---

setLocale

public void setLocale(java.util.Locale loc)

Description copied from interface: javax.servlet.ServletResponse

Sets the locale of the response, if the response has not been committed yet. It also sets the response's character encoding appropriately for the locale, if the character encoding has not been explicitly set using ServletResponse.setContentType(java.lang.String)>ServletResponse.setContentType(java.lang.String) 55 or ServletResponse.setCharacterEncoding(java.lang.String)>ServletResponse.setCharacterEncoding(java.lang.String) 55 , getWriter hasn't been called yet, and the response hasn't been committed yet. If the deployment descriptor contains a locale-encoding-mapping-list element, and that element provides a mapping for the given locale, that mapping is used. Otherwise, the mapping from locale to character encoding is container dependent.

This method may be called repeatedly to change locale and character encoding. The method has no effect if called after the response has been committed. It does not set the response's character encoding if it is called after ServletResponse.setContentType(java.lang.String)>ServletResponse.setContentType(java.lang.String) 55 has been called with a charset specification, after ServletResponse.setCharacterEncoding(java.lang.String)>ServletResponse.setCharacterEncoding(java.lang.String) 55 has been called, after getWriter has been called, or after the response has been committed.

Containers must communicate the locale and 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 locale is communicated via the Content-Language header, the character encoding 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.

Specified by:

setLocale in interface javax.servlet.ServletResponse

---

getRedirectLocation

public java.lang.String getRedirectLocation()

---

Overview  Package   Class  Use  Deprecated  Index
Home >> All >> servletunit >> [ struts overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---