com.hds.hcpaw.fss.api

Class AnywherePathAPI

java.lang.Object

com.hds.hcpaw.fss.api.AnywherePathAPI

public class AnywherePathAPI
extends java.lang.Object

API for performing actions such as delete and move for both files and folders. These methods are implemented using the HCP Anywhere FSS API /fss/public/path URIs.

See the method AnywhereAPI.getPathAPI() to obtain an instance of the AnywherePathAPI.

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	DEFAULT_CREATE_PARENTS The default value to use for createParents on move(com.hds.hcpaw.fss.api.model.AuthToken, String, String, String) operations.
static boolean	DEFAULT_RECURSIVE_DELETE The default value to use for recursive on delete(com.hds.hcpaw.fss.api.model.AuthToken, String, String) operations.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AnywherePathAPI(AnywhereConnector connector)

Method Summary

Modifier and Type	Method and Description
void	delete(AuthToken authToken, java.lang.String path, java.lang.String etag) Calls delete(com.hds.hcpaw.fss.api.model.AuthToken, String, String, boolean) with DEFAULT_RECURSIVE_DELETE (false) as the value for recursive.
void	delete(AuthToken authToken, java.lang.String path, java.lang.String etag, boolean recursive) Deletes a file or folder at the specified path.
Entry	getInfo(AuthToken authToken, java.lang.String path) Returns information (metadata) about the file or folder at the specified path.
Entry	getInfo(AuthToken authToken, java.lang.String path, boolean includeDeleted) Returns information (metadata) about the file or folder at the specified path.
LinkListing	listLinks(AuthToken authToken, java.lang.String path) List all non-expired links for a specified path.
Entry	move(AuthToken authToken, java.lang.String sourcePath, java.lang.String destPath, java.lang.String etag) Calls move(com.hds.hcpaw.fss.api.model.AuthToken, String, String, String, boolean) with DEFAULT_CREATE_PARENTS (false) as the value for createParents.
Entry	move(AuthToken authToken, java.lang.String sourcePath, java.lang.String destPath, java.lang.String etag, boolean createParents) Deletes the entry currently at sourcePath (and all of its children if the path refers to a folder), and creates the entry (and all of its children if path refers to a folder) at destPath.
MultiDeletePathResult	multiDelete(AuthToken authToken, java.util.List<EntryIdentifier> entryList, java.lang.Boolean recursive) Deletes multiple files or folders based on (path, etag) pairs passed in.
PathSearchResult	search(AuthToken authToken, java.lang.String path, java.lang.String substring, java.lang.Integer maxResults) Searches for entries with a matching substring in their name under the specified path.
PathSearchResult	search(AuthToken authToken, java.lang.String path, java.lang.String substring, java.lang.Integer maxResults, java.lang.Boolean includeDeleted, java.lang.Long pointInTime) Searches for entries with a matching substring in their name under the specified path.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_RECURSIVE_DELETE

public static final boolean DEFAULT_RECURSIVE_DELETE

The default value to use for recursive on delete(com.hds.hcpaw.fss.api.model.AuthToken, String, String) operations. Has a value of false.

See Also:

Constant Field Values

DEFAULT_CREATE_PARENTS

public static final boolean DEFAULT_CREATE_PARENTS

The default value to use for createParents on move(com.hds.hcpaw.fss.api.model.AuthToken, String, String, String) operations. Has a value of false.

See Also:

Constant Field Values

Constructor Detail

AnywherePathAPI

protected AnywherePathAPI(AnywhereConnector connector)

Method Detail

delete

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

Calls delete(com.hds.hcpaw.fss.api.model.AuthToken, String, String, boolean) with DEFAULT_RECURSIVE_DELETE (false) as the value for recursive.

Throws:

AwUnsupportedApiVersionException

java.io.IOException

AnywhereException

delete

public void delete(AuthToken authToken,
                   java.lang.String path,
                   java.lang.String etag,
                   boolean recursive)
            throws AwUnsupportedApiVersionException,
                   java.io.IOException,
                   AnywhereException

Deletes a file or folder at the specified path. The file or folder currently at the path must have the same etag as was specified in the etag parameter or the operation will fail.

Parameters:

authToken - authentication token for the user performing the request

path - path to the file or folder being deleted

etag - the etag of the file being deleted. The operation fails if there is not a file with this etag at the specified path

recursive - ignored if the specified path is a file. For folders, if true, then all the files and folders in the folder are also deleted. If false, and there are files or folders in the folder, the operation fails

Throws:

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

AwNotFoundException - if path does not exist

AwDirectoryNotEmptyException - if recursive is false and path is a non-empty folder

java.io.IOException

AnywhereException

multiDelete

public MultiDeletePathResult multiDelete(AuthToken authToken,
                                         java.util.List<EntryIdentifier> entryList,
                                         java.lang.Boolean recursive)
                                  throws AwUnsupportedApiVersionException,
                                         java.io.IOException,
                                         AnywhereException

Deletes multiple files or folders based on (path, etag) pairs passed in. The file or folder currently at each path must have the same etag as was specified in the pair or the operation will fail.

Parameters:

authToken - authentication token for the user performing the request

entryList - The list of (path, etag) pairs to delete.

recursive - ignored if the specified path is a file. For folders, if true, then all the files and folders in the folder are also deleted. If false, and there are files or folders in the folder, the operation fails

Returns:

