com.hds.hcpaw.fss.api

Class AnywhereLinkAPI

java.lang.Object

com.hds.hcpaw.fss.api.AnywhereLinkAPI

public class AnywhereLinkAPI
extends java.lang.Object

API for performing link actions such as create link. These methods are implemented using the HCP Anywhere FSS API /fss/public/link URIs.

See the method AnywhereAPI.getLinkAPI() to obtain an instance of the AnywhereLinkAPI.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AnywhereLinkAPI(AnywhereConnector connector)

Method Summary

Modifier and Type	Method and Description
LinkBrowseListing	browsePrivateLink(AuthToken authToken, java.lang.String linkToken, java.lang.String itemName, java.lang.String accessCode, java.lang.String path, java.lang.String pageToken, int pageSize, FolderListingRequest.SortingCriterion sortingCriterion, FolderListingRequest.SortingDirection sortingDirection) Browse a private link
LinkBrowseListing	browsePublicLink(AuthToken authToken, java.lang.String linkToken, java.lang.String itemName, java.lang.String accessCode, java.lang.String path, java.lang.String pageToken, int pageSize, FolderListingRequest.SortingCriterion sortingCriterion, FolderListingRequest.SortingDirection sortingDirection) Browse a public link
void	copyFilesToLocalPrivateLink(AuthToken authToken, java.lang.String linkToken, java.lang.String itemName, java.lang.String accessCode, java.util.List<java.lang.String> pathList, java.lang.String destinationPath) Copy files to local from a private link
void	copyFilesToLocalPublicLink(AuthToken authToken, java.lang.String linkToken, java.lang.String itemName, java.lang.String accessCode, java.util.List<java.lang.String> pathList, java.lang.String destinationPath) Copy files to local from a public link
Link	create(AuthToken authToken, java.lang.String path, java.lang.Integer expirationDays, java.lang.Boolean publicLink, boolean accessCode, java.util.Set<LinkPermission> permissions) Deprecated.
Link	create(AuthToken authToken, java.lang.String path, java.lang.Integer expirationDays, java.lang.Boolean publicLink, boolean accessCode, java.util.Set<LinkPermission> permissions, java.lang.String uniqueId) Creates a link to the file or folder using it's Unique ID
Entry	createFilePrivateLink(AuthToken authToken, java.lang.String linkToken, java.lang.String itemName, java.lang.String accessCode, java.lang.String path, java.lang.Long size, java.lang.String hash, java.lang.Boolean createParents, java.io.InputStream contentIn) Upload a file to a private link with upload access
Entry	createFilePublicLink(AuthToken authToken, java.lang.String linkToken, java.lang.String itemName, java.lang.String accessCode, java.lang.String path, java.lang.Long size, java.lang.String hash, java.lang.Boolean createParents, java.io.InputStream contentIn) Upload a file to a public link with upload access
void	delete(AuthToken authToken, java.lang.String url) Deletes the specified link.
void	delete(AuthToken authToken, java.lang.String path, java.lang.String url) Deprecated.
Entry	getPrivateLinkPathMetadata(AuthToken authToken, java.lang.String linkToken, java.lang.String itemName, java.lang.String accessCode, java.lang.String path) Read entry metadata from private link
Entry	getPublicLinkPathMetadata(AuthToken authToken, java.lang.String linkToken, java.lang.String itemName, java.lang.String accessCode, java.lang.String path) Read entry metadata from public link
LinkListing	list(AuthToken authToken) List a user's links
LinkListing	list(AuthToken authToken, java.lang.String filter, java.lang.String pageToken, java.lang.Integer pageSize, LinkListRequest.LinkSortingCriterion sortingCriterion, FolderListingRequest.SortingDirection sortingDirection) List a user's links.
void	multiFileDownloadPrivateLink(AuthToken authToken, java.util.List<java.lang.String> pathList, java.lang.String linkToken, java.lang.String itemName, java.lang.String accessCode, java.io.OutputStream out) Download multiple files as zip from a private link
void	multiFileDownloadPublicLink(AuthToken authToken, java.util.List<java.lang.String> pathList, java.lang.String linkToken, java.lang.String itemName, java.lang.String accessCode, java.io.OutputStream out) Download multiple files as zip from a public link
Entry	readFilePrivateLink(AuthToken authToken, java.lang.String linkToken, java.lang.String itemName, java.lang.String accessCode, java.lang.String path, java.lang.String etag, java.io.OutputStream out) Read file from a private link
Entry	readFilePublicLink(AuthToken authToken, java.lang.String linkToken, java.lang.String itemName, java.lang.String accessCode, java.lang.String path, java.lang.String etag, java.io.OutputStream out) Read file from a public link
Link	update(AuthToken authToken, java.lang.String url, boolean updateAccessCode, java.lang.Long expirationDate) Update the link
Link	update(AuthToken authToken, java.lang.String path, java.lang.String url, boolean updateAccessCode, java.lang.Long expirationDate) Deprecated.
Entry	updateFilePrivateLink(AuthToken authToken, java.lang.String linkToken, java.lang.String itemName, java.lang.String accessCode, java.lang.String path, java.lang.Long size, java.lang.String hash, java.lang.String etag, java.io.InputStream contentIn) Update file through a private link
Entry	updateFilePublicLink(AuthToken authToken, java.lang.String linkToken, java.lang.String itemName, java.lang.String accessCode, java.lang.String path, java.lang.Long size, java.lang.String hash, java.lang.String etag, java.io.InputStream contentIn) Update file through a public link

