We use cookies to serve our customers and website visitors in the best possible way. Cookies are used for the proper functioning of the website and for improving the user experience, monitoring visitor traffic and marketing purposes. By continuing to browse the site, you agree to our use of cookies. You can read more about cookies here.
com.vaadin.server.
Class VaadinPortletResponse
- java.lang.Object
-
- com.vaadin.server.VaadinPortletResponse
-
All Implemented Interfaces:
public class VaadinPortletResponse extends Object implements VaadinResponseWrapper for
PortletResponseand its subclasses.Since:
7.0
Author:
Vaadin Ltd.
See Also:
-
-
Constructor Summary
Constructors Constructor and Description VaadinPortletResponse(PortletResponse response, VaadinPortletService vaadinService)Wraps a portlet response and an associated vaadin service.
-
Method Summary
All Methods Modifier and Type Method and Description voidaddCookie(Cookie cookie)Adds the specified cookie to the response.
OutputStreamgetOutputStream()Returns a
OutputStreamfor writing binary data in the response.PortletResponsegetPortletResponse()Gets the original, unwrapped portlet response.
VaadinPortletServicegetService()Gets the vaadin service for the context of this response.
PrintWritergetWriter()Returns a
PrintWriterobject that can send character text to the client.voidsendError(int errorCode, String message)Sends an error response to the client using the specified status code and clears the buffer.
voidsetCacheTime(long milliseconds)Sets cache time in milliseconds, -1 means no cache at all.
voidsetContentLength(int len)Sets the length of the content body in the response In HTTP servlets, this method sets the HTTP Content-Length header.
voidsetContentType(String type)Sets the content type of this response.
voidsetDateHeader(String name, long timestamp)Properly formats a timestamp as a date header.
voidsetHeader(String name, String value)Sets the value of a generic response header.
voidsetStatus(int responseStatus)Sets the (http) status code for the response.
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface com.vaadin.server.VaadinResponse
getCurrent, setNoCacheHeaders
-
-
-
-
Constructor Detail
-
VaadinPortletResponse
public VaadinPortletResponse(PortletResponse response, VaadinPortletService vaadinService)Wraps a portlet response and an associated vaadin service.
Parameters:
response- the portlet response to wrapvaadinService- the associated vaadin service
-
-
Method Detail
-
getOutputStream
public OutputStream getOutputStream() throws IOExceptionDescription copied from interface:
VaadinResponseReturns a
OutputStreamfor writing binary data in the response.Either this method or getWriter() may be called to write the response, not both.
Specified by:
getOutputStreamin interfaceVaadinResponseReturns:
a
OutputStreamfor writing binary dataThrows:
IOException- if an input or output exception occurredSee Also:
VaadinResponse.getWriter(),ServletResponse.getOutputStream(),MimeResponse.getPortletOutputStream()
-
getPortletResponse
public PortletResponse getPortletResponse()Gets the original, unwrapped portlet response.
Returns:
the unwrapped portlet response
-
setContentType
public void setContentType(String type)Description copied from interface:
VaadinResponseSets the content type of this response. If the content type including a charset is set before
VaadinResponse.getWriter()is invoked, the returned PrintWriter will automatically use the defined charset.Specified by:
setContentTypein interfaceVaadinResponseParameters:
type- a string specifying the MIME type of the contentSee Also:
ServletResponse.setContentType(String),MimeResponse.setContentType(String)
-
setContentLength
public void setContentLength(int len)Description copied from interface:
VaadinResponseSets the length of the content body in the response In HTTP servlets, this method sets the HTTP Content-Length header. For some portlet responses, this method sets the content-length header, for others this method does nothing.
Specified by:
setContentLengthin interfaceVaadinResponseParameters:
len- an integer specifying the length of the content being returned to the client
-
getWriter
public PrintWriter getWriter() throws IOExceptionDescription copied from interface:
VaadinResponseReturns a
PrintWriterobject 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.
Specified by:
getWriterin interfaceVaadinResponseReturns:
a
PrintWriterfor writing character textThrows:
IOException- if an input or output exception occurredSee Also:
VaadinResponse.getOutputStream(),ServletResponse.getWriter(),MimeResponse.getWriter()
-
setStatus
public void setStatus(int responseStatus)Description copied from interface:
VaadinResponseSets the (http) status code for the response. If you want to include an error message along the status code, use
VaadinResponse.sendError(int, String)instead.Specified by:
setStatusin interfaceVaadinResponseParameters:
responseStatus- the status code to setSee Also:
HttpServletResponse.setStatus(int),ResourceResponse.HTTP_STATUS_CODE
-
setHeader
public void setHeader(String name, String value)Description copied from interface:
VaadinResponseSets the value of a generic response header. If the header had already been set, the new value overwrites the previous one.
Specified by:
setHeaderin interfaceVaadinResponseParameters:
name- the name of the headervalue- the header value.See Also:
HttpServletResponse.setHeader(String, String),PortletResponse.setProperty(String, String)
-
setDateHeader
public void setDateHeader(String name, long timestamp)Description copied from interface:
VaadinResponseProperly formats a timestamp as a date header. If the header had already been set, the new value overwrites the previous one.
Specified by:
setDateHeaderin interfaceVaadinResponseParameters:
name- the name of the headertimestamp- the number of milliseconds since epochSee Also:
-
setCacheTime
public void setCacheTime(long milliseconds)Description copied from interface:
VaadinResponseSets 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.
Specified by:
setCacheTimein interfaceVaadinResponseParameters:
milliseconds- Cache time in milliseconds
-
sendError
public void sendError(int errorCode, String message) throws IOExceptionDescription copied from interface:
VaadinResponseSends 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.
Specified by:
sendErrorin interfaceVaadinResponseParameters:
errorCode- the HTTP status codemessage- a message to accompany the errorThrows:
IOException- if an input or output exception occursSee Also:
-
getService
public VaadinPortletService getService()Description copied from interface:
VaadinResponseGets the vaadin service for the context of this response.
Specified by:
getServicein interfaceVaadinResponseReturns:
the vaadin service
See Also:
-
addCookie
public void addCookie(Cookie cookie)Description copied from interface:
VaadinResponseAdds the specified cookie to the response. This method can be called multiple times to set more than one cookie.
Specified by:
addCookiein interfaceVaadinResponseParameters:
cookie- the Cookie to return to the clientSee Also:
HttpServletResponse.addCookie(Cookie),PortletResponse.addProperty(Cookie)
-
-