com.vmware.oauth2.errors

Class Error

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

com.vmware.vapi.bindings.ApiError

com.vmware.oauth2.errors.Error

All Implemented Interfaces:

com.vmware.vapi.bindings.StaticStructure, com.vmware.vapi.bindings.Structure, java.io.Serializable

Direct Known Subclasses:

InvalidClient, InvalidGrant, InvalidRequest, InvalidScope, InvalidTarget, UnauthorizedClient, UnsupportedGrantType

public abstract class Error
extends com.vmware.vapi.bindings.ApiError
implements java.io.Serializable, com.vmware.vapi.bindings.StaticStructure

The OAuth2 Error describes the properties common to standard OAuth 2.0 exceptions.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Error.Type Enumeration of OAuth 2.0 exceptions.

Field Summary

Fields

Modifier and Type	Field and Description
protected com.vmware.vapi.data.StructValue	__dynamicStructureFields

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Error(com.vmware.vapi.data.StructValue __dynamicStructureFields, Error.Type error)

Method Summary

Modifier and Type	Method and Description
<T extends com.vmware.vapi.bindings.Structure> T	_convertTo(java.lang.Class<T> clazz)
java.lang.String	_getCanonicalName()
static java.lang.String	_getCanonicalTypeName() Returns the canonical type name.
static com.vmware.vapi.bindings.type.ErrorType	_getClassType() WARNING: Internal method, subject to change in future versions.
com.vmware.vapi.data.StructValue	_getDataValue()
com.vmware.vapi.data.DataValue	_getDynamicField(java.lang.String fieldName)
java.util.Set<java.lang.String>	_getDynamicFieldNames()
com.vmware.vapi.bindings.type.ErrorType	_getType()
boolean	_hasTypeNameOf(java.lang.Class<? extends com.vmware.vapi.bindings.Structure> clazz)
void	_setDynamicField(java.lang.String fieldName, com.vmware.vapi.data.DataValue fieldValue)
protected void	_updateDataValue(com.vmware.vapi.data.StructValue structValue)
void	_validate()
boolean	equals(java.lang.Object obj)
Error.Type	getError() Discriminator field to help API consumers identify the structure type.
java.lang.String	getErrorDescription() Human-readable ASCII text providing additional information, used to assist the client developer in understanding the error that occurred.
java.net.URI	getErrorUri() A URI identifying a human-readable web page with information about the error, used to provide the client developer with additional information about the error.
java.lang.String	getMessage()
int	hashCode()
void	setErrorDescription(java.lang.String errorDescription) Human-readable ASCII text providing additional information, used to assist the client developer in understanding the error that occurred.
void	setErrorUri(java.net.URI errorUri) A URI identifying a human-readable web page with information about the error, used to provide the client developer with additional information about the error.

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.vmware.vapi.bindings.StaticStructure

toString

Field Detail

__dynamicStructureFields

protected com.vmware.vapi.data.StructValue __dynamicStructureFields

Constructor Detail

Error

protected Error(com.vmware.vapi.data.StructValue __dynamicStructureFields,
                Error.Type error)

Method Detail

getError

public Error.Type getError()

Discriminator field to help API consumers identify the structure type. The value of this property is automatically populated.

Returns:

The current value of the property.

getErrorDescription

public java.lang.String getErrorDescription()

Human-readable ASCII text providing additional information, used to assist the client developer in understanding the error that occurred. Values for the "error_description" parameter MUST NOT include characters outside the set %x20-21 / %x23-5B / %x5D-7E. if no additional information is available.

Returns:

The current value of the property.

setErrorDescription

public void setErrorDescription(java.lang.String errorDescription)

Human-readable ASCII text providing additional information, used to assist the client developer in understanding the error that occurred. Values for the "error_description" parameter MUST NOT include characters outside the set %x20-21 / %x23-5B / %x5D-7E. if no additional information is available.

Parameters:

errorDescription - New value for the property.

getErrorUri

public java.net.URI getErrorUri()

A URI identifying a human-readable web page with information about the error, used to provide the client developer with additional information about the error. if no such web-page is available.

Returns:

The current value of the property.

setErrorUri

public void setErrorUri(java.net.URI errorUri)

A URI identifying a human-readable web page with information about the error, used to provide the client developer with additional information about the error. if no such web-page is available.

Parameters:

errorUri - New value for the property.

_getType

public com.vmware.vapi.bindings.type.ErrorType _getType()

Specified by:

_getType in interface com.vmware.vapi.bindings.StaticStructure

_getDataValue

public com.vmware.vapi.data.StructValue _getDataValue()

Specified by:

_getDataValue in interface com.vmware.vapi.bindings.Structure

_updateDataValue

protected void _updateDataValue(com.vmware.vapi.data.StructValue structValue)

_validate

public void _validate()

Specified by:

_validate in interface com.vmware.vapi.bindings.StaticStructure

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

getMessage

public java.lang.String getMessage()

Overrides:

getMessage in class java.lang.Throwable

_hasTypeNameOf

public boolean _hasTypeNameOf(java.lang.Class<? extends com.vmware.vapi.bindings.Structure> clazz)

Specified by:

_hasTypeNameOf in interface com.vmware.vapi.bindings.Structure

_convertTo

public <T extends com.vmware.vapi.bindings.Structure> T _convertTo(java.lang.Class<T> clazz)

Specified by:

_convertTo in interface com.vmware.vapi.bindings.Structure

_setDynamicField

public void _setDynamicField(java.lang.String fieldName,
                             com.vmware.vapi.data.DataValue fieldValue)

Specified by:

_setDynamicField in interface com.vmware.vapi.bindings.StaticStructure

_getDynamicField

public com.vmware.vapi.data.DataValue _getDynamicField(java.lang.String fieldName)

Specified by:

_getDynamicField in interface com.vmware.vapi.bindings.StaticStructure

_getDynamicFieldNames

public java.util.Set<java.lang.String> _getDynamicFieldNames()

Specified by:

_getDynamicFieldNames in interface com.vmware.vapi.bindings.StaticStructure

_getClassType

public static com.vmware.vapi.bindings.type.ErrorType _getClassType()

WARNING: Internal method, subject to change in future versions.

Returns:

ErrorType instance representing the static bindings type for this Error.

_getCanonicalName

public java.lang.String _getCanonicalName()

Specified by:

_getCanonicalName in interface com.vmware.vapi.bindings.Structure

_getCanonicalTypeName

public static java.lang.String _getCanonicalTypeName()

Returns the canonical type name. See _getCanonicalName().

Returns:

canonical type name