Methods inherited from class java.lang.Object

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

Constructor Detail

AnywhereLinkAPI

protected AnywhereLinkAPI(AnywhereConnector connector)

Method Detail

create

@Deprecated
public Link create(AuthToken authToken,
                               java.lang.String path,
                               java.lang.Integer expirationDays,
                               java.lang.Boolean publicLink,
                               boolean accessCode,
                               java.util.Set<LinkPermission> permissions)
                        throws AwUnsupportedApiVersionException,
                               java.io.IOException,
                               AnywhereException

Deprecated.

Creates a link to the file or folder at the specified path.

Parameters:

authToken - authentication token for the user performing the request

path - path (including file name) where the link is to be created

expirationDays - optionally, the number of days that the link remains active. If null, then the default number of days from the server will be used

publicLink - optionally, whether the link is publicly accessible (accessible without providing login credentials). If null, then the server default will be used

accessCode - whether to protect the link with an access code

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

Returns:

the newly created link

Throws:

AwUnsupportedApiVersionException - if this method is not supported by the server due to the server's supported API versions

AwNotFoundException - if the path does not exist

AwInvalidRequestException - if the request is invalid; for example, if the expiration is invalid or if you try to create an upload link to a file,

java.io.IOException

AnywhereException

create

public Link create(AuthToken authToken,
                   java.lang.String path,
                   java.lang.Integer expirationDays,
                   java.lang.Boolean publicLink,
                   boolean accessCode,
                   java.util.Set<LinkPermission> permissions,
                   java.lang.String uniqueId)
            throws AwUnsupportedApiVersionException,
                   java.io.IOException,
                   AnywhereException

Creates a link to the file or folder using it's Unique ID

Parameters:

authToken - authentication token for the user performing the request

expirationDays - optionally, the number of days that the link remains active. If null, then the default number of days from the server will be used

publicLink - optionally, whether the link is publicly accessible (accessible without providing login credentials). If null, then the server default will be used

accessCode - whether to protect the link with an access code

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

uniqueId - unique id of the file or folder where the link is to be created

Returns:

the newly created link

Throws:

AwUnsupportedApiVersionException - if this method is not supported by the server due to the server's supported API versions

AwNotFoundException - if the path does not exist

AwInvalidRequestException - if the request is invalid; for example, if the expiration is invalid or if you try to create an upload link to a file,

java.io.IOException

AnywhereException

delete

@Deprecated
public void delete(AuthToken authToken,
                               java.lang.String path,
                               java.lang.String url)
                        throws AwUnsupportedApiVersionException,
                               java.io.IOException,
                               AnywhereException

Deprecated.

Deletes the specified link.

Parameters:

authToken - authentication token for the user performing the request

path - path (including file name) of the link

