org.alfresco.bm.process.share.site

Class FileDownloadEventProcess

java.lang.Object

org.alfresco.bm.event.AbstractEventProcessor

org.alfresco.bm.process.share.AbstractShareEventProcessor

org.alfresco.bm.process.share.site.FileDownloadEventProcess

All Implemented Interfaces:

org.alfresco.bm.event.EventProcessor, org.springframework.beans.factory.Aware, org.springframework.beans.factory.BeanNameAware

public class FileDownloadEventProcess
extends AbstractShareEventProcessor

Click and download the file

Input

DocumentDetailsPage showing the file details

Actions

Downloads the file to local disk

Output

EVENT_NAME_DOWNLOAD_DOCUMENT_COMPLETE: DocumentDetailsPage in ShareEventData

Since:

1.0

Author:

Derek Hulley

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	DEFAULT_DOWNLOAD_VIA_CLICK
static String	EVENT_NAME_DOWNLOAD_DOCUMENT_COMPLETE

Fields inherited from class org.alfresco.bm.process.share.AbstractShareEventProcessor

eventNameActionComplete, logger, sessionService, userDataService

Fields inherited from class org.alfresco.bm.event.AbstractEventProcessor

DEFAULT_AUTO_CLOSE_SESSION_ID, DEFAULT_AUTO_PROPAGATE_SESSION_ID, DEFAULT_CHART, DEFAULT_WARN_DELAY

Constructor Summary

Constructors

Constructor and Description
FileDownloadEventProcess(org.alfresco.bm.user.UserDataService userDataService)

Method Summary

Modifier and Type	Method and Description
org.alfresco.bm.event.EventResult	processEvent(org.alfresco.bm.event.Event event, ShareEventData eventData) Process a share based event.
void	setDownloadDir(String downloadDir) Set the location where the browser will be putting files.
void	setDownloadViaClick(boolean downloadViaClick) Override the default method of executing the file download (default:false).

Methods inherited from class org.alfresco.bm.process.share.AbstractShareEventProcessor

closeWebDriver, getUserData, processEvent, setEventNameActionComplete, setSessionService

Methods inherited from class org.alfresco.bm.event.AbstractEventProcessor

getName, getWarnDelay, isAutoCloseSessionId, isAutoPropagateSessionId, isChart, processEvent, register, resumeTimer, setAutoCloseSessionId, setAutoPropagateSessionId, setBeanName, setChart, setEventName, setEventNames, setRegistry, setWarnDelay, stopTimer, suspendTimer, toString

Methods inherited from class java.lang.Object

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

Field Detail

EVENT_NAME_DOWNLOAD_DOCUMENT_COMPLETE

public static final String EVENT_NAME_DOWNLOAD_DOCUMENT_COMPLETE

See Also:

Constant Field Values

DEFAULT_DOWNLOAD_VIA_CLICK

public static final boolean DEFAULT_DOWNLOAD_VIA_CLICK

See Also:

Constant Field Values

Constructor Detail

FileDownloadEventProcess

public FileDownloadEventProcess(org.alfresco.bm.user.UserDataService userDataService)

Parameters:

userDataService - service to provide user data

downloadDirectory - the directory where downloaded files are stored. Use empty string (or null) to indicate that the location is unknown.

Method Detail

setDownloadViaClick

public void setDownloadViaClick(boolean downloadViaClick)

Override the default method of executing the file download (default:false).

Parameters:

downloadViaClick - true to have the browser click the link and download the file to the browser's download directory; the is less reliable than true, which uses a HTTP client to download the file directly.

setDownloadDir

public void setDownloadDir(String downloadDir)

Set the location where the browser will be putting files. If this is not known, do not set anything.

Parameters:

downloadDir - a path to a folder that must exist (null allowed)

processEvent

public org.alfresco.bm.event.EventResult processEvent(org.alfresco.bm.event.Event event,
                                                      ShareEventData eventData)
                                               throws Exception

Description copied from class: AbstractShareEventProcessor

Process a share based event.

Specified by:

processEvent in class AbstractShareEventProcessor

Parameters:

event - the origininating event (not normally required)

eventData - the share event data entity

Returns:

EventResult the result of the process (includes errors and next events)

Throws:

Exception