two lists; one for all successful deletes, one for all failed deletes

Throws:

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

AwNotFoundException - if path does not exist

AwDirectoryNotEmptyException - if recursive is false and path is a non-empty folder

java.io.IOException

AnywhereException

move

public Entry move(AuthToken authToken,
                  java.lang.String sourcePath,
                  java.lang.String destPath,
                  java.lang.String etag)
           throws AwUnsupportedApiVersionException,
                  java.io.IOException,
                  AnywhereException

Calls move(com.hds.hcpaw.fss.api.model.AuthToken, String, String, String, boolean) with DEFAULT_CREATE_PARENTS (false) as the value for createParents.

Throws:

AwUnsupportedApiVersionException

java.io.IOException

AnywhereException

move

public Entry move(AuthToken authToken,
                  java.lang.String sourcePath,
                  java.lang.String destPath,
                  java.lang.String etag,
                  boolean createParents)
           throws AwUnsupportedApiVersionException,
                  java.io.IOException,
                  AnywhereException

Deletes the entry currently at sourcePath (and all of its children if the path refers to a folder), and creates the entry (and all of its children if path refers to a folder) at destPath.

Parameters:

authToken - authentication token for the user performing the request

sourcePath - current path (including file or folder name) of the file or folder to be moved

destPath - path where the file or folder will be moved

etag - the etag of the file or folder being moved. The operation fails if there is not a file or folder with this etag at the specified path.

createParents - if true, then any parent folders of destPath that do not already exist will be created. If false, then the operation will fail if any parent folders of destPath do not exist.

Returns:

the file or folder that was moved to destPath

Throws:

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

AwNotFoundException - if sourcePath does not exist or if the parent of destPath does not exist and createParents is false

AwEntryVersionMismatchException - if the provided etag does not match the etag on the server

java.io.IOException

AnywhereException

getInfo

public Entry getInfo(AuthToken authToken,
                     java.lang.String path)
              throws AwUnsupportedApiVersionException,
                     java.io.IOException,
                     AnywhereException

Returns information (metadata) about the file or folder at the specified path.

Parameters:

authToken - authentication token for the user performing the request

path - path (including file or folder name) of the file or folder to return metadata about

Returns:

metadata about the file or folder at the specified path

Throws:

AwUnsupportedApiVersionException - if sourcePath does not exist or if the parent of destPath does not exist and createParents is false

java.io.IOException

AnywhereException

getInfo

public Entry getInfo(AuthToken authToken,
                     java.lang.String path,
                     boolean includeDeleted)
              throws AwUnsupportedApiVersionException,
                     java.io.IOException,
                     AnywhereException

Returns information (metadata) about the file or folder at the specified path.

Parameters:

authToken - authentication token for the user performing the request

path - path (including file or folder name) of the file or folder to return metadata about

includeDeleted - whether to include deleted item

Returns:

metadata about the file or folder at the specified path

Throws:

AwUnsupportedApiVersionException - if sourcePath does not exist or if the parent of destPath does not exist and createParents is false

java.io.IOException

AnywhereException

search

public PathSearchResult search(AuthToken authToken,
                               java.lang.String path,
                               java.lang.String substring,
                               java.lang.Integer maxResults)
                        throws AwUnsupportedApiVersionException,
                               java.io.IOException,
                               AnywhereException

Searches for entries with a matching substring in their name under the specified path.

Parameters:

authToken - authentication token for the user performing the request.

path - path under which to search for entries matching the substring. If path is a folder, all subfolders are searched as well.

substring - the substring to match file or folder names against. Must be at least three characters long.

maxResults - the maximum number of results that will be returned. If null, then the value defaults to 100.

Returns:

a list of Entry objects that contain the specified substring in their name, one for each matching result. No more than maxResults entries will be returned. If more than maxResults entries match the search criteria, then the results returned are selected at random.

Throws:

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

java.io.IOException

AnywhereException

search

public PathSearchResult search(AuthToken authToken,
                               java.lang.String path,
                               java.lang.String substring,
                               java.lang.Integer maxResults,
                               java.lang.Boolean includeDeleted,
                               java.lang.Long pointInTime)
                        throws AwUnsupportedApiVersionException,
                               java.io.IOException,
                               AnywhereException

Searches for entries with a matching substring in their name under the specified path.

Parameters:

authToken - authentication token for the user performing the request.

path - path under which to search for entries matching the substring. If path is a folder, all subfolders are searched as well.

substring - the substring to match file or folder names against. Must be at least three characters long.

maxResults - the maximum number of results that will be returned. If null, then the value defaults to 100.

includeDeleted - whether or not to include deleted entries in the search. If null, defaults to false.

pointInTime - the point in time to search for the entry. If null, defaults to the current time.

Returns:

a list of Entry objects that contain the specified substring in their name, one for each matching result. No more than maxResults entries will be returned. If more than maxResults entries match the search criteria, then the results returned are selected at random.

Throws:

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

java.io.IOException

AnywhereException

listLinks

public LinkListing listLinks(AuthToken authToken,
                             java.lang.String path)
                      throws AwUnsupportedApiVersionException,
                             java.io.IOException,
                             AnywhereException

List all non-expired links for a specified path.

Parameters:

authToken - authentication token for the user performing the request.

path - path to the file or folder to list links for.

Returns:

a list of existing links for the path.

Throws:

AwUnsupportedApiVersionException

java.io.IOException

AnywhereException