com.hds.hcpaw.fss.api.model

Class Link

java.lang.Object

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

com.hds.hcpaw.fss.api.model.Link

public abstract class Link
extends BaseFssApiResource

Holds information about how a link is configured.

Field Summary

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

UTF_8

Method Summary

Modifier and Type	Method and Description
static Link	create(FssApiVersion apiVersion, java.lang.String url, java.lang.String path, java.lang.Long expiration, boolean publicLink, java.lang.String accessCode, java.util.Set<LinkPermission> permission, java.lang.String token, LinkType type, java.lang.String itemName, boolean accessible) Returns a versioned Link that is compatible with the specified apiVersion.
java.lang.String	getAccessCode() Returns the access code for accessing this link.
java.lang.Long	getExpiration() Returns the number of milliseconds since epoch before this link expires.
static java.lang.Class<? extends Link>	getFssApiClass(FssApiVersion apiVersion) Returns the Class of the Link that corresponds to the specified apiVersion.
java.lang.String	getItemName() Returns the name of the file or folder that the link points to (as opposed to path, which is the full path of the file or folder).
java.util.Set<LinkPermission>	getLinkPermissions() Returns the permissions allowed on this link
java.lang.String	getPath() Returns the path of the link.
java.lang.String	getToken() Returns the token for the link
LinkType	getType() Returns the type of object that the link points to (FILE, FOLDER, or BROKEN).
java.lang.String	getUrl() Returns the URL of the link.
java.lang.Boolean	isAccessible() Return whether the link is active
java.lang.Boolean	isPublicLink() Returns whether or not this link is publicly accessible (accessible without a username and password).
protected 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 Link> getFssApiClass(FssApiVersion apiVersion)

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

Parameters:

apiVersion - API version of the class to be returned

Returns:

the Class of the Link that corresponds to the specified apiVersion

create

public static Link create(FssApiVersion apiVersion,
                          java.lang.String url,
                          java.lang.String path,
                          java.lang.Long expiration,
                          boolean publicLink,
                          java.lang.String accessCode,
                          java.util.Set<LinkPermission> permission,
                          java.lang.String token,
                          LinkType type,
                          java.lang.String itemName,
                          boolean accessible)
                   throws AwUnsupportedApiVersionException

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

Parameters:

apiVersion - API version to be supported by the Link

url - url to the link

path - path to the file or folder

expiration - number of milliseconds since epoch before this link will expire

publicLink - whether or not this link is publicly accessible (accessible without a username and password)

accessCode - the access code for this link

permission - the permissions for this link (read, write)

token - the token used to uniquely identify the link

type - the type of entry (FILE, FOLDER, BROKEN) the link points to.

itemName - the name of the entry the link points to.

accessible - the status of accessible

Returns:

the newly created link

Throws:

AwUnsupportedApiVersionException

getUrl

public java.lang.String getUrl()

Returns the URL of the link.

Returns:

the URL of the link

getToken

public java.lang.String getToken()

Returns the token for the link

Returns:

the token for this link

getPath

public java.lang.String getPath()

Returns the path of the link.

Returns:

the path of the link

getExpiration

public java.lang.Long getExpiration()

Returns the number of milliseconds since epoch before this link expires.

Returns:

the number of milliseconds since epoch before this link expires

isPublicLink

public java.lang.Boolean isPublicLink()

Returns whether or not this link is publicly accessible (accessible without a username and password).

Returns:

whether or not this link is publicly accessible (accessible without a username and password)

getAccessCode

public java.lang.String getAccessCode()

Returns the access code for accessing this link. If a link is created with an access code, the access code is required in order to access the file or folder.

Returns:

the access code for the link. If null, the link does not have an access code

getType

public LinkType getType()

Returns the type of object that the link points to (FILE, FOLDER, or BROKEN).

Returns:

The type of object the link points to.

getLinkPermissions

public java.util.Set<LinkPermission> getLinkPermissions()

Returns the permissions allowed on this link

Returns:

the permissions allowed on this link

getItemName

public java.lang.String getItemName()

Returns the name of the file or folder that the link points to (as opposed to path, which is the full path of the file or folder).

Returns:

the name of the file or folder that the link points to (as opposed to path, which is the full path of the file or folder).

isAccessible

public java.lang.Boolean isAccessible()

Return whether the link is active

Returns:

Whether or not the link is active and accessible

validate

protected 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)