com.whitestein.lsps.vaadin.ui.components

Class UIFileResource

java.lang.Object

com.vaadin.server.StreamResource

com.whitestein.lsps.vaadin.ui.components.UIFileResource

All Implemented Interfaces:

com.vaadin.server.ConnectorResource, com.vaadin.server.Resource, ResourceDownloadHandler, Serializable

public class UIFileResource
extends com.vaadin.server.StreamResource
implements ResourceDownloadHandler

Stream source, which provides access to content defined by core::File. If there is an instance of UIComponent provided, there is a new Events.FILE_DOWNLOAD_EVENT_TYPE event created when the resource is used.

Author:

mbj

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.vaadin.server.StreamResource

com.vaadin.server.StreamResource.StreamSource

Field Summary

Fields inherited from interface com.vaadin.server.ConnectorResource

CONNECTOR_PATH

Constructor Summary

Constructors

Constructor and Description
UIFileResource(Variant.ClosureVariant closure, UIComponent uiComponent, boolean fireDownloadEvent, boolean forceSave) Full constructor.

Method Summary

Modifier and Type	Method and Description
com.vaadin.server.DownloadStream	getStream()
boolean	handleResourceDownload(com.vaadin.server.VaadinRequest req, com.vaadin.server.VaadinResponse resp) Writes the resource content to the response object.

Methods inherited from class com.vaadin.server.StreamResource

equals, getBufferSize, getCacheTime, getFilename, getMIMEType, getStreamSource, hashCode, setBufferSize, setCacheTime, setFilename, setMIMEType, setStreamSource

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.vaadin.server.Resource

getMIMEType

Constructor Detail

UIFileResource

public UIFileResource(Variant.ClosureVariant closure,
                      UIComponent uiComponent,
                      boolean fireDownloadEvent,
                      boolean forceSave)

Full constructor. If the component is set, the download will trigger a download event originating from that component. The stream can be optionally send in a way so that the browser is forced to ask the user to save the file.

Parameters:

closure - a closure which returns the File RecordHolder. Not null.

uiComponent - not null. Closure is run in the context of this component. Also, UI download event is fired in context of this component.

fireDownloadEvent - true if the download should trigger a download event

forceSave - true if the browser should ask the user to save the file

Method Detail

getStream

public com.vaadin.server.DownloadStream getStream()

Specified by:

getStream in interface com.vaadin.server.ConnectorResource

Overrides:

getStream in class com.vaadin.server.StreamResource

handleResourceDownload

public boolean handleResourceDownload(com.vaadin.server.VaadinRequest req,
                                      com.vaadin.server.VaadinResponse resp)
                               throws IOException

Description copied from interface: ResourceDownloadHandler

Writes the resource content to the response object. Should be used in UIComponent#handleConnectorRequest(VaadinRequest, VaadinResponse, String) when UIFileResource is used so that the request returns 404 error instead of server error.

DO *not* call with Vaadin session lock - blocks until the file is downloaded by the client.

Specified by:

handleResourceDownload in interface ResourceDownloadHandler

Returns:

true if there was any resource

Throws:

IOException