com.vaadin.server
Interface VaadinResponse

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

VaadinPortletResponse, VaadinServletResponse

public interface VaadinResponse
extends java.io.Serializable

A generic response from the server, wrapping a more specific response type, e.g. HttpServletResponse or PortletResponse.

Since:

7.0

Method Summary

void	addCookie(javax.servlet.http.Cookie cookie) Adds the specified cookie to the response.
java.io.OutputStream	getOutputStream() Returns a OutputStream for writing binary data in the response.
VaadinService	getService() Gets the vaadin service for the context of this response.
java.io.PrintWriter	getWriter() Returns a PrintWriter object that can send character text to the client.
void	sendError(int errorCode, java.lang.String message) Sends an error response to the client using the specified status code and clears the buffer.
void	setCacheTime(long milliseconds) Sets cache time in milliseconds, -1 means no cache at all.
void	setContentType(java.lang.String contentType) Sets the content type of this response.
void	setDateHeader(java.lang.String name, long timestamp) Properly formats a timestamp as a date header.
void	setHeader(java.lang.String name, java.lang.String value) Sets the value of a generic response header.
void	setStatus(int statusCode) Sets the (http) status code for the response.

Method Detail

setStatus

void setStatus(int statusCode)

Sets the (http) status code for the response. If you want to include an error message along the status code, use sendError(int, String) instead.

Parameters:

statusCode - the status code to set

See Also:

HttpServletResponse.setStatus(int), ResourceResponse.HTTP_STATUS_CODE

setContentType

void setContentType(java.lang.String contentType)

Sets the content type of this response. If the content type including a charset is set before getWriter() is invoked, the returned PrintWriter will automatically use the defined charset.

Parameters:

contentType - a string specifying the MIME type of the content

See Also:

ServletResponse.setContentType(String), MimeResponse.setContentType(String)

setHeader

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

Sets the value of a generic response header. If the header had already been set, the new value overwrites the previous one.

Parameters:

name - the name of the header

value - the header value.

See Also:

HttpServletResponse.setHeader(String, String), PortletResponse.setProperty(String, String)

setDateHeader

void setDateHeader(java.lang.String name,
                   long timestamp)

Properly formats a timestamp as a date header. If the header had already been set, the new value overwrites the previous one.

Parameters:

name - the name of the header

timestamp - the number of milliseconds since epoch

See Also:

HttpServletResponse.setDateHeader(String, long)

getOutputStream

java.io.OutputStream getOutputStream()
                                     throws java.io.IOException

Returns a OutputStream for writing binary data in the response.

Either this method or getWriter() may be called to write the response, not both.

Returns:

a OutputStream for writing binary data

Throws:

java.io.IOException - if an input or output exception occurred

See Also:

getWriter(), ServletResponse.getOutputStream(), MimeResponse.getPortletOutputStream()

getWriter

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

Returns a PrintWriter object that can send character text to the client. The PrintWriter uses the character encoding defined using setContentType.

Either this method or getOutputStream() may be called to write the response, not both.

Returns:

a PrintWriter for writing character text

Throws:

java.io.IOException - if an input or output exception occurred

See Also:

getOutputStream(), ServletResponse.getWriter(), MimeResponse.getWriter()

setCacheTime

void setCacheTime(long milliseconds)

Sets cache time in milliseconds, -1 means no cache at all. All required headers related to caching in the response are set based on the time.

Parameters:

milliseconds - Cache time in milliseconds

sendError

void sendError(int errorCode,
               java.lang.String message)
               throws java.io.IOException

Sends an error response to the client using the specified status code and clears the buffer. In some configurations, this can cause a predefined error page to be displayed.

Parameters:

errorCode - the HTTP status code

message - a message to accompany the error

Throws:

java.io.IOException - if an input or output exception occurs

See Also:

HttpServletResponse.sendError(int, String)

getService

VaadinService getService()

Gets the vaadin service for the context of this response.

Returns:

the vaadin service

See Also:

VaadinService

addCookie

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

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

Parameters:

cookie - the Cookie to return to the client

See Also:

HttpServletResponse.addCookie(Cookie), PortletResponse.addProperty(Cookie)