|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.nimbusds.oauth2.sdk.ErrorObject com.nimbusds.oauth2.sdk.token.BearerTokenError
@Immutable public class BearerTokenError
OAuth 2.0 bearer token error. Used to indicate that access to a resource protected by a Bearer access token is denied, due to the request or token being invalid, or due to the access token having insufficient scope.
Standard bearer access token errors:
Example HTTP response:
HTTP/1.1 401 Unauthorized WWW-Authenticate: Bearer realm="example.com", error="invalid_token", error_description="The access token expired"
Related specifications:
Field Summary | |
---|---|
static BearerTokenError |
INSUFFICIENT_SCOPE
The request requires higher privileges than provided by the access token. |
static BearerTokenError |
INVALID_REQUEST
The request is missing a required parameter, includes an unsupported parameter or parameter value, repeats the same parameter, uses more than one method for including an access token, or is otherwise malformed. |
static BearerTokenError |
INVALID_TOKEN
The access token provided is expired, revoked, malformed, or invalid for other reasons. |
static BearerTokenError |
MISSING_TOKEN
The request does not contain an access token. |
Constructor Summary | |
---|---|
BearerTokenError(String code,
String description)
Creates a new OAuth 2.0 bearer token error with the specified code and description. |
|
BearerTokenError(String code,
String description,
int httpStatusCode)
Creates a new OAuth 2.0 bearer token error with the specified code, description and HTTP status code. |
|
BearerTokenError(String code,
String description,
int httpStatusCode,
URL uri,
String realm,
Scope scope)
Creates a new OAuth 2.0 bearer token error with the specified code, description, HTTP status code, page URI, realm and scope. |
Method Summary | |
---|---|
String |
getRealm()
Gets the realm. |
Scope |
getScope()
Gets the required scope. |
static BearerTokenError |
parse(String wwwAuth)
Parses an OAuth 2.0 bearer token error from the specified HTTP response WWW-Authenticate header. |
BearerTokenError |
setRealm(String realm)
Sets the realm. |
BearerTokenError |
setScope(Scope scope)
Sets the required scope. |
String |
toWWWAuthenticateHeader()
Returns the WWW-Authenticate HTTP response header code for
this bearer access token error response. |
Methods inherited from class com.nimbusds.oauth2.sdk.ErrorObject |
---|
appendDescription, equals, getCode, getDescription, getHTTPStatusCode, getURI, hashCode, setDescription, setHTTPStatusCode, setURI, toString |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final BearerTokenError MISSING_TOKEN
Example:
HTTP/1.1 401 Unauthorized WWW-Authenticate: Bearer
public static final BearerTokenError INVALID_REQUEST
public static final BearerTokenError INVALID_TOKEN
public static final BearerTokenError INSUFFICIENT_SCOPE
Constructor Detail |
---|
public BearerTokenError(String code, String description)
code
- The error code, null
if not specified.description
- The error description, null
if not
specified.public BearerTokenError(String code, String description, int httpStatusCode)
code
- The error code, null
if not specified.description
- The error description, null
if not
specified.httpStatusCode
- The HTTP status code, zero if not specified.public BearerTokenError(String code, String description, int httpStatusCode, URL uri, String realm, Scope scope)
code
- The error code, null
if not specified.description
- The error description, null
if not
specified.httpStatusCode
- The HTTP status code, zero if not specified.uri
- The error page URI, null
if not
specified.realm
- The realm, null
if not specified.scope
- The required scope, null
if not
specified.Method Detail |
---|
public String getRealm()
null
if not specified.public BearerTokenError setRealm(String realm)
realm
- realm, null
if not specified.
public Scope getScope()
null
if not specified.public BearerTokenError setScope(Scope scope)
scope
- The required scope, null
if not specified.
public String toWWWAuthenticateHeader()
WWW-Authenticate
HTTP response header code for
this bearer access token error response.
Example:
Bearer realm="example.com", error="invalid_token", error_description="Invalid access token"
Www-Authenticate
header value.public static BearerTokenError parse(String wwwAuth) throws ParseException
WWW-Authenticate
header.
wwwAuth
- The WWW-Authenticate
header value to parse.
Must not be null
.
ParseException
- If the WWW-Authenticate
header value
couldn't be parsed to a Bearer token error.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |