com.hds.hcpaw.fss.api

Class AnywhereAPI

java.lang.Object

com.hds.hcpaw.fss.api.AnywhereAPI

public class AnywhereAPI
extends java.lang.Object

HCP Anywhere FSS API is an API for connecting to HCP Anywhere, accessible via HTTP. This AnywhereAPI provides convenient access to the HCP Anywhere FSS API. The Builder provides all the options for customizing the AnywhereAPI as you see fit. Access to HCP Anywhere is provided through the sub APIs that are listed below, such as the AnywhereFileAPI, AnywhereFolderAPI and AnywhereLinkAPI.

In order to make calls to the sub APIs, you must first authenticate with HCP Anywhere to retrieve an AuthToken. An AuthToken can be acquired from the server by calling the authenticate method, which requires you to provide the username and password or valid certificate you use to access HCP Anywhere The returned AuthToken can be saved for later use.

Once an AuthToken is acquired, you can make calls to the sub APIs by supplying the token and any other required arguments of the sub APIs.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AnywhereAPI.Builder Builds an instance of an AnywhereAPI.

Method Summary

Modifier and Type	Method and Description
AuthToken	authenticate(java.lang.String username, java.lang.String password) Authenticates the user with HCP Anywhere and returns an AuthToken, which can then be used to make calls to the sub APIs on behalf of the user.
AuthToken	authenticateCertificate() Authenticates the user with HCP Anywhere with a client certificate and returns an AuthToken, which can then be used to make calls to the sub APIs on behalf of the user.
AnywhereActivityAPI	getActivityAPI() Generates an instance of the AnywhereActivityAPI that can be used to perform operations for activities
AnywhereClientAPI	getClientAPI() Generates an instance of the AnywhereClientAPI that can be used to perform operations for clients
AnywhereFileAPI	getFileAPI() Generates an instance of the AnywhereFileAPI that can be used to perform operations on files.
AnywhereFolderAPI	getFolderAPI() Generates an instance of the AnywhereFolderAPI that can be used to perform operations on folders.
AnywhereLinkAPI	getLinkAPI() Generates an instance of the AnywhereLinkAPI that can be used to perform operations on links.
AnywherePathAPI	getPathAPI() Generates an instance of the AnywherePathAPI that can be used to perform operations on paths (files or folders).
AnywhereProviderAPI	getProviderAPI() Generates an instance of the AnywhereProviderAPI that can be used to perform operations for providers
AnywhereSamlAPI	getSamlAPI() Generates an instance of the AnywhereSamlAPI that can be used to perform SAML operations
AnywhereShareAPI	getShareAPI() Generates an instance of the AnywhereShareAPI that can be used to perform operations for share folders
AnywhereUserAPI	getUserAPI() Generates an instance of the AnywhereUserAPI that can be used to perform operations on the user.
boolean	status() Obtains whether the system provided in the builder used to create this API is online and a valid HCP Anywhere system

Methods inherited from class java.lang.Object

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

Method Detail

authenticate

public AuthToken authenticate(java.lang.String username,
                              java.lang.String password)
                       throws java.io.IOException,
                              AnywhereException

Authenticates the user with HCP Anywhere and returns an AuthToken, which can then be used to make calls to the sub APIs on behalf of the user.

Parameters:

username - HCP Anywhere username

password - HCP Anywhere password

Returns:

the AuthToken to use in subsequent requests to identify and authenticate the user

Throws:

java.io.IOException

AnywhereException

authenticateCertificate

public AuthToken authenticateCertificate()
                                  throws java.io.IOException,
                                         AnywhereException

Authenticates the user with HCP Anywhere with a client certificate and returns an AuthToken, which can then be used to make calls to the sub APIs on behalf of the user.

Returns:

the AuthToken to use in subsequent requests to identify and authenticate the user

Throws:

java.io.IOException

AnywhereException

status

public boolean status()

Obtains whether the system provided in the builder used to create this API is online and a valid HCP Anywhere system

Returns:

true if the system provided in the builder used to create this API is online and a valid HCP Anywhere system, false otherwise

getFolderAPI

public AnywhereFolderAPI getFolderAPI()

Generates an instance of the AnywhereFolderAPI that can be used to perform operations on folders.

Returns:

an instance of the AnywhereFolderAPI that can be used to perform operations on folders

getFileAPI

public AnywhereFileAPI getFileAPI()

Generates an instance of the AnywhereFileAPI that can be used to perform operations on files.

Returns:

an instance of the AnywhereFileAPI that can be used to perform operations on files

getPathAPI

public AnywherePathAPI getPathAPI()

Generates an instance of the AnywherePathAPI that can be used to perform operations on paths (files or folders).

Returns:

an instance of the AnywherePathAPI that can be used to perform operations on paths (files or folders)

getLinkAPI

public AnywhereLinkAPI getLinkAPI()

Generates an instance of the AnywhereLinkAPI that can be used to perform operations on links.

Returns:

an instance of the AnywhereLinkAPI that can be used to perform operations on links

getUserAPI

public AnywhereUserAPI getUserAPI()

Generates an instance of the AnywhereUserAPI that can be used to perform operations on the user.

Returns:

an instance of the AnywhereUserAPI that can be used to perform operations on the user

getProviderAPI

public AnywhereProviderAPI getProviderAPI()

Generates an instance of the AnywhereProviderAPI that can be used to perform operations for providers

Returns:

an instance of the AnywhereProviderAPI that can be used to perform operations on providers

getShareAPI

public AnywhereShareAPI getShareAPI()

Generates an instance of the AnywhereShareAPI that can be used to perform operations for share folders

Returns:

an instance of the AnywhereShareAPI that can be used to perform operations on share folders

getClientAPI

public AnywhereClientAPI getClientAPI()

Generates an instance of the AnywhereClientAPI that can be used to perform operations for clients

Returns:

an instance of the AnywhereClientAPI that can be used to perform operations on clients

getActivityAPI

public AnywhereActivityAPI getActivityAPI()

Generates an instance of the AnywhereActivityAPI that can be used to perform operations for activities

Returns:

an instance of the AnywhereActivityAPI that can be used to perform operations on clients

getSamlAPI

public AnywhereSamlAPI getSamlAPI()

Generates an instance of the AnywhereSamlAPI that can be used to perform SAML operations

Returns:

an instance of the AnywhereSamlAPI that can be used to perform operations on clients