Overview  Package   Class  Use  Deprecated  Index
Home >> All >> com >> flexstor >> flexdbserver >> services >> [ download overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---

com.flexstor.flexdbserver.services.download
Class DownloadService  

java.lang.Object
  com.flexstor.flexdbserver.services.download.DownloadService

All Implemented Interfaces:

com.flexstor.flexdbserver.services.Service

---

public class DownloadService

extends java.lang.Object

implements com.flexstor.flexdbserver.services.Service

DownloadService

This service copies the requested assets to a temporary location from where they can be downloaded using a browser.

Configurable Properties in roletype_services.config

In/Out Properties for Assets

Attribute	IN	OUT	Default IN	Default OUT
ROLE			ALL	ALL
Highres	X	X
Lowres	X	X
Thumbnail	X	X		X
Layout	X	X
Video	X	X
Audio	X	X
TYPE	X	X	ALL
FLAG
PARENT	X	X
CHLDREN	X	X		X
ALL	X	X
TEMP_PARENT	X	X
TEMP_CHILDREN	X	X
TEMP_ALL	X	X

Configurable Properties in flexstorweb.properties

flexstor.download.baseURL: The http URL corresponding to the baseDir where the assets are copied
Legal values: URL path (including the server name or IP address)

Input Data Object

com.flexstor.common.data.ActionData

Output Data Object

com.flexstor.common.data.ActionResult

Programmable Properties (passed inside data object)

Global Properties (apply to all assets)

"DestinationServer": (ActionPropertiesI.DESTINATION_SERVER) Specifies the destination server where the new file will be placed. Set in ActionData .
Data type: String
Legal values: Valid server name (Fully qualified name or server name only)

"DestinationLocation": (ActionPropertiesI.DESTINATION_LOCATION) Specifies the destination path where the new file will be placed. Set in ActionData .
Data type: String
Legal values: Valid path string

"EmailMessage": (ActionPropertiesI.EMAIL_MESSAGE) Specifies the email message body. Set in ActionData .
Data type: String
Legal values:

"EmailSubject": (ActionPropertiesI.EMAIL_SUBJECT) Specifies the email message subject. Set in ActionData .
Data type: String
Legal values:

"SendServiceType": (ActionPropertiesI.SEND_SERVICE_TYPE) Send service type selection. Set in ActionData
Data type: Integer
Legal values:

"KeepResourceFork": (ActionPropertiesI.KEEP_RESOURCE_FORK) If true, handle resource fork. Set in ActionData (defaults to false).
Data type: Boolean
Legal values:

---

Field Summary
protected  com.flexstor.common.data.ActionData	actionData
protected  boolean	bAbortService
protected  com.flexstor.common.data.ActionData	emailData
private  java.lang.String	fileSeparator
private  int	id
java.lang.String	IDENTIFIER
protected  java.lang.String	sAppServer
protected  java.lang.String	sDestinationLocation
private  com.flexstor.common.services.ServiceBrokerI	serviceBroker
protected  java.lang.String	sService
protected  java.lang.String	sThisService

 

Constructor Summary

DownloadService()

 

Method Summary
protected  com.flexstor.common.data.ActionResult	executeService(com.flexstor.common.data.ActionData actionData, java.lang.String serviceName)           Method to execute the service as given in the parameter
protected  java.lang.String[]	getDownloadURL(com.flexstor.common.data.ActionData data)           Convinient method to get the URL's
com.flexstor.common.data.ActionResult	go()           Method which implements the download service by calling the copy service followed by an email service if necessary
void	initData(com.flexstor.common.data.ActionData action)           Method to initialize the data used by this service.
void	setServiceContext(com.flexstor.flexdbserver.services.ServiceContext context)           Calls before the service is initialized (before initData is called) to pass information about the environment in which the service is running.

 

Methods inherited from class java.lang.Object

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

 

Field Detail

IDENTIFIER

public java.lang.String IDENTIFIER

---

sThisService

protected java.lang.String sThisService

---

sDestinationLocation

protected java.lang.String sDestinationLocation

---

sAppServer

protected java.lang.String sAppServer

---

sService

protected java.lang.String sService

---

bAbortService

protected boolean bAbortService

---

emailData

protected com.flexstor.common.data.ActionData emailData

---

actionData

protected com.flexstor.common.data.ActionData actionData

---

serviceBroker

private com.flexstor.common.services.ServiceBrokerI serviceBroker

---

fileSeparator

private java.lang.String fileSeparator

---

id

private int id

Constructor Detail

DownloadService

public DownloadService()

Method Detail

setServiceContext

public void setServiceContext(com.flexstor.flexdbserver.services.ServiceContext context)

Calls before the service is initialized (before initData is called) to pass information about the environment in which the service is running. This environment consists of information about the properties set for the service in one of these files (services.config, roletype_services.config, or *.ctl), plus methods to access other information such as an instance of the service broker to invoke other services, the transaction id for the service, file separator character and local path for the installation directory and configuration directory.

Specified by:

setServiceContext in interface com.flexstor.flexdbserver.services.Service

---

initData

public void initData(com.flexstor.common.data.ActionData action)

Method to initialize the data used by this service. Extracts the email data if any and also sets the destination

Specified by:

initData in interface com.flexstor.flexdbserver.services.Service

---

go

public com.flexstor.common.data.ActionResult go()

Method which implements the download service by calling the copy service followed by an email service if necessary

Specified by:

go in interface com.flexstor.flexdbserver.services.Service

---

getDownloadURL

protected java.lang.String[] getDownloadURL(com.flexstor.common.data.ActionData data)

Convinient method to get the URL's

---

executeService

protected com.flexstor.common.data.ActionResult executeService(com.flexstor.common.data.ActionData actionData,
                                                               java.lang.String serviceName)

Method to execute the service as given in the parameter

---

Overview  Package   Class  Use  Deprecated  Index
Home >> All >> com >> flexstor >> flexdbserver >> services >> [ download overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---