com.hds.hcpaw.fss.api

Class AnywhereShareAPI

java.lang.Object

com.hds.hcpaw.fss.api.AnywhereShareAPI

public class AnywhereShareAPI
extends java.lang.Object

API for share activities such as create share, invite users, etc. These methods are implemented using the HCP Anywhere FSS API /fss/public/share URIs.

See the method AnywhereAPI.getShareAPI() to obtain an instance of the AnywhereShareAPI.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AnywhereShareAPI(AnywhereConnector connector)

Method Summary

Modifier and Type	Method and Description
SharedFolder	acceptInvitation(AuthToken authToken, java.lang.String fsId, boolean sync) Accept an invitation to join a shared folder
SharedFolder	approveTeamFolderRequest(AuthToken authToken, java.lang.String path) Approve a request to create a team folder
void	cancelInvitation(AuthToken authToken, java.lang.String path, java.lang.String uniqueId, java.lang.String providerId) Cancel an invitation for a specified user to a specified folder.
SharedFolder	cancelTeamFolderRequest(AuthToken authToken, java.lang.String path) Cancel a request to create a team folder
SharedFolder	convertToTeamFolder(AuthToken authToken, java.lang.String path, java.lang.String contact, java.lang.Long quotaBytes) Convert a shared folder to a team folder
SharedFolder	create(AuthToken authToken, java.lang.String path, java.lang.String label) Create a shared folder.
SharedFolder	createTeamFolder(AuthToken authToken, java.lang.String path, java.lang.String label, java.lang.String contact, java.lang.Long quotaBytes) Create a team folder
void	deleteTeamFolder(AuthToken authToken, java.lang.String path) Delete a team folder for all users, abandoning it.
SharedFolder	invite(AuthToken authToken, java.lang.String path, java.lang.String uniqueId, java.lang.String providerId, ShareRole role) Invite user or group to the shared folder
java.lang.Void	leaveShare(AuthToken authToken, java.lang.String path) Leave a shared folder
GroupMembersListing	listGroupMembers(AuthToken authToken, java.lang.String name, java.lang.String providerId) List members in a group
InvitationListing	listInvitations(AuthToken authToken) List the user's invitations to join shared folders owned by others
SharedFolderListing	listSharedFolders(AuthToken authToken) List all shared folders the user is a member of
ShareMemberListing	listShareGroups(AuthToken authToken, java.lang.String path) List the groups in a share
ShareMemberListing	listShareMembers(AuthToken authToken, java.lang.String path) List the members of a given shared folder.
ShareMemberListing	listShareMembers(AuthToken authToken, java.lang.String path, java.lang.String pageToken, java.lang.Integer pageSize) List the members of a given shared folder, which includes both users and groups.
ShareMemberListing	listShareMembers(AuthToken authToken, java.lang.String path, java.lang.String pageToken, java.lang.Integer pageSize, ShareMemberListRequest.SortingCriterion sortingCriterion, ShareMemberListRequest.SortingDirection sortingDirection) List the members of a given shared folder, which includes both users and groups.
ShareMemberListing	listShareUsers(AuthToken authToken, java.lang.String path) List the users of a given shared folder.
ShareMemberListing	preserveMembership(AuthToken authToken, java.lang.String path, boolean removeGroups) Preserve a share's membership
void	rejectInvitation(AuthToken authToken, java.lang.String fsId) Reject an invitation to join a shared folder
void	removeGroup(AuthToken authToken, java.lang.String path, java.lang.String uniqueId, java.lang.String providerId) Remove group from shared folder
void	removeMember(AuthToken authToken, java.lang.String path, java.lang.String uniqueId, java.lang.String providerId) Remove member from shared folder
ShareInviteSearchResult	searchInvite(AuthToken authToken, java.lang.String path, java.lang.String filter) List users and groups matching the filter
SharedFolder	syncMembership(AuthToken authToken, java.lang.String path, boolean increaseRole, boolean inviteDeclined) Sync a share's membership
Entry	unshareFolder(AuthToken authToken, java.lang.String path) Reject an invitation to join a shared folder
SharedFolder	updateShareSettings(AuthToken authToken, java.lang.String path, boolean sync) Update settings for shared folder
SharedFolder	updateTeamFolder(AuthToken authToken, java.lang.String path, java.lang.String contact, java.lang.Long quotaBytes) Update a team folder