url - url of the link

Throws:

AwUnsupportedApiVersionException

java.io.IOException

AnywhereException

delete

public void delete(AuthToken authToken,
                   java.lang.String url)
            throws AwUnsupportedApiVersionException,
                   java.io.IOException,
                   AnywhereException

Deletes the specified link.

Parameters:

authToken - authentication token for the user performing the request

url - url of the link

Throws:

AwUnsupportedApiVersionException

java.io.IOException

AnywhereException

update

@Deprecated
public Link update(AuthToken authToken,
                               java.lang.String path,
                               java.lang.String url,
                               boolean updateAccessCode,
                               java.lang.Long expirationDate)
                        throws AwUnsupportedApiVersionException,
                               java.io.IOException,
                               AnywhereException

Deprecated.

Update the link

Parameters:

authToken - authentication token for the user performing the request

path - path (including file name) of the link

url - url of the link

updateAccessCode - whether or not to create a new access code

expirationDate - expiration date of the link

Returns:

Throws:

AwUnsupportedApiVersionException

java.io.IOException

AnywhereException

update

public Link update(AuthToken authToken,
                   java.lang.String url,
                   boolean updateAccessCode,
                   java.lang.Long expirationDate)
            throws AwUnsupportedApiVersionException,
                   java.io.IOException,
                   AnywhereException

Update the link

Parameters:

authToken - authentication token for the user performing the request

url - url of the link

updateAccessCode - whether or not to create a new access code

expirationDate - expiration date of the link

Returns:

Throws:

AwUnsupportedApiVersionException

java.io.IOException

AnywhereException

list

public LinkListing list(AuthToken authToken)
                 throws AwUnsupportedApiVersionException,
                        java.io.IOException,
                        AnywhereException

List a user's links

Parameters:

authToken -

Returns:

Throws:

AwUnsupportedApiVersionException

java.io.IOException

AnywhereException

list

public LinkListing list(AuthToken authToken,
                        java.lang.String filter,
                        java.lang.String pageToken,
                        java.lang.Integer pageSize,
                        LinkListRequest.LinkSortingCriterion sortingCriterion,
                        FolderListingRequest.SortingDirection sortingDirection)
                 throws AwUnsupportedApiVersionException,
                        java.io.IOException,
                        AnywhereException

List a user's links.

Parameters:

authToken -

filter - A filter to apply to the results, filtering out any results that don't match the string.

pageToken - if null, the first page of entries are returned. To return the next page of entries, use the pageToken that was returned in the previous call

pageSize - The number of results to return.

sortingCriterion - How the links should be ordered in the response (NAME, EXPIRATION, PUBLIC, HAS_ACCESS_CODE, PERMISSIONS)

sortingDirection - Whether the links should be ordered in ascending or descending order (ASC, DESC).

Returns:

Throws:

AwUnsupportedApiVersionException

java.io.IOException

AnywhereException

getPublicLinkPathMetadata

public Entry getPublicLinkPathMetadata(AuthToken authToken,
                                       java.lang.String linkToken,
                                       java.lang.String itemName,
                                       java.lang.String accessCode,
                                       java.lang.String path)
                                throws AwUnsupportedApiVersionException,
                                       java.io.IOException,
                                       AnywhereException

Read entry metadata from public link

Parameters:

authToken - authentication token for the user performing the request

linkToken - Link token of the link

itemName - The name of the folder that the link points to

accessCode - Access code of the link

path - path of the entry relative to the link

Returns:

metadata about the file or folder at the specified path

Throws:

AwUnsupportedApiVersionException

java.io.IOException

AnywhereException

getPrivateLinkPathMetadata

public Entry getPrivateLinkPathMetadata(AuthToken authToken,
                                        java.lang.String linkToken,
                                        java.lang.String itemName,
                                        java.lang.String accessCode,
                                        java.lang.String path)
                                 throws AwUnsupportedApiVersionException,
                                        java.io.IOException,
                                        AnywhereException

Read entry metadata from private link

Parameters:

authToken - authentication token for the user performing the request

linkToken - Link token of the link

itemName - The name of the folder that the link points to

accessCode - Access code of the link

