com.vasoftware.sf.soap44.webservices.filestorage
Interface IFileStorageAppSoap

public interface IFileStorageAppSoap

Provides SOAP web service for uploading/downloading files. Uploaded files are assigned a "tempoary session-specific key" which must be used within the SOAP session to create a document/FRS file/etc. Otherwise, the uploaded file is simply discarded. This service provides support for uploading/downloading files as attachments. Clients which are unable to use SOAP file attachments for uploading files, can use "SimpleFileStorageApp" service for uploading files in memory.

Change History

Version 4.4: No changes.

Since:

4.1

Method Summary

javax.activation.DataHandler	downloadFile(java.lang.String sessionId, java.lang.String fileId) Downloads file as SOAP attachment.
java.lang.String	uploadFile(java.lang.String sessionId, javax.activation.DataHandler file) Uploads a file as SOAP attachment.

Method Detail

uploadFile

java.lang.String uploadFile(java.lang.String sessionId,
                            javax.activation.DataHandler file)
                            throws java.rmi.RemoteException

Uploads a file as SOAP attachment. The returned file id can be used to associate the file with a document, frs file, etc. Note that a file can ONLY be associated with a single document or an frs file.

Parameters:

sessionId - User session id.

file - SOAP file attachment.

Returns:

File object id.

Throws:

com.vasoftware.sf.soap44.fault.InvalidSessionFault - when session is invalid (or not active).

com.vasoftware.sf.soap44.fault.SystemFault - when a system level error occurs.

java.rmi.RemoteException

Since:

4.1

downloadFile

javax.activation.DataHandler downloadFile(java.lang.String sessionId,
                                          java.lang.String fileId)
                                          throws java.rmi.RemoteException

Downloads file as SOAP attachment.

Parameters:

sessionId - User session id.

fileId - File object id.

Returns:

File as SOAP attachment.

Throws:

com.vasoftware.sf.soap44.fault.InvalidSessionFault - when session is invalid (or not active).

com.vasoftware.sf.soap44.fault.PermissionDeniedFault - when the user has insufficient privileges.

com.vasoftware.sf.soap44.fault.SystemFault - when a system level error occurs.

java.rmi.RemoteException

Since:

4.1