Methods inherited from class java.lang.Object

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

Constructor Detail

AnywhereShareAPI

protected AnywhereShareAPI(AnywhereConnector connector)

Method Detail

create

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

Create a shared folder.

Parameters:

authToken - authentication token for the user performing the request

path - path of the folder that will be shared

label - name of the folder as it appears to the people you are sharing the folder with

Returns:

the shared folder

Throws:

AwUnsupportedApiVersionException

java.io.IOException

AnywhereException

invite

public SharedFolder invite(AuthToken authToken,
                           java.lang.String path,
                           java.lang.String uniqueId,
                           java.lang.String providerId,
                           ShareRole role)
                    throws AwUnsupportedApiVersionException,
                           java.io.IOException,
                           AnywhereException

Invite user or group to the shared folder

Parameters:

authToken - authentication token for the user performing the request

path - path of the shared folder

uniqueId - uniqueId of the invitee

providerId - providerId of the auth provider

role - Role of the invitee

Returns:

invitation result

Throws:

AwUnsupportedApiVersionException

java.io.IOException

AnywhereException

listInvitations

public InvitationListing listInvitations(AuthToken authToken)
                                  throws AwUnsupportedApiVersionException,
                                         java.io.IOException,
                                         AnywhereException

List the user's invitations to join shared folders owned by others

Parameters:

authToken - authentication token for the user performing the request

Returns:

The list of invitations for this user to join other shared folders

Throws:

AwUnsupportedApiVersionException

java.io.IOException

AnywhereException

acceptInvitation

public SharedFolder acceptInvitation(AuthToken authToken,
                                     java.lang.String fsId,
                                     boolean sync)
                              throws AwUnsupportedApiVersionException,
                                     java.io.IOException,
                                     AnywhereException

Accept an invitation to join a shared folder

Parameters:

authToken - authentication token for the user performing the request

fsId - the id of the share to which to accept an invitation

sync - whether to sync the share after the invitation was accepted. If the role of the user is VIEWER, the share cannot be mounted as syncing

Returns:

The joined share

Throws:

AwUnsupportedApiVersionException

java.io.IOException

AnywhereException

rejectInvitation

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

Reject an invitation to join a shared folder

Parameters:

authToken - authentication token for the user performing the request

fsId - the id of the share for which to reject an invitation

Throws:

AwUnsupportedApiVersionException

java.io.IOException

AnywhereException

cancelInvitation

public void cancelInvitation(AuthToken authToken,
                             java.lang.String path,
                             java.lang.String uniqueId,
                             java.lang.String providerId)
                      throws AwUnsupportedApiVersionException,
                             java.io.IOException,
                             AnywhereException

Cancel an invitation for a specified user to a specified folder.

Parameters:

authToken - authentication token for the user performing the request

path - The path to the shared folder.

uniqueId - The uniqueId of the user whose invitation should be cancelled.

providerId - The providerId of the user whose invitation should be cancelled.

Throws:

AwUnsupportedApiVersionException

java.io.IOException

AnywhereException

unshareFolder

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

Reject an invitation to join a shared folder

Parameters:

authToken - authentication token for the user performing the request

path - the path to the share to unshare

Returns:

The rejected share

Throws:

AwUnsupportedApiVersionException

java.io.IOException

AnywhereException

listGroupMembers

public GroupMembersListing listGroupMembers(AuthToken authToken,
                                            java.lang.String name,
                                            java.lang.String providerId)
                                     throws AwUnsupportedApiVersionException,
                                            java.io.IOException,
                                            AnywhereException

List members in a group

Parameters:

authToken - authentication token for the user performing the request

name - name of the group

providerId - providerId of the auth provider

Returns:

GroupMembersListing object containing a list of group members

Throws:

AwUnsupportedApiVersionException

java.io.IOException

AnywhereException

leaveShare

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

Leave a shared folder

Parameters:

authToken - authentication token for the user performing the request

path - the path of the folder to leave

Throws:

AwUnsupportedApiVersionException

java.io.IOException

AnywhereException

removeMember

public void removeMember(AuthToken authToken,
                         java.lang.String path,
                         java.lang.String uniqueId,
                         java.lang.String providerId)
                  throws AwUnsupportedApiVersionException,
                         java.io.IOException,
                         AnywhereException

