com.uc4.communication.requests

Class UploadBinary

java.lang.Object

com.uc4.communication.requests.XMLRequest

com.uc4.communication.requests.UploadBinary

public class UploadBinary
extends XMLRequest

Adds or replaces a file in a STORE object.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	UploadBinary.ContentType Content-type of the file (BINARY, TEXT,...).

Field Summary

Fields

Modifier and Type	Field and Description
static int	MAX_UPLOAD_SIZE Max file size in bytes for uploads.

Constructor Summary

Constructors

Constructor and Description
UploadBinary(UC4ObjectName storeObject, String entryName, PlatformSwHwType osPlatformHw, boolean isUpdate, ByteBuffer buffer) Creates a new request to upload a file to a STORE object.
UploadBinary(UC4ObjectName storeObject, String entryName, PlatformSwHwType osPlatformHw, boolean isUpdate, File inputFile) Creates a new request to upload a file to a STORE object.

Method Summary

Modifier and Type	Method and Description
long	getContentLen() Returns the length of the upload-content.
String	getEntryName() Return the entryName used for the Data to transfer.
Exception	getFileException() Returns the Exception that occured during the reading of the inputFile or null if it was successful.
boolean	isFileUploadOK() Returns true if the inputFile was uploaded successfully.
void	setContentType(UploadBinary.ContentType contentType) Sets the content type.
void	setFileName(String fileName) Set the resource file name.
void	setVersion(String version) Set the resource version.

Methods inherited from class com.uc4.communication.requests.XMLRequest

getAllMessageBoxes, getMessageBox, getRequestID, handleResponse, send, showQuarantineNotification

Methods inherited from class java.lang.Object

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

Field Detail

MAX_UPLOAD_SIZE

public static final int MAX_UPLOAD_SIZE

Max file size in bytes for uploads.

See Also:

Constant Field Values

Constructor Detail

UploadBinary

public UploadBinary(UC4ObjectName storeObject,
                    String entryName,
                    PlatformSwHwType osPlatformHw,
                    boolean isUpdate,
                    File inputFile)

Creates a new request to upload a file to a STORE object.

Parameters:

storeObject - Name of the STORE object.

entryName - Name of the entry in the STORE object

osPlatformHw - Combined type of OS, Platform, HW of the entry.

isUpdate - Must be set to true if a resource should be updated.

inputFile - File which should be uploaded

UploadBinary

public UploadBinary(UC4ObjectName storeObject,
                    String entryName,
                    PlatformSwHwType osPlatformHw,
                    boolean isUpdate,
                    ByteBuffer buffer)

Creates a new request to upload a file to a STORE object.

Parameters:

storeObject - Name of the STORE object

entryName - Name of the entry which is used to identify the file.

osPlatformHw - Combined type of OS, Platform, HW of the entry.

isUpdate - Must be set to true if a resource should be updated.

buffer - File content

Method Detail

setVersion

public void setVersion(String version)

Set the resource version.

Parameters:

version - Version

setFileName

public void setFileName(String fileName)

Set the resource file name.

Parameters:

fileName - Name of the file

setContentType

public void setContentType(UploadBinary.ContentType contentType)

Sets the content type.

Parameters:

contentType - content-type of the file

getEntryName

public String getEntryName()

Return the entryName used for the Data to transfer.

Returns:

The entryName as String

isFileUploadOK

public boolean isFileUploadOK()

Returns true if the inputFile was uploaded successfully. If this method returns false there are two possible error-sources:

• FileError: check getFileException()
• UploadError: check getMessageBox()

Returns:

True if the inputFile was uploaded successfully.

getFileException

public Exception getFileException()

Returns the Exception that occured during the reading of the inputFile or null if it was successful.

Returns:

Exception or null

getContentLen

public long getContentLen()

Returns the length of the upload-content.

Returns:

binary data length