com.hds.hcpaw.fss.api.model

Class FileUpdateRequest

java.lang.Object

com.hds.hcpaw.fss.api.model.BaseFssApiResource

com.hds.hcpaw.fss.api.model.FileUpdateRequest

public abstract class FileUpdateRequest
extends BaseFssApiResource

A request to update (upload a new version of) a file.

Field Summary

Fields inherited from class com.hds.hcpaw.fss.api.model.BaseFssApiResource

UTF_8

Method Summary

Modifier and Type	Method and Description
static FileUpdateRequest	create(FssApiVersion apiVersion, java.lang.String path, java.lang.Long size, java.lang.String hash, java.lang.String etag, java.lang.Long changeTime, java.lang.Long accessTime, java.io.InputStream input) Returns a versioned FileUpdateRequest that is compatible with the specified apiVersion.
java.lang.Long	getAccessTime() Returns the Last Accessed time of the file created.
java.lang.Long	getChangeTime() Returns the modified time of the file created.
java.lang.String	getEtag() Returns the current etag of the file to be updated.
static java.lang.Class<? extends FileUpdateRequest>	getFssApiClass(FssApiVersion apiVersion) Returns the Class of the FileUpdateRequest that corresponds to the specified apiVersion.
java.lang.String	getHash() Returns the SHA-384 hash of the new file being uploaded, represented as a hex string.
java.io.InputStream	getInput() Returns the InputStream containing the contents of the file being uploaded.
java.lang.String	getPath() Returns the path of the file to be updated.
java.lang.Long	getSize() Returns the size (in bytes) of the new file being uploaded.
void	validate(java.lang.String fieldName, BaseFssApiResource parent) Validates this object.

Methods inherited from class com.hds.hcpaw.fss.api.model.BaseFssApiResource

badValue, badValue, fromJson, toJson, toJson, toString, validate, validateFieldInRange, validateFieldInRange, validateFieldIsNull, validateFieldNotNull, validateLocale, validateOptionalField, validateOptionalFieldList, validateRequiredField, validateRequiredFieldList, writeToOutputStream

Methods inherited from class java.lang.Object

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

Method Detail

getFssApiClass

public static java.lang.Class<? extends FileUpdateRequest> getFssApiClass(FssApiVersion apiVersion)
                                                                   throws AwUnsupportedApiVersionException

Returns the Class of the FileUpdateRequest that corresponds to the specified apiVersion.

Parameters:

apiVersion - API version of the class to be returned

Returns:

the Class of the FileUpdateRequest that corresponds to the specified apiVersion

Throws:

AwUnsupportedApiVersionException

create

public static FileUpdateRequest create(FssApiVersion apiVersion,
                                       java.lang.String path,
                                       java.lang.Long size,
                                       java.lang.String hash,
                                       java.lang.String etag,
                                       java.lang.Long changeTime,
                                       java.lang.Long accessTime,
                                       java.io.InputStream input)
                                throws AwUnsupportedApiVersionException

Returns a versioned FileUpdateRequest that is compatible with the specified apiVersion.

Parameters:

apiVersion - API version to be supported by the FileUpdateRequest

path - path of the file to update

size - size (in bytes) of the new file being uploaded.

hash - the SHA-384 hash of the new file being uploaded, represented as a hex string (optional)

etag - the etag of the current file at the specified path

input - contains the contents of the file being uploaded

Returns:

the constructed FileUpdateRequest.

Throws:

AwUnsupportedApiVersionException

validate

public void validate(java.lang.String fieldName,
                     BaseFssApiResource parent)
              throws AwJsonException

Validates this object.

Specified by:

validate in class BaseFssApiResource

Parameters:

fieldName - name of this object in the parent (containing) object. If this object is a top-level object (not contained within another object), then enter null for this parameter

parent - parent (containing) object that contains the object specified in the fieldName parameter. If this object is a top-level object (not contained within another object), then enter null for this parameter

Throws:

AwJsonException - if any validation errors occur

See Also:

BaseFssApiResource.validate(String, BaseFssApiResource)

getPath

public java.lang.String getPath()

Returns the path of the file to be updated.

Returns:

the path of the file to be updated

getEtag

public java.lang.String getEtag()

Returns the current etag of the file to be updated.

Returns:

the current etag of the file to be updated

getSize

public java.lang.Long getSize()

Returns the size (in bytes) of the new file being uploaded.

Returns:

the size (in bytes) of the new file being uploaded

getChangeTime

public java.lang.Long getChangeTime()

Returns the modified time of the file created.

Returns:

the modified time of the file created.

getAccessTime

public java.lang.Long getAccessTime()

Returns the Last Accessed time of the file created.

Returns:

the Last Accessed time of the file created.

getHash

public java.lang.String getHash()

Returns the SHA-384 hash of the new file being uploaded, represented as a hex string.

Returns:

the SHA-384 hash of the new file being uploaded, represented as a hex string

getInput

public java.io.InputStream getInput()

Returns the InputStream containing the contents of the file being uploaded.

Returns:

the InputStream containing the contents of the file being uploaded