Remove member from shared folder

Parameters:

authToken - authentication token for the user performing the request

path - the path of the shared folder

uniqueId - uniqueId of the member to be removed

providerId - providerId of the auth provider

Throws:

AwUnsupportedApiVersionException

java.io.IOException

AnywhereException

removeGroup

public void removeGroup(AuthToken authToken,
                        java.lang.String path,
                        java.lang.String uniqueId,
                        java.lang.String providerId)
                 throws AwUnsupportedApiVersionException,
                        java.io.IOException,
                        AnywhereException

Remove group from shared folder

Parameters:

authToken - authentication token for the user performing the request

path - the path of the shared folder

uniqueId - uniqueId of the group to be removed

providerId - providerId of the auth provider

Throws:

AwUnsupportedApiVersionException

java.io.IOException

AnywhereException

updateShareSettings

public SharedFolder updateShareSettings(AuthToken authToken,
                                        java.lang.String path,
                                        boolean sync)
                                 throws AwUnsupportedApiVersionException,
                                        java.io.IOException,
                                        AnywhereException

Update settings for shared folder

Parameters:

authToken - authentication token for the user performing the request

path - the path of the shared folder

sync - whether to sync the share. If the role of the user is VIEWER, the share cannot be set as syncing

Returns:

The updated share

Throws:

AwUnsupportedApiVersionException

java.io.IOException

AnywhereException

createTeamFolder

public SharedFolder createTeamFolder(AuthToken authToken,
                                     java.lang.String path,
                                     java.lang.String label,
                                     java.lang.String contact,
                                     java.lang.Long quotaBytes)
                              throws AwUnsupportedApiVersionException,
                                     java.io.IOException,
                                     AnywhereException

Create a team folder

Parameters:

authToken - authentication token for the user performing the request

path - the path of the folder to be a team folder

label - the label to give the team folder

contact - contact information

quotaBytes - the quota for the team folder, in bytes

Throws:

AwUnsupportedApiVersionException

java.io.IOException

AnywhereException

convertToTeamFolder

public SharedFolder convertToTeamFolder(AuthToken authToken,
                                        java.lang.String path,
                                        java.lang.String contact,
                                        java.lang.Long quotaBytes)
                                 throws AwUnsupportedApiVersionException,
                                        java.io.IOException,
                                        AnywhereException

Convert a shared folder to a team folder

Parameters:

authToken - authentication token for the user performing the request

path - the path of the folder to be a team folder

contact - contact information

quotaBytes - the quota for the team folder, in bytes

Throws:

AwUnsupportedApiVersionException

java.io.IOException

AnywhereException

cancelTeamFolderRequest

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

Cancel a request to create a team folder

Parameters:

authToken - authentication token for the user performing the request

path - the path of the folder for which to cancel the request

Returns:

A SharedFolder

Throws:

AwUnsupportedApiVersionException

java.io.IOException

AnywhereException

approveTeamFolderRequest

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

Approve a request to create a team folder

Parameters:

authToken - authentication token for the user performing the request

path - the path of the folder for which to approve the request

Returns:

A SharedFolder

Throws:

AwUnsupportedApiVersionException

java.io.IOException

AnywhereException

updateTeamFolder

public SharedFolder updateTeamFolder(AuthToken authToken,
                                     java.lang.String path,
                                     java.lang.String contact,
                                     java.lang.Long quotaBytes)
                              throws AwUnsupportedApiVersionException,
                                     java.io.IOException,
                                     AnywhereException

Update a team folder

Parameters:

authToken - authentication token for the user performing the request

path - the path of the folder for which to cancel the request

contact - contact information

quotaBytes - the new quota for the team folder, in bytes

Returns:

A SharedFolder

Throws:

AwUnsupportedApiVersionException

java.io.IOException

AnywhereException

deleteTeamFolder

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

Delete a team folder for all users, abandoning it. Requires the manager role.

Parameters:

authToken - authentication token for the user performing the request

path - the path of the folder to delete

Throws:

AwUnsupportedApiVersionException

java.io.IOException

AnywhereException

listSharedFolders

public SharedFolderListing listSharedFolders(AuthToken authToken)
                                      throws AwUnsupportedApiVersionException,
                                             java.io.IOException,
                                             AnywhereException

List all shared folders the user is a member of

Parameters:

