Package com.google.api.client.auth.oauth2

Class TokenErrorResponse

java.lang.Object

java.util.AbstractMap<java.lang.String,java.lang.Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

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

All Implemented Interfaces:

java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.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

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

java.util.AbstractMap.SimpleEntry<K extends java.lang.Object,V extends java.lang.Object>, java.util.AbstractMap.SimpleImmutableEntry<K extends java.lang.Object,V extends java.lang.Object>

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

java.util.Map.Entry<K extends java.lang.Object,V extends java.lang.Object>

Field Summary

Fields

Modifier and Type	Field	Description
private java.lang.String	error	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).
private java.lang.String	errorDescription	Human-readable text providing additional information, used to assist the client developer in understanding the error that occurred or null for none.
private java.lang.String	errorUri	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.

Constructor Summary

Constructors

Constructor	Description
TokenErrorResponse()

Method Summary

Modifier and Type	Method	Description
TokenErrorResponse	clone()
java.lang.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).
java.lang.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.
java.lang.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(java.lang.String fieldName, java.lang.Object value)
TokenErrorResponse	setError(java.lang.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(java.lang.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(java.lang.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

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Field Detail

error

private java.lang.String error

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).

errorDescription

private java.lang.String errorDescription

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

errorUri

private java.lang.String errorUri

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.

Constructor Detail

TokenErrorResponse

public TokenErrorResponse()

Method Detail

getError

public final java.lang.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(java.lang.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 java.lang.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(java.lang.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 java.lang.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(java.lang.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(java.lang.String fieldName,
                              java.lang.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