Class SimpleFileStorageAppSoapStub
java.lang.Object
com.collabnet.ce.soap60.webservices.ClientSoapStub
com.collabnet.ce.soap60.webservices.filestorage.SimpleFileStorageAppSoapStub
- All Implemented Interfaces:
ISimpleFileStorageAppSoap
public class SimpleFileStorageAppSoapStub
extends ClientSoapStub
implements ISimpleFileStorageAppSoap
-
Field Summary
Fields inherited from class com.collabnet.ce.soap60.webservices.ClientSoapStub
DEFAULT_CLIENT_TIME_OUT
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
endFileUpload
(String sessionId, String fileStorageId) Closes and saves uploaded file.long
Returns size of the specified temporary storage file in bytes.byte[]
Reads from file a specified a number of bytes from the offset specified.byte[]
Reads from file a specified a number of bytes from the offset specified.startFileUpload
(String sessionId) Opens a new file descriptor for uploading and returns the temporary storage id.void
Appends data to the file being uploaded.Methods inherited from class com.collabnet.ce.soap60.webservices.ClientSoapStub
getServiceCall, getSoapServer, getTimeout, setTimeout, soapParam
-
Constructor Details
-
SimpleFileStorageAppSoapStub
-
-
Method Details
-
startFileUpload
Description copied from interface:ISimpleFileStorageAppSoap
Opens a new file descriptor for uploading and returns the temporary storage id.- Specified by:
startFileUpload
in interfaceISimpleFileStorageAppSoap
- Parameters:
sessionId
- User session id.- Returns:
- File storage id.
- Throws:
InvalidSessionFault
- when the specified session id is invalid.SystemFault
- when an unexpected system level error is encountered.RemoteException
-
write
Description copied from interface:ISimpleFileStorageAppSoap
Appends data to the file being uploaded.- Specified by:
write
in interfaceISimpleFileStorageAppSoap
- Parameters:
sessionId
- User session id.fileStorageId
- Id of temporary file storage for the file being uploaded.data
- Data to be uploaded.- Throws:
InvalidSessionFault
- when the specified session id is invalid.SystemFault
- when an unexpected system level error is encountered.IllegalArgumentFault
- when the specified fileStorageId is invalid.RemoteException
-
endFileUpload
Description copied from interface:ISimpleFileStorageAppSoap
Closes and saves uploaded file.- Specified by:
endFileUpload
in interfaceISimpleFileStorageAppSoap
- Parameters:
sessionId
- User session id.fileStorageId
- Id of temporary file storage for the file to finish uploading.- Throws:
InvalidSessionFault
- when the specified session id is invalid.SystemFault
- when an unexpected system level error is encountered.IllegalArgumentFault
- when the specified fileStorageId is invalid.RemoteException
-
getSize
Description copied from interface:ISimpleFileStorageAppSoap
Returns size of the specified temporary storage file in bytes.- Specified by:
getSize
in interfaceISimpleFileStorageAppSoap
- Parameters:
sessionId
- User session id.fileStorageId
- Id of temporary file storage.- Returns:
- File size in number of bytes.
- Throws:
InvalidSessionFault
- when the specified session id is invalid.SystemFault
- when an unexpected system level error is encountered.IllegalArgumentFault
- when the specified fileStorageId is invalid.RemoteException
-
read
public byte[] read(String sessionId, String fileStorageId, int offset, int length) throws RemoteException Description copied from interface:ISimpleFileStorageAppSoap
Reads from file a specified a number of bytes from the offset specified.- Specified by:
read
in interfaceISimpleFileStorageAppSoap
- Parameters:
sessionId
- User session id.fileStorageId
- Id of temporary file storageoffset
- Offset within file from where to read.length
- Number of bytes to read.- Returns:
- Data read from the file as a byte array. Returns null on file end.
- Throws:
InvalidSessionFault
- when the specified session id is invalid.SystemFault
- when an unexpected system level error is encountered.PermissionDeniedFault
- when the user doesn't have permission to view the fileIllegalArgumentFault
- when the specified fileStorageId is invalid.RemoteException
-
read2
public byte[] read2(String sessionId, String fileStorageId, long offset, int length) throws RemoteException Description copied from interface:ISimpleFileStorageAppSoap
Reads from file a specified a number of bytes from the offset specified.- Specified by:
read2
in interfaceISimpleFileStorageAppSoap
- Parameters:
sessionId
- User session id.fileStorageId
- Id of temporary file storageoffset
- Offset within file from where to read (long).length
- Number of bytes to read.- Returns:
- Data read from the file as a byte array. Returns null on file end.
- Throws:
InvalidSessionFault
- when the specified session id is invalid.SystemFault
- when an unexpected system level error is encountered.PermissionDeniedFault
- when the user doesn't have permission to view the fileIllegalArgumentFault
- when the specified fileStorageId is invalid.RemoteException
-