com.hds.hcpaw.fss.api.model

Class FileReadRequest

java.lang.Object

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

com.hds.hcpaw.fss.api.model.FileReadRequest

public abstract class FileReadRequest
extends BaseFssApiResource

A request to download 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 FileReadRequest	create(FssApiVersion apiVersion, java.io.InputStreamReader reader) Constructs a FileReadRequest from the JSON string representation contained in reader.
static FileReadRequest	create(FssApiVersion apiVersion, java.lang.String path, java.lang.String etag, java.lang.Boolean forceDownload) Returns a versioned FileReadRequest that is compatible with the specified apiVersion.
java.lang.String	getEtag() Returns the last known etag of the file to be read, or null if the file should be read regardless of its etag.
java.lang.Boolean	getForceDownload() If set to true, the server will always return the file version associated with the etag the client passes in, regardless of whether or not the client has the latest version.
static java.lang.Class<? extends FileReadRequest>	getFssApiClass(FssApiVersion apiVersion) Returns the Class of the FileReadRequest that corresponds to the specified apiVersion.
java.lang.String	getPath() Returns the path of the file to be read.
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 FileReadRequest> getFssApiClass(FssApiVersion apiVersion)
                                                                 throws AwUnsupportedApiVersionException

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

Parameters:

apiVersion - API version of the class to be returned

Returns:

the Class of the FileReadRequest that corresponds to the specified apiVersion

Throws:

AwUnsupportedApiVersionException

create

public static FileReadRequest create(FssApiVersion apiVersion,
                                     java.lang.String path,
                                     java.lang.String etag,
                                     java.lang.Boolean forceDownload)
                              throws AwUnsupportedApiVersionException

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

Parameters:

apiVersion - API version to be supported by the FileReadRequest

path - path of the file to be downloaded

etag - the etag of the file. If the etag of the file on the server matches this etag, it will not send the file

forceDownload - whether or not to force a download of the file version associated with the etag the user passes in.

Returns:

the constructed FileReadRequest

Throws:

AwUnsupportedApiVersionException

create

public static FileReadRequest create(FssApiVersion apiVersion,
                                     java.io.InputStreamReader reader)
                              throws AwJsonException,
                                     AwUnsupportedApiVersionException

Constructs a FileReadRequest from the JSON string representation contained in reader.

Parameters:

apiVersion - API version of the object to be read from reader

reader - contains the JSON string representation of a FileReadRequest

Returns:

the constructed FileReadRequest

Throws:

AwJsonException

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 read.

Returns:

path of the file to be read

getEtag

public java.lang.String getEtag()

Returns the last known etag of the file to be read, or null if the file should be read regardless of its etag.

Returns:

the etag of the file to be read. If provided, the api won't return the file's contents if the current file's etag matches this value.

getForceDownload

public java.lang.Boolean getForceDownload()

If set to true, the server will always return the file version associated with the etag the client passes in, regardless of whether or not the client has the latest version.

Returns:

whether or not the server will return the version of the file associated with the etag passed in.