com.google.api.client.auth.oauth2

Class TokenErrorResponse

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.client.auth.oauth2.TokenErrorResponse

All Implemented Interfaces:

Cloneable, Map<String,Object>

public class TokenErrorResponse
extends com.google.api.client.json.GenericJson

OAuth 2.0 parser for an error access token response as specified in Error Response.

Implementation is not thread-safe.

Since:

1.7

Author:

Yaniv Inbar

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

com.google.api.client.util.GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
TokenErrorResponse()

Method Summary

Methods

Modifier and Type	Method and Description
TokenErrorResponse	clone()
String	getError() Returns the error code ("invalid_request", "invalid_client", "invalid_grant", "unauthorized_client", "unsupported_grant_type", "invalid_scope", or an extension error code as specified in Defining Additional Error Codes).
String	getErrorDescription() Returns the human-readable text providing additional information, used to assist the client developer in understanding the error that occurred or null for none.
String	getErrorUri() Returns the URI identifying a human-readable web page with information about the error, used to provide the client developer with additional information about the error or null for none.
TokenErrorResponse	set(String fieldName, Object value)
TokenErrorResponse	setError(String error) Sets the error code ("invalid_request", "invalid_client", "invalid_grant", "unauthorized_client", "unsupported_grant_type", "invalid_scope", or an extension error code as specified in Defining Additional Error Codes).
TokenErrorResponse	setErrorDescription(String errorDescription) Sets the human-readable text providing additional information, used to assist the client developer in understanding the error that occurred or null for none.
TokenErrorResponse	setErrorUri(String errorUri) Sets the URI identifying a human-readable web page with information about the error, used to provide the client developer with additional information about the error or null for none.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, equals, hashCode, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

TokenErrorResponse

public TokenErrorResponse()

Method Detail

getError

public final String getError()

Returns the error code ("invalid_request", "invalid_client", "invalid_grant", "unauthorized_client", "unsupported_grant_type", "invalid_scope", or an extension error code as specified in Defining Additional Error Codes).

setError

public TokenErrorResponse setError(String error)

Sets the error code ("invalid_request", "invalid_client", "invalid_grant", "unauthorized_client", "unsupported_grant_type", "invalid_scope", or an extension error code as specified in Defining Additional Error Codes).

Overriding is only supported for the purpose of calling the super implementation and changing the return type, but nothing else.

getErrorDescription

public final String getErrorDescription()

Returns the human-readable text providing additional information, used to assist the client developer in understanding the error that occurred or null for none.

setErrorDescription

public TokenErrorResponse setErrorDescription(String errorDescription)

Sets the human-readable text providing additional information, used to assist the client developer in understanding the error that occurred or null for none.

Overriding is only supported for the purpose of calling the super implementation and changing the return type, but nothing else.

getErrorUri

public final String getErrorUri()

Returns the URI identifying a human-readable web page with information about the error, used to provide the client developer with additional information about the error or null for none.

setErrorUri

public TokenErrorResponse setErrorUri(String errorUri)

Sets the URI identifying a human-readable web page with information about the error, used to provide the client developer with additional information about the error or null for none.

Overriding is only supported for the purpose of calling the super implementation and changing the return type, but nothing else.

set

public TokenErrorResponse set(String fieldName,
                     Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public TokenErrorResponse clone()

Overrides:

clone in class com.google.api.client.json.GenericJson