Class TestableResponseImpl
java.lang.Object
org.apache.tapestry5.internal.test.TestableResponseImpl
- All Implemented Interfaces:
Response,TestableResponse
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidAdds a response header with the given name and value, not overwriting any previous values which may have already been added.voidclear()Clears internal state, in preparation for the next test.voidInvoked to indicate that the response content is either already compressed, or is not compressable.encodeRedirectURL(String URL) Encodes the URL for use as a redirect, ensuring that a session id is included (if a session exists, and as necessary depending on the client browser's use of cookies).Encodes the URL, ensuring that a session id is included (if a session exists, and as necessary depending on the client browser's use of cookies).intReturns the the MIME content type for the output.Returns the error message, if available.Returns the named header.List<?>getHeaders(String name) Returns the values of a named header.Returns the content of theServletOutputStreamas string.getOutputStream(String contentType) Returns an OutputStream to which byte-oriented output may be sent.getPrintWriter(String contentType) Returns a PrintWriter object to which output may be sent.Returns the link redirected to viaResponse.sendRedirect(org.apache.tapestry5.http.Link).Returns the redirect URL.Allows access to the rendered document.intReturns the status code for this response.booleanReturns true if the response has already been sent, either as a redirect or as a stream of content.voidSends an error response to the client using the specified status.voidsendRedirect(String URL) Sends a redirect to the client.voidsendRedirect(Link link) Sends a redirect to a link.voidsetContentLength(int length) Sets the length of the content body in the response; this method sets the HTTP Content-Length header.voidsetDateHeader(String name, long date) Sets a response header with the given name and date-value.voidSets a response header with the given name and value.voidsetIntHeader(String name, int value) Sets a response header with the given name and integer value.voidsetRenderedDocument(Document document) Invoked as part of the rendering pipeline to store the final rendered Document object.voidsetStatus(int sc) Sets the status code for this response.
-
Constructor Details
-
TestableResponseImpl
public TestableResponseImpl()
-
-
Method Details
-
getOutputStream
Description copied from interface:ResponseReturns an OutputStream to which byte-oriented output may be sent. Invoking flush() on the stream will commit the output.- Specified by:
getOutputStreamin interfaceResponse- Parameters:
contentType- the MIME content type for the output, often "application/octet-stream" or "text/plain" or one of several others- Throws:
IOException
-
getPrintWriter
Description copied from interface:ResponseReturns a PrintWriter object to which output may be sent. Invoking flush() on the writer will commit the output.- Specified by:
getPrintWriterin interfaceResponse- Parameters:
contentType- the MIME content type for the output, typically "text/html"- Throws:
IOException
-
sendError
Description copied from interface:ResponseSends 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:
sendErrorin interfaceResponse- Parameters:
sc- the error status codemessage- the descriptive message- Throws:
IOException- If an input or output exception occurs
-
sendRedirect
Description copied from interface:ResponseSends a redirect to the client.- Specified by:
sendRedirectin interfaceResponse- Parameters:
URL- full or partial (relative) URL to send to the client- Throws:
IOException- See Also:
-
setContentLength
Description copied from interface:ResponseSets the length of the content body in the response; this method sets the HTTP Content-Length header.- Specified by:
setContentLengthin interfaceResponse- Parameters:
length- the length of the content
-
setDateHeader
Description copied from interface:ResponseSets 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.- Specified by:
setDateHeaderin interfaceResponse- Parameters:
name- the name of the header to setdate- the assigned date value
-
setHeader
Description copied from interface:ResponseSets a response header with the given name and value. If the header had already been set, the new value overwrites the previous one. -
addHeader
Description copied from interface:ResponseAdds a response header with the given name and value, not overwriting any previous values which may have already been added. -
getHeaders
Description copied from interface:TestableResponseReturns the values of a named header.- Specified by:
getHeadersin interfaceTestableResponse
-
setIntHeader
Description copied from interface:ResponseSets a response header with the given name and integer value. If the header had already been set, the new value overwrites the previous one.- Specified by:
setIntHeaderin interfaceResponse- Parameters:
name- the name of the header to setvalue- the assigned integer value
-
sendRedirect
Description copied from interface:ResponseSends a redirect to a link.- Specified by:
sendRedirectin interfaceResponse- Parameters:
link- link to redirect to.- Throws:
IOException
-
setStatus
Description copied from interface:ResponseSets 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 applicaion, thesendErrormethod should be used instead. -
encodeRedirectURL
Description copied from interface:ResponseEncodes the URL for use as a redirect, ensuring that a session id is included (if a session exists, and as necessary depending on the client browser's use of cookies).- Specified by:
encodeRedirectURLin interfaceResponse- Returns:
- the same URL or a different one with additional information to track the user session
-
encodeURL
Description copied from interface:ResponseEncodes the URL, ensuring that a session id is included (if a session exists, and as necessary depending on the client browser's use of cookies). -
getRedirectLink
Description copied from interface:TestableResponseReturns the link redirected to viaResponse.sendRedirect(org.apache.tapestry5.http.Link).- Specified by:
getRedirectLinkin interfaceTestableResponse
-
isCommitted
Description copied from interface:ResponseReturns true if the response has already been sent, either as a redirect or as a stream of content.- Specified by:
isCommittedin interfaceResponse- Returns:
- true if response already sent
-
clear
Description copied from interface:TestableResponseClears internal state, in preparation for the next test.- Specified by:
clearin interfaceTestableResponse
-
getRenderedDocument
Description copied from interface:TestableResponseAllows access to the rendered document.- Specified by:
getRenderedDocumentin interfaceTestableResponse
-
setRenderedDocument
Description copied from interface:TestableResponseInvoked as part of the rendering pipeline to store the final rendered Document object.- Specified by:
setRenderedDocumentin interfaceTestableResponse
-
disableCompression
Description copied from interface:ResponseInvoked to indicate that the response content is either already compressed, or is not compressable.- Specified by:
disableCompressionin interfaceResponse
-
getHeader
Description copied from interface:TestableResponseReturns the named header.- Specified by:
getHeaderin interfaceTestableResponse
-
getRedirectURL
Description copied from interface:TestableResponseReturns the redirect URL.- Specified by:
getRedirectURLin interfaceTestableResponse
-
getStatus
Description copied from interface:TestableResponseReturns the status code for this response.- Specified by:
getStatusin interfaceTestableResponse
-
getErrorMessage
Description copied from interface:TestableResponseReturns the error message, if available.- Specified by:
getErrorMessagein interfaceTestableResponse
-
getContentLength
-
getContentType
Description copied from interface:TestableResponseReturns the the MIME content type for the output.- Specified by:
getContentTypein interfaceTestableResponse
-
getOutput
Description copied from interface:TestableResponseReturns the content of theServletOutputStreamas string.- Specified by:
getOutputin interfaceTestableResponse
-