com.hds.hcpaw.fss.api

Class AnywhereFolderAPI

java.lang.Object

com.hds.hcpaw.fss.api.AnywhereFolderAPI

public class AnywhereFolderAPI
extends java.lang.Object

API for performing folder actions such as create and list the contents of a folder. These methods are implemented using the HCP Anywhere FSS API /fss/public/folder URIs.

See the method AnywhereAPI.getFolderAPI() to obtain an instance of the AnywhereFolderAPI.

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AnywhereFolderAPI(AnywhereConnector connector)

Method Summary

Modifier and Type	Method and Description
Entry	create(AuthToken authToken, java.lang.String path) Calls create(com.hds.hcpaw.fss.api.model.AuthToken, String, boolean) with DEFAULT_CREATE_PARENTS (false) as the value for createParents.
Entry	create(AuthToken authToken, java.lang.String path, boolean createParents) Creates a folder at the specified path.
FolderSize	getSize(AuthToken authToken, java.lang.String path, long pointInTime) Get the size of a folder
FolderListing	listEntries(AuthToken authToken, java.lang.String path, java.lang.String pageToken, int pageSize) Lists the contents (files and folders) of the specified folder, one "page" at a time.
FolderListing	listEntries(AuthToken authToken, java.lang.String path, java.lang.String pageToken, int pageSize, FolderListingRequest.SortingCriterion sortingCriterion, FolderListingRequest.SortingDirection sortingDirection) Lists the contents (files and folders) of the specified folder, one "page" at a time.
FolderListing	listEntriesAtTime(AuthToken authToken, java.lang.String path, java.lang.Long viewAtTime, java.lang.String pageToken, int pageSize) Lists the contents (files and folders) of the specified folder at a specified time, one "page" at a time.
FolderListing	listEntriesAtTime(AuthToken authToken, java.lang.String path, java.lang.Long viewAtTime, java.lang.String pageToken, int pageSize, FolderListingRequest.SortingCriterion sortingCriterion, FolderListingRequest.SortingDirection sortingDirection) Lists the contents (files and folders) of the specified folder at a specified time, one "page" at a time.
FolderListing	listEntriesIncludeDeleted(AuthToken authToken, java.lang.String path, java.lang.String pageToken, int pageSize) Lists the contents (files and folders) of the specified folder, including deleted entries, one "page" at a time.
FolderListing	listEntriesIncludeDeleted(AuthToken authToken, java.lang.String path, java.lang.String pageToken, int pageSize, FolderListingRequest.SortingCriterion sortingCriterion, FolderListingRequest.SortingDirection sortingDirection) Lists the contents (files and folders) of the specified folder, including deleted entries, one "page" at a time.
Entry	restore(AuthToken authToken, java.lang.String path, int deltaSeconds) Restore a folder

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_CREATE_PARENTS

public static final boolean DEFAULT_CREATE_PARENTS

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

See Also:

Constant Field Values

Constructor Detail

AnywhereFolderAPI

protected AnywhereFolderAPI(AnywhereConnector connector)

Method Detail

create

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

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

Throws:

AwUnsupportedApiVersionException

java.io.IOException

AnywhereException

create

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

Creates a folder at the specified path. If the folder already exists, the operation returns the existing folder.

Parameters:

authToken - authentication token for the user performing the request

path - path (including folder name) where the folder will be created

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

Returns:

the created or already existing folder

Throws:

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

AwNotFoundException - if the parent of path does not exist and createParents if false

java.io.IOException

AnywhereException

listEntries

public FolderListing listEntries(AuthToken authToken,
                                 java.lang.String path,
                                 java.lang.String pageToken,
                                 int pageSize)
                          throws AwUnsupportedApiVersionException,
                                 java.io.IOException,
                                 AnywhereException

Lists the contents (files and folders) of the specified folder, one "page" at a time. That is, this method returns up to as many entries as are specified in the pageSize parameter.

This method should be called first with a null pageToken. Then, if there are more entries in the folder, subsequent calls should use the pageToken returned from the previous call.

If the last page of entries is returned, then the returned FolderListing will contain a null pageToken.

Parameters:

authToken - authentication token for the user performing the request

path - path (including folder name) to the folder

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

Returns:

a list of files and folders in the specified folder, up to the number of entries specified in the pageSize parameter. If there are more entries in the specified folder, a pageToken, which is used to retrieve the next page of entries, is also returned.

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 or is not a folder

java.io.IOException

AnywhereException

listEntries

public FolderListing listEntries(AuthToken authToken,
                                 java.lang.String path,
                                 java.lang.String pageToken,
                                 int pageSize,
                                 FolderListingRequest.SortingCriterion sortingCriterion,
                                 FolderListingRequest.SortingDirection sortingDirection)
                          throws AwUnsupportedApiVersionException,
                                 java.io.IOException,
                                 AnywhereException

Lists the contents (files and folders) of the specified folder, one "page" at a time. That is, this method returns up to as many entries as are specified in the pageSize parameter.

This method should be called first with a null pageToken. Then, if there are more entries in the folder, subsequent calls should use the pageToken returned from the previous call.

If the last page of entries is returned, then the returned FolderListing will contain a null pageToken.

Parameters:

authToken - authentication token for the user performing the request

path - path (including folder name) to the folder

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

Returns:

a list of files and folders in the specified folder, up to the number of entries specified in the pageSize parameter. If there are more entries in the specified folder, a pageToken, which is used to retrieve the next page of entries, is also returned.

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 or is not a folder

