|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.nimbusds.oauth2.sdk.id.Identifier com.nimbusds.oauth2.sdk.token.Token com.nimbusds.oauth2.sdk.token.AccessToken
public abstract class AccessToken
The base abstract class for access tokens.
Related specifications:
Constructor Summary | |
---|---|
AccessToken(AccessTokenType type)
Creates a new minimal access token with a randomly generated value. |
|
AccessToken(AccessTokenType type,
int length)
Creates a new minimal access token with a randomly generated value of the specified length. |
|
AccessToken(AccessTokenType type,
int length,
long lifetime,
Scope scope)
Creates a new access token with a randomly generated value of the specified length and optional lifetime and scope. |
|
AccessToken(AccessTokenType type,
long lifetime,
Scope scope)
Creates a new access token with a randomly generated value and the specified optional lifetime and scope. |
|
AccessToken(AccessTokenType type,
String value)
Creates a new minimal access token with the specified value. |
|
AccessToken(AccessTokenType type,
String value,
long lifetime,
Scope scope)
Creates a new access token with the specified value and optional lifetime and scope. |
Method Summary | |
---|---|
int |
compareTo(AccessToken other)
|
long |
getLifetime()
Gets the lifetime of this access token. |
Scope |
getScope()
Gets the scope of this access token. |
AccessTokenType |
getType()
Gets the access token type. |
static AccessToken |
parse(net.minidev.json.JSONObject jsonObject)
Parses an access token from a JSON object access token response. |
static AccessToken |
parse(String header)
Parses an Authorization HTTP request header value for an
access token. |
abstract String |
toAuthorizationHeader()
Returns the Authorization HTTP request header value for this
access token. |
net.minidev.json.JSONObject |
toJSONObject()
Returns the token parameters as a JSON object, as required for the composition of an access token response. |
String |
toJSONString()
Returns the JSON string representation of this identifier. |
Methods inherited from class com.nimbusds.oauth2.sdk.id.Identifier |
---|
equals, getValue, hashCode, toString |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public AccessToken(AccessTokenType type)
type
- The access token type. Must not be null
.public AccessToken(AccessTokenType type, int length)
type
- The access token type. Must not be null
.length
- The number of characters. Must be a positive integer.public AccessToken(AccessTokenType type, long lifetime, Scope scope)
type
- The access token type. Must not be null
.lifetime
- The lifetime in seconds, 0 if not specified.scope
- The scope, null
if not specified.public AccessToken(AccessTokenType type, int length, long lifetime, Scope scope)
type
- The access token type. Must not be null
.length
- The number of characters. Must be a positive
integer.lifetime
- The lifetime in seconds, 0 if not specified.scope
- The scope, null
if not specified.public AccessToken(AccessTokenType type, String value)
type
- The access token type. Must not be null
.value
- The access token value. Must not be null
or
empty string.public AccessToken(AccessTokenType type, String value, long lifetime, Scope scope)
type
- The access token type. Must not be null
.value
- The access token value. Must not be null
or
empty string.lifetime
- The lifetime in seconds, 0 if not specified.scope
- The scope, null
if not specified.Method Detail |
---|
public AccessTokenType getType()
public long getLifetime()
public Scope getScope()
null
if not specified.public net.minidev.json.JSONObject toJSONObject()
Token
Note that JSONObject implements Map<String,Object>
.
Example:
{ "access_token" : "2YotnFZFEjr1zCsicMWpAA", "token_type" : "example", "expires_in" : 3600, "example_parameter" : "example_value" }
toJSONObject
in class Token
public String toJSONString()
Identifier
toJSONString
in interface net.minidev.json.JSONAware
toJSONString
in class Identifier
public abstract String toAuthorizationHeader()
Authorization
HTTP request header value for this
access token.
Authorization
header value.public int compareTo(AccessToken other)
compareTo
in interface Comparable<AccessToken>
public static AccessToken parse(net.minidev.json.JSONObject jsonObject) throws ParseException
jsonObject
- The JSON object to parse. Must not be
null
.
ParseException
- If the JSON object couldn't be parsed to an
access token.public static AccessToken parse(String header) throws ParseException
Authorization
HTTP request header value for an
access token. Only bearer access token are supported.
header
- The Authorization
header value to parse. Must
not be null
.
ParseException
- If the Authorization
header value
couldn't be parsed to an access token.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |