com.hds.hcpaw.fss.api.model

Class AuthToken

java.lang.Object

com.hds.hcpaw.fss.api.model.AuthToken

public class AuthToken
extends java.lang.Object

An AuthToken stores all the credentials required to communicate with HCP Anywhere. AuthTokens are retrieved by providing HCP Anywhere login credentials to the HCP Anywhere server. Once an AuthToken is retrieved, calls can be made to the sub APIs by supplying the token and any other required arguments of the sub APIs to HCP Anywhere. To acquire an AuthToken, see AnywhereAPI.authenticate() .

Method Summary

Modifier and Type	Method and Description
static AuthToken	fromString(java.lang.String tokenString) Generates an AuthToken using the token String provided.
static java.lang.String	toAuthHeaderValue(java.lang.String type, java.lang.String value) Returns a string appropriate for use as the value of an HTTP Authorization header.
java.lang.String	toString() A String representation of an AuthToken.

Methods inherited from class java.lang.Object

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

Method Detail

fromString

public static AuthToken fromString(java.lang.String tokenString)

Generates an AuthToken using the token String provided. Returns null if the tokenString can not be parsed. The tokenString should be the result of calling toString() on an AuthToken.

Parameters:

tokenString - String used to generate an AuthToken. This String should have been generated by calling toString() on an AuthToken.

Returns:

an AuthToken, or null if the token String cannot be parsed

Throws:

java.lang.IllegalArgumentException - if tokenString is not of the correct format.

See Also:

AnywhereAPI.authenticate(String, String)

toString

public java.lang.String toString()

A String representation of an AuthToken. This String can be passed to fromString(String) to reconstruct the AuthToken.

Overrides:

toString in class java.lang.Object

toAuthHeaderValue

public static java.lang.String toAuthHeaderValue(java.lang.String type,
                                                 java.lang.String value)

Returns a string appropriate for use as the value of an HTTP Authorization header.

Parameters:

type - the authentication scheme

value - the value for the authentication scheme

Returns:

a String formatted appropriately for use as an Authorization header