java.io.IOException

AnywhereException

listEntriesAtTime

public FolderListing listEntriesAtTime(AuthToken authToken,
                                       java.lang.String path,
                                       java.lang.Long viewAtTime,
                                       java.lang.String pageToken,
                                       int pageSize)
                                throws AwUnsupportedApiVersionException,
                                       java.io.IOException,
                                       AnywhereException

Lists the contents (files and folders) of the specified folder at a specified time, one "page" at a time. That is, this method returns up to as many entries as are specified in the pageSize parameter.

This method should be called first with a null pageToken. Then, if there are more entries in the folder, subsequent calls should use the pageToken returned from the previous call.

If the last page of entries is returned, then the returned FolderListing will contain a null pageToken.

Parameters:

authToken - authentication token for the user performing the request

path - path (including folder name) to the folder

viewAtTime - The point in time at which to list entries. Defaults to the current time if null.

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

Returns:

a list of files and folders in the specified folder, up to the number of entries specified in the pageSize parameter. If there are more entries in the specified folder, a pageToken, which is used to retrieve the next page of entries, is also returned.

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 or is not a folder

java.io.IOException

AnywhereException

listEntriesAtTime

public FolderListing listEntriesAtTime(AuthToken authToken,
                                       java.lang.String path,
                                       java.lang.Long viewAtTime,
                                       java.lang.String pageToken,
                                       int pageSize,
                                       FolderListingRequest.SortingCriterion sortingCriterion,
                                       FolderListingRequest.SortingDirection sortingDirection)
                                throws AwUnsupportedApiVersionException,
                                       java.io.IOException,
                                       AnywhereException

Lists the contents (files and folders) of the specified folder at a specified time, one "page" at a time. That is, this method returns up to as many entries as are specified in the pageSize parameter.

This method should be called first with a null pageToken. Then, if there are more entries in the folder, subsequent calls should use the pageToken returned from the previous call.

If the last page of entries is returned, then the returned FolderListing will contain a null pageToken.

Parameters:

authToken - authentication token for the user performing the request

path - path (including folder name) to the folder

viewAtTime - The point in time at which to list entries. Defaults to the current time if null.

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:

a list of files and folders in the specified folder, up to the number of entries specified in the pageSize parameter. If there are more entries in the specified folder, a pageToken, which is used to retrieve the next page of entries, is also returned.

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 or is not a folder

java.io.IOException

AnywhereException

listEntriesIncludeDeleted

public FolderListing listEntriesIncludeDeleted(AuthToken authToken,
                                               java.lang.String path,
                                               java.lang.String pageToken,
                                               int pageSize)
                                        throws AwUnsupportedApiVersionException,
                                               java.io.IOException,
                                               AnywhereException

Lists the contents (files and folders) of the specified folder, including deleted entries, one "page" at a time. That is, this method returns up to as many entries as are specified in the pageSize parameter.

This method should be called first with a null pageToken. Then, if there are more entries in the folder, subsequent calls should use the pageToken returned from the previous call.

If the last page of entries is returned, then the returned FolderListing will contain a null pageToken.

Parameters:

authToken - authentication token for the user performing the request

path - path (including folder name) to the folder

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

Returns:

a list of files and folders in the specified folder, up to the number of entries specified in the pageSize parameter. If there are more entries in the specified folder, a pageToken, which is used to retrieve the next page of entries, is also returned.

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 or is not a folder

java.io.IOException

AnywhereException

listEntriesIncludeDeleted

public FolderListing listEntriesIncludeDeleted(AuthToken authToken,
                                               java.lang.String path,
                                               java.lang.String pageToken,
                                               int pageSize,
                                               FolderListingRequest.SortingCriterion sortingCriterion,
                                               FolderListingRequest.SortingDirection sortingDirection)
                                        throws AwUnsupportedApiVersionException,
                                               java.io.IOException,
                                               AnywhereException

Lists the contents (files and folders) of the specified folder, including deleted entries, one "page" at a time. That is, this method returns up to as many entries as are specified in the pageSize parameter.

This method should be called first with a null pageToken. Then, if there are more entries in the folder, subsequent calls should use the pageToken returned from the previous call.

If the last page of entries is returned, then the returned FolderListing will contain a null pageToken.

Parameters:

authToken - authentication token for the user performing the request

path - path (including folder name) to the folder

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:

a list of files and folders in the specified folder, up to the number of entries specified in the pageSize parameter. If there are more entries in the specified folder, a pageToken, which is used to retrieve the next page of entries, is also returned.

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 or is not a folder

java.io.IOException

AnywhereException

restore

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

Restore a folder

Parameters:

authToken - authentication token for the user performing the request

path - path (including folder name) to the folder

deltaSeconds - max difference in seconds between deletion of folder and deletion of entries in the folder to restore

Returns:

Throws:

AwUnsupportedApiVersionException

java.io.IOException

AnywhereException

getSize

public FolderSize getSize(AuthToken authToken,
                          java.lang.String path,
                          long pointInTime)
                   throws AwUnsupportedApiVersionException,
                          java.io.IOException,
                          AnywhereException

Get the size of a folder

Parameters:

authToken - authentication token for the user performing the request

path - path (including folder name) to the folder

pointInTime - time in epoch at which to get the size

Returns:

Throws:

AwUnsupportedApiVersionException

java.io.IOException

AnywhereException