path - path of the entry relative to the link

Returns:

metadata about the file or folder at the specified path

Throws:

AwUnsupportedApiVersionException

java.io.IOException

AnywhereException

browsePublicLink

public LinkBrowseListing browsePublicLink(AuthToken authToken,
                                          java.lang.String linkToken,
                                          java.lang.String itemName,
                                          java.lang.String accessCode,
                                          java.lang.String path,
                                          java.lang.String pageToken,
                                          int pageSize,
                                          FolderListingRequest.SortingCriterion sortingCriterion,
                                          FolderListingRequest.SortingDirection sortingDirection)
                                   throws AwUnsupportedApiVersionException,
                                          java.io.IOException,
                                          AnywhereException

Browse a public link

Parameters:

authToken - authentication token for the user performing the request

linkToken - Link token of the link

itemName - The name of the folder/file that the link points to

accessCode - Access code of the link

path - path of the folder/file relative to the link

pageToken - if null, the first page of entries are returned. To return the next page of entries, use the pageToken that was returned in the previous call

pageSize - maximum number of entries to be returned

sortingCriterion - How the results should be sorted (by NAME, SIZE, or MODIFY_DATE). Defaults to NAME. Folders always appear first.

sortingDirection - In which direction the results should be presented (ASC for ascending order, DESC for descending order, based on the sorting criterion). Defaults to ASC.

Returns:

List of entries under the provided path of the link

Throws:

AwUnsupportedApiVersionException

java.io.IOException

AnywhereException

browsePrivateLink

public LinkBrowseListing browsePrivateLink(AuthToken authToken,
                                           java.lang.String linkToken,
                                           java.lang.String itemName,
                                           java.lang.String accessCode,
                                           java.lang.String path,
                                           java.lang.String pageToken,
                                           int pageSize,
                                           FolderListingRequest.SortingCriterion sortingCriterion,
                                           FolderListingRequest.SortingDirection sortingDirection)
                                    throws AwUnsupportedApiVersionException,
                                           java.io.IOException,
                                           AnywhereException

Browse a private link

Parameters:

authToken - authentication token for the user performing the request

linkToken - Link token of the link

itemName - The name of the folder/file that the link points to

accessCode - Access code of the link

path - path of the folder/file relative to the link

pageToken - if null, the first page of entries are returned. To return the next page of entries, use the pageToken that was returned in the previous call

pageSize - maximum number of entries to be returned

sortingCriterion - How the results should be sorted (by NAME, SIZE, or MODIFY_DATE). Defaults to NAME. Folders always appear first.

sortingDirection - In which direction the results should be presented (ASC for ascending order, DESC for descending order, based on the sorting criterion). Defaults to ASC.

Returns:

List of entries under the provided path of the link

Throws:

AwUnsupportedApiVersionException

java.io.IOException

AnywhereException

readFilePublicLink

public Entry readFilePublicLink(AuthToken authToken,
                                java.lang.String linkToken,
                                java.lang.String itemName,
                                java.lang.String accessCode,
                                java.lang.String path,
                                java.lang.String etag,
                                java.io.OutputStream out)
                         throws AwUnsupportedApiVersionException,
                                java.io.IOException,
                                AnywhereException

Read file from a public link

Parameters:

authToken - authentication token for the user performing the request

linkToken - Link token of the link

itemName - The name of the folder that the link points to

accessCode - Access code of the link

path - path of the file relative to the link

etag - the etag of the file. Can be null

out - OutputStream where the zip file is written

Returns:

If data was downloaded (because etag was null or did not match), then the Entry downloaded is returned. (However, calling Entry.getParent() on the returned Entry will return null.) If no data was downloaded (because the etag matched), then null is returned.

Throws:

AwUnsupportedApiVersionException

java.io.IOException

AnywhereException

readFilePrivateLink

public Entry readFilePrivateLink(AuthToken authToken,
                                 java.lang.String linkToken,
                                 java.lang.String itemName,
                                 java.lang.String accessCode,
                                 java.lang.String path,
                                 java.lang.String etag,
                                 java.io.OutputStream out)
                          throws AwUnsupportedApiVersionException,
                                 java.io.IOException,
                                 AnywhereException

