com.hds.hcpaw.fss.api.model

Class FileAccessEntry

java.lang.Object

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

com.hds.hcpaw.fss.api.model.FileAccessEntry

public class FileAccessEntry
extends BaseFssApiResource

Field Summary

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

UTF_8

Method Summary

Modifier and Type	Method and Description
static FileAccessEntry	create(FssApiVersion apiVersion, java.lang.String filename, java.lang.String username, java.lang.Long size, java.lang.Long timestamp, int nanos, java.lang.Short tsExtra) Returns a versioned FileAccessEntry that is compatible with the specified apiVersion.
boolean	equals(java.lang.Object o)
java.lang.String	getFilename() Returns the name of the file
static java.lang.Class<? extends FileAccessEntry>	getFssApiClass(FssApiVersion apiVersion) Returns the Class of the FileAccessEntry that corresponds to the specified apiVersion.
int	getNanos() Returns the nanoseconds associated with the file time
java.lang.Long	getSize() Returns the size of the version in string form
java.lang.Long	getTimestamp() Returns the time that the entry was read
java.lang.Short	getTsExtra() Returns the tsExtra value associated with the version
java.lang.String	getUsername() Returns the name of the user that read the file
int	hashCode()
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, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

getFssApiClass

public static java.lang.Class<? extends FileAccessEntry> getFssApiClass(FssApiVersion apiVersion)

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

Parameters:

apiVersion - API version of the class to be returned

Returns:

the Class of the entry that corresponds to the specified apiVersion

create

public static FileAccessEntry create(FssApiVersion apiVersion,
                                     java.lang.String filename,
                                     java.lang.String username,
                                     java.lang.Long size,
                                     java.lang.Long timestamp,
                                     int nanos,
                                     java.lang.Short tsExtra)
                              throws AwUnsupportedApiVersionException

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

Parameters:

filename - Name of file that was read

username - Name of user that read the file

size - size (in bytes) of the entry. This parameter is only applicable to files.

timestamp - Time of the access event.

nanos - Nanoseconds associated with the timestamp

tsExtra - Timestamp qualifier

Returns:

a versioned instance of FileAccessEntry that supports the specified apiVersion

Throws:

AwUnsupportedApiVersionException - The specified API version is not supported

getFilename

public java.lang.String getFilename()

Returns the name of the file

Returns:

the name of the file

getUsername

public java.lang.String getUsername()

Returns the name of the user that read the file

Returns:

name of the user that read the file

getSize

public java.lang.Long getSize()

Returns the size of the version in string form

Returns:

size of the version in string form

getTimestamp

public java.lang.Long getTimestamp()

Returns the time that the entry was read

Returns:

time that the entry was read

getNanos

public int getNanos()

Returns the nanoseconds associated with the file time

Returns:

the nanoseconds associated with the file time

getTsExtra

public java.lang.Short getTsExtra()

Returns the tsExtra value associated with the version

Returns:

the tsExtra value associated with the version

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)

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object