com.hds.hcpaw.fss.api

Class AnywhereUserAPI

java.lang.Object

com.hds.hcpaw.fss.api.AnywhereUserAPI

public class AnywhereUserAPI
extends java.lang.Object

API for getting information about users. This method is implemented using the HCP Anywhere FSS API /fss/public/user URIs.

See the method AnywhereAPI.getUserAPI() to obtain an instance of the AnywhereUserAPI.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AnywhereUserAPI(AnywhereConnector connector)

Method Summary

Modifier and Type	Method and Description
User	getInfo(AuthToken authToken) Returns the user that the specified authToken applies to (authenticates).
FilesystemListing	listFilesystems(AuthToken authToken) List the requesting user's filesystems.
RestorePointListing	listRestorePoints(AuthToken authToken) List the requesting user's restore points.
User	updateSetting(AuthToken authToken, java.lang.String email, java.lang.Boolean emailQuota, java.lang.Boolean emailDevices, java.lang.Boolean emailAuth, java.lang.Boolean emailShareFile, java.lang.Boolean emailUpload, java.lang.Boolean emailShareFolder, java.lang.String language, java.lang.Boolean openFilesOnClick, java.lang.Boolean showSingleClickUserGuide) Update user's account settings.

Methods inherited from class java.lang.Object

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

Constructor Detail

AnywhereUserAPI

protected AnywhereUserAPI(AnywhereConnector connector)

Method Detail

getInfo

public User getInfo(AuthToken authToken)
             throws AwUnsupportedApiVersionException,
                    java.io.IOException,
                    AnywhereException

Returns the user that the specified authToken applies to (authenticates).

Parameters:

authToken - authentication token for the user performing the request

Returns:

user that the authToken applies to (authenticates)

Throws:

AwUnsupportedApiVersionException

java.io.IOException

AnywhereException

updateSetting

public User updateSetting(AuthToken authToken,
                          java.lang.String email,
                          java.lang.Boolean emailQuota,
                          java.lang.Boolean emailDevices,
                          java.lang.Boolean emailAuth,
                          java.lang.Boolean emailShareFile,
                          java.lang.Boolean emailUpload,
                          java.lang.Boolean emailShareFolder,
                          java.lang.String language,
                          java.lang.Boolean openFilesOnClick,
                          java.lang.Boolean showSingleClickUserGuide)
                   throws AwUnsupportedApiVersionException,
                          java.io.IOException,
                          AnywhereException

Update user's account settings.

Parameters:

authToken - authentication token for the user performing the request

email - Optional. Can be null. The new email address. Note if the user has an email address specified by their auth provider, then change email is not allowed and this field shall be null. If set to null then original setting will be remained

emailQuota - Optional. Can be null. Boolean indicates whether or not to send email when quota is nearly used up. If set to null then original setting will be remained

emailDevices. - Optional. Can be null. Boolean indicates whether or not to send email when another device has joined the account. If set to null then original setting will be remained

emailAuth - Optional. Can be null. Boolean indicates whether or not to send email if there are authentication failures. If set to null then original setting will be remained

emailShareFile - Optional. Can be null. Boolean indicates whether or not to send email if files and folders shared via links are accessed. If set to null then original setting will be remained

emailUpload - Optional. Can be null. Boolean indicates whether or not to send email if there are files uploaded to folders shared via links. If set to null then original setting will be remained

emailShareFolder - Optional. Can be null. Boolean indicates whether or not to send email if is invited to a shared folder. If set to null then original setting will be remained

language - Optional. Can be null. Language used by the user. If set to null then original setting will be remained

openFilesOnClick - Optional. Boolean indicates whether or not to open the Office file on click

showSingleClickUserGuide - Optional. Boolean indicates whether user has accessed singe click functionality previousy or not

Returns:

user that the authToken applies to (authenticates)

Throws:

AwUnsupportedApiVersionException

java.io.IOException

AnywhereException

listFilesystems

public FilesystemListing listFilesystems(AuthToken authToken)
                                  throws AwUnsupportedApiVersionException,
                                         java.io.IOException,
                                         AnywhereException

List the requesting user's filesystems.

Parameters:

authToken - authentication token for the user performing the request

Returns:

Throws:

AwUnsupportedApiVersionException

java.io.IOException

AnywhereException

listRestorePoints

public RestorePointListing listRestorePoints(AuthToken authToken)
                                      throws AwUnsupportedApiVersionException,
                                             java.io.IOException,
                                             AnywhereException

List the requesting user's restore points.

Parameters:

authToken - authentication token for the user performing the request

Returns:

Throws:

AwUnsupportedApiVersionException

java.io.IOException

AnywhereException