Read file from a private link

Parameters:

authToken - authentication token for the user performing the request

linkToken - Link token of the link

itemName - The name of the folder that the link points to

accessCode - Access code of the link

path - path of the file relative to the link

etag - the etag of the file. Can be null

out - OutputStream where the zip file is written * @return If data was downloaded (because etag was null or did not match), then the Entry downloaded is returned. (However, calling Entry.getParent() on the returned Entry will return null.) If no data was downloaded (because the etag matched), then null is returned.

Throws:

AwUnsupportedApiVersionException

java.io.IOException

AnywhereException

createFilePublicLink

public Entry createFilePublicLink(AuthToken authToken,
                                  java.lang.String linkToken,
                                  java.lang.String itemName,
                                  java.lang.String accessCode,
                                  java.lang.String path,
                                  java.lang.Long size,
                                  java.lang.String hash,
                                  java.lang.Boolean createParents,
                                  java.io.InputStream contentIn)
                           throws AwUnsupportedApiVersionException,
                                  java.io.IOException,
                                  AnywhereException

Upload a file to a public link with upload access

Parameters:

authToken - authentication token for the user performing the request

linkToken - Link token of the link

itemName - The name of the folder that the link points to

accessCode - Access code of the link

path - path (including file name) where the file is uploaded

size - size (in bytes) of the file being uploaded. This argument is optional

hash - the SHA-384 hash, represented as a hex string, of the file being uploaded. This argument is optional

createParents - if true, then any parent folders of path that do not already exist will be created. if false, then the operation will fail if any parent folders of path do not exist. This argument is optional

contentIn - InputStream containing the new file contents.

Returns:

the newly created Entry

Throws:

AwUnsupportedApiVersionException

java.io.IOException

AnywhereException

createFilePrivateLink

public Entry createFilePrivateLink(AuthToken authToken,
                                   java.lang.String linkToken,
                                   java.lang.String itemName,
                                   java.lang.String accessCode,
                                   java.lang.String path,
                                   java.lang.Long size,
                                   java.lang.String hash,
                                   java.lang.Boolean createParents,
                                   java.io.InputStream contentIn)
                            throws AwUnsupportedApiVersionException,
                                   java.io.IOException,
                                   AnywhereException

Upload a file to a private link with upload access

Parameters:

authToken - authentication token for the user performing the request

linkToken - Link token of the link

itemName - The name of the folder that the link points to

accessCode - Access code of the link

path - path (including file name) where the file is uploaded

size - size (in bytes) of the file being uploaded. This argument is optional

hash - the SHA-384 hash, represented as a hex string, of the file being uploaded. This argument is optional

createParents - if true, then any parent folders of path that do not already exist will be created. if false, then the operation will fail if any parent folders of path do not exist. This argument is optional

contentIn - InputStream containing the new file contents.

Returns:

the newly created Entry

Throws:

AwUnsupportedApiVersionException

java.io.IOException

AnywhereException

multiFileDownloadPublicLink

public void multiFileDownloadPublicLink(AuthToken authToken,
                                        java.util.List<java.lang.String> pathList,
                                        java.lang.String linkToken,
                                        java.lang.String itemName,
                                        java.lang.String accessCode,
                                        java.io.OutputStream out)
                                 throws AwUnsupportedApiVersionException,
                                        java.io.IOException,
                                        AnywhereException

Download multiple files as zip from a public link

Parameters:

authToken - authentication token for the user performing the request

pathList - List of path to be downloaded relative to the link

linkToken - Link token of the link

itemName - The name of the folder that the link points to

accessCode - Access code of the link

out - OutputStream where the zip file is written

Throws:

AwUnsupportedApiVersionException

java.io.IOException

AnywhereException

multiFileDownloadPrivateLink

public void multiFileDownloadPrivateLink(AuthToken authToken,
                                         java.util.List<java.lang.String> pathList,
                                         java.lang.String linkToken,
                                         java.lang.String itemName,
                                         java.lang.String accessCode,
                                         java.io.OutputStream out)
                                  throws AwUnsupportedApiVersionException,
                                         java.io.IOException,
                                         AnywhereException

