com.hds.hcpaw.fss.api

Class AnywhereClientAPI

java.lang.Object

com.hds.hcpaw.fss.api.AnywhereClientAPI

public class AnywhereClientAPI
extends java.lang.Object

API for performing client actions such as rename, clear credentials, and list. These methods are implemented using the HCP Anywhere FSS API /fss/public/client URIs.

See the method AnywhereAPI.getClientAPI() to obtain an instance of the AnywhereClientAPI.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AnywhereClientAPI(AnywhereConnector connector)

Method Summary

Modifier and Type	Method and Description
Client	clearCredentials(AuthToken authToken, java.lang.String id) Clear the client with the specified id's credentials, forcing it to be logged into again
Client	deregister(AuthToken authToken, java.lang.String id, boolean wipe) Deregister the client with the specified id
ClientListing	list(AuthToken authToken) List all of the available clients
Client	rename(AuthToken authToken, java.lang.String id, java.lang.String name) Rename the client with the specified id to have the specified name

Methods inherited from class java.lang.Object

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

Constructor Detail

AnywhereClientAPI

protected AnywhereClientAPI(AnywhereConnector connector)

Method Detail

rename

public Client rename(AuthToken authToken,
                     java.lang.String id,
                     java.lang.String name)
              throws AwUnsupportedApiVersionException,
                     java.io.IOException,
                     AnywhereException

Rename the client with the specified id to have the specified name

Parameters:

authToken - authentication token for the user performing the request

id - the id of the client to be renamed

name - the name to assign to the client

Returns:

the renamed client

Throws:

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

java.io.IOException

AnywhereException

deregister

public Client deregister(AuthToken authToken,
                         java.lang.String id,
                         boolean wipe)
                  throws AwUnsupportedApiVersionException,
                         java.io.IOException,
                         AnywhereException

Deregister the client with the specified id

Parameters:

authToken - authentication token for the user performing the request

id - the id of the client to be deregistered

wipe - whether the client should wipe all of its data

Returns:

the deregistered client

Throws:

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

java.io.IOException

AnywhereException

list

public ClientListing list(AuthToken authToken)
                   throws AwUnsupportedApiVersionException,
                          java.io.IOException,
                          AnywhereException

List all of the available clients

Parameters:

authToken - authentication token for the user performing the request

Returns:

the list of clients

Throws:

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

java.io.IOException

AnywhereException

clearCredentials

public Client clearCredentials(AuthToken authToken,
                               java.lang.String id)
                        throws AwUnsupportedApiVersionException,
                               java.io.IOException,
                               AnywhereException

Clear the client with the specified id's credentials, forcing it to be logged into again

Parameters:

authToken - authentication token for the user performing the request

id - the id of the client whose credentials should be cleared

Returns:

the client whose credentials have been cleared

Throws:

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

java.io.IOException

AnywhereException