authToken - authentication token for the user performing the request

Returns:

A SharedFolderListing

Throws:

AwUnsupportedApiVersionException

java.io.IOException

AnywhereException

listShareMembers

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

List the members of a given shared folder.

Parameters:

authToken - authentication token for the user performing the request

path - The path of the shared folder.

Returns:

A ShareMemberListing

Throws:

AwUnsupportedApiVersionException

java.io.IOException

AnywhereException

listShareMembers

public ShareMemberListing listShareMembers(AuthToken authToken,
                                           java.lang.String path,
                                           java.lang.String pageToken,
                                           java.lang.Integer pageSize)
                                    throws AwUnsupportedApiVersionException,
                                           java.io.IOException,
                                           AnywhereException

List the members of a given shared folder, which includes both users and groups. In the resulting list, groups are returned first (unsorted), then users (sorted).

Parameters:

authToken - authentication token for the user performing the request

path - The path of the shared folder.

pageToken - The page token to use to get multiple pages of users. Can be null.

pageSize - The maximum amount of results that should be returned.

Returns:

A ShareMemberListing

Throws:

AwUnsupportedApiVersionException

java.io.IOException

AnywhereException

listShareMembers

public ShareMemberListing listShareMembers(AuthToken authToken,
                                           java.lang.String path,
                                           java.lang.String pageToken,
                                           java.lang.Integer pageSize,
                                           ShareMemberListRequest.SortingCriterion sortingCriterion,
                                           ShareMemberListRequest.SortingDirection sortingDirection)
                                    throws AwUnsupportedApiVersionException,
                                           java.io.IOException,
                                           AnywhereException

List the members of a given shared folder, which includes both users and groups. In the resulting list, groups are returned first (unsorted), then users (sorted).

Parameters:

authToken - authentication token for the user performing the request

path - The path of the shared folder.

pageToken - The page token to use to get multiple pages of users. Can be null.

pageSize - The maximum amount of results that should be returned.

Returns:

Throws:

AwUnsupportedApiVersionException

java.io.IOException

AnywhereException

listShareUsers

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

List the users of a given shared folder.

Parameters:

authToken - authentication token for the user performing the request

path - The path of the shared folder.

Returns:

A ShareMemberListing

Throws:

AwUnsupportedApiVersionException

java.io.IOException

AnywhereException

syncMembership

public SharedFolder syncMembership(AuthToken authToken,
                                   java.lang.String path,
                                   boolean increaseRole,
                                   boolean inviteDeclined)
                            throws AwUnsupportedApiVersionException,
                                   java.io.IOException,
                                   AnywhereException

Sync a share's membership

Parameters:

authToken - authentication token for the user performing the request

path - The path of the shared folder

increaseRole - Whether to increase the role of users if a group would grant them an increased role

inviteDeclined - Whether to invite users who have formerly declined, left, cancelled, or been kicked out of the shared folder

Throws:

AwUnsupportedApiVersionException

java.io.IOException

AnywhereException

preserveMembership

public ShareMemberListing preserveMembership(AuthToken authToken,
                                             java.lang.String path,
                                             boolean removeGroups)
                                      throws AwUnsupportedApiVersionException,
                                             java.io.IOException,
                                             AnywhereException

Preserve a share's membership

Parameters:

authToken - authentication token for the user performing the request

path - The path of the shared folder

removeGroups - Whether to remove the groups in the share as part of the preserve membership operation

Returns:

the current membership of the share

Throws:

AwUnsupportedApiVersionException

java.io.IOException

AnywhereException

listShareGroups

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

List the groups in a share

Parameters:

authToken - authentication token for the user performing the request

path - The path of the shared folder

Returns:

The current group membership of the share

Throws:

AwUnsupportedApiVersionException

java.io.IOException

AnywhereException

searchInvite

public ShareInviteSearchResult searchInvite(AuthToken authToken,
                                            java.lang.String path,
                                            java.lang.String filter)
                                     throws AwUnsupportedApiVersionException,
                                            java.io.IOException,
                                            AnywhereException

List users and groups matching the filter

Parameters:

authToken - The authentication token for the user performing the request

path - The path of the shared folder

filter - The filter for the users and groups to match

Returns:

The list of users and groups matching the filter

Throws:

AwUnsupportedApiVersionException

java.io.IOException

AnywhereException