Download multiple files as zip from a private link

Parameters:

authToken - authentication token for the user performing the request

pathList - List of path to be downloaded relative to the link

linkToken - Link token of the link

itemName - The name of the folder that the link points to

accessCode - Access code of the link

out - OutputStream where the zip file is written

Throws:

AwUnsupportedApiVersionException

java.io.IOException

AnywhereException

updateFilePublicLink

public Entry updateFilePublicLink(AuthToken authToken,
                                  java.lang.String linkToken,
                                  java.lang.String itemName,
                                  java.lang.String accessCode,
                                  java.lang.String path,
                                  java.lang.Long size,
                                  java.lang.String hash,
                                  java.lang.String etag,
                                  java.io.InputStream contentIn)
                           throws AwUnsupportedApiVersionException,
                                  java.io.IOException,
                                  AnywhereException

Update file through a public link

Parameters:

authToken - authentication token for the user performing the request

linkToken - Link token of the link

itemName - The name of the folder that the link points to

accessCode - Access code of the link

path - path (including file name) where the file is being updated

size - size (in bytes) of the file being uploaded. This argument is optional

hash - the SHA-384 hash, represented as a hex string, of the file being uploaded. This argument is optional

etag - the etag of the file you are updating. The operation fails if there is not a file with this etag at the given path

contentIn - InputStream containing the new file contents

Returns:

the updated Entry

Throws:

AwUnsupportedApiVersionException

java.io.IOException

AnywhereException

updateFilePrivateLink

public Entry updateFilePrivateLink(AuthToken authToken,
                                   java.lang.String linkToken,
                                   java.lang.String itemName,
                                   java.lang.String accessCode,
                                   java.lang.String path,
                                   java.lang.Long size,
                                   java.lang.String hash,
                                   java.lang.String etag,
                                   java.io.InputStream contentIn)
                            throws AwUnsupportedApiVersionException,
                                   java.io.IOException,
                                   AnywhereException

Update file through a private link

Parameters:

authToken - authentication token for the user performing the request

linkToken - Link token of the link

itemName - The name of the folder that the link points to

accessCode - Access code of the link

path - path (including file name) where the file is being updated

size - size (in bytes) of the file being uploaded. This argument is optional

hash - the SHA-384 hash, represented as a hex string, of the file being uploaded. This argument is optional

etag - the etag of the file you are updating. The operation fails if there is not a file with this etag at the given path

contentIn - InputStream containing the new file contents

Returns:

the updated Entry

Throws:

AwUnsupportedApiVersionException

java.io.IOException

AnywhereException

copyFilesToLocalPublicLink

public void copyFilesToLocalPublicLink(AuthToken authToken,
                                       java.lang.String linkToken,
                                       java.lang.String itemName,
                                       java.lang.String accessCode,
                                       java.util.List<java.lang.String> pathList,
                                       java.lang.String destinationPath)
                                throws AwUnsupportedApiVersionException,
                                       java.io.IOException,
                                       AnywhereException

Copy files to local from a public link

Parameters:

authToken - authentication token for the user performing the request

linkToken - Link token of the link

itemName - The name of the folder that the link points to

accessCode - Access code of the link

pathList - List of path to be copied to local relative to the link

destinationPath - Destination path f

Throws:

AwUnsupportedApiVersionException

java.io.IOException

AnywhereException

copyFilesToLocalPrivateLink

public void copyFilesToLocalPrivateLink(AuthToken authToken,
                                        java.lang.String linkToken,
                                        java.lang.String itemName,
                                        java.lang.String accessCode,
                                        java.util.List<java.lang.String> pathList,
                                        java.lang.String destinationPath)
                                 throws AwUnsupportedApiVersionException,
                                        java.io.IOException,
                                        AnywhereException

Copy files to local from a private link

Parameters:

authToken - authentication token for the user performing the request

linkToken - Link token of the link

itemName - The name of the folder that the link points to

accessCode - Access code of the link

pathList - List of path to be copied to local relative to the link

destinationPath - Destination path f

Throws:

AwUnsupportedApiVersionException

java.io.IOException

AnywhereException