com.unboundid.scim.sdk

Class OAuthToken

java.lang.Object

com.unboundid.scim.sdk.OAuthToken

public class OAuthToken
extends Object

This class represents an OAuth token, described by RFC 6750. This class can be extended by clients that need to add extra functionality, such as the ability to extract an expiration date, scope, target audience, etc, from the token. These details are implementation-specific.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	OAuthToken.Type This enum defines the supported set of OAuth token types.

Constructor Summary

Constructors

Constructor and Description
OAuthToken(OAuthToken.Type type, String tokenValue) Constructs an OAuthToken with the specified OAuthToken.Type and token value.
OAuthToken(String tokenValue) Constructs an OAuth 2.0 bearer token with the given b64token value.

Method Summary

Methods

Modifier and Type	Method and Description
String	getFormattedValue() Returns a formatted representation of the token type and value for use as an Authorization header value.
String	getTokenValue() Returns the token value.
OAuthToken.Type	getType() Returns the token type.

Methods inherited from class java.lang.Object

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

Constructor Detail

OAuthToken

public OAuthToken(String tokenValue)

Constructs an OAuth 2.0 bearer token with the given b64token value. Note that b64token is just an ABNF syntax definition and does not imply any base64-encoding of the token value.

Parameters:

tokenValue - The bearer token value.

OAuthToken

public OAuthToken(OAuthToken.Type type,
          String tokenValue)

Constructs an OAuthToken with the specified OAuthToken.Type and token value.

Parameters:

type - The token Type.

tokenValue - The token value.

Method Detail

getType

public OAuthToken.Type getType()

Returns the token type.

Returns:

the token type.

getTokenValue

public String getTokenValue()

Returns the token value.

Returns:

the token value.

getFormattedValue

public String getFormattedValue()

Returns a formatted representation of the token type and value for use as an Authorization header value. For example, if this is a bearer token, this method would return a String like "Bearer vF9dft4qmT".

Returns:

the token type and value in HTTP header value form.