com.vmware.vapi.std.errors

Class Unauthorized

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

com.vmware.vapi.bindings.ApiError

com.vmware.vapi.std.errors.Error

com.vmware.vapi.std.errors.Unauthorized

All Implemented Interfaces:

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

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

The Unauthorized exception indicates that the user is not authorized to perform the method.

API requests may include a security context containing user credentials. For example, the user credentials could be a SAML token, a user name and password, or the session identifier for a previously established session. Invoking the method may require that the user identified by those credentials has particular privileges on the method or on one or more resource identifiers passed to the method.

Examples:

• The method requires that the user have one or more privileges on the method, but the user identified by the credentials in the security context does not have the required privileges.
• The method requires that the user have one or more privileges on a resource identifier passed to the method, but the user identified by the credentials in the security context does not have the required privileges.

Counterexamples:

• The SAML token in the request's security context has expired. A Unauthenticated exception would be used instead.
• The user name and password in the request's security context are invalid. The Unauthenticated exception would be used instead.
• The session identifier in the request's security context identifies a session that has expired. The Unauthenticated exception would be used instead.

For security reasons, the Error.getData() property in this exception is null, and the Error.getMessages() property in this exception does not disclose why the user is not authorized to perform the method. For example the messages would not disclose which privilege the user did not have or which resource identifier the user did not have the required privilege to access. The API documentation should indicate what privileges are required.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Unauthorized.Builder Builder class for Unauthorized.

Nested classes/interfaces inherited from class com.vmware.vapi.std.errors.Error

Error.Type

Field Summary

Fields inherited from class com.vmware.vapi.std.errors.Error

__dynamicStructureFields

Constructor Summary

Constructors

Modifier	Constructor and Description
	Unauthorized() Default constructor.
	Unauthorized(java.util.List<LocalizableMessage> messages, com.vmware.vapi.bindings.Structure data) This constructor is provided for backwards compatibility purposes only.
protected	Unauthorized(com.vmware.vapi.data.StructValue __dynamicStructureFields)
protected	Unauthorized(com.vmware.vapi.data.StructValue __dynamicStructureFields, Error.Type errorType)

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)
static Unauthorized	_newInstance(com.vmware.vapi.data.StructValue structValue) WARNING: Internal method, subject to change in future versions. Returns new instance of this binding class and injects the provided data value. WARNING: The returned object is not fully initialized.
static Unauthorized	_newInstance2(com.vmware.vapi.data.StructValue structValue) WARNING: Internal method, subject to change in future versions. Serves as a versioning mechanism.
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)
java.lang.String	getMessage()
int	hashCode()

Methods inherited from class com.vmware.vapi.std.errors.Error

getData, getErrorType, getMessages, setData, setMessages

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

Constructor Detail

Unauthorized

public Unauthorized(java.util.List<LocalizableMessage> messages,
                    com.vmware.vapi.bindings.Structure data)

This constructor is provided for backwards compatibility purposes only. Please use the Builder class instead.

Unauthorized

public Unauthorized()

Default constructor.

Unauthorized

protected Unauthorized(com.vmware.vapi.data.StructValue __dynamicStructureFields)

Unauthorized

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

Method Detail

_getType

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

Specified by:

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

Overrides:

_getType in class Error

_getDataValue

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

Specified by:

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

Overrides:

_getDataValue in class Error

_updateDataValue

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

Overrides:

_updateDataValue in class Error

_validate

public void _validate()

Specified by:

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

Overrides:

_validate in class Error

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class Error

hashCode

public int hashCode()

Overrides:

hashCode in class Error

getMessage

public java.lang.String getMessage()

Overrides:

getMessage in class Error

_hasTypeNameOf

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

Specified by:

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

Overrides:

_hasTypeNameOf in class Error

_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

Overrides:

_convertTo in class Error

_setDynamicField

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

Specified by:

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

Overrides:

_setDynamicField in class Error

_getDynamicField

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

Specified by:

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

Overrides:

_getDynamicField in class Error

_getDynamicFieldNames

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

Specified by:

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

Overrides:

_getDynamicFieldNames in class Error

_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

Overrides:

_getCanonicalName in class Error

_getCanonicalTypeName

public static java.lang.String _getCanonicalTypeName()

Returns the canonical type name. See _getCanonicalName().

Returns:

canonical type name

_newInstance

public static Unauthorized _newInstance(com.vmware.vapi.data.StructValue structValue)

WARNING: Internal method, subject to change in future versions.
Returns new instance of this binding class and injects the provided data value.
WARNING: The returned object is not fully initialized.

Parameters:

structValue - the source of the data contained in the binding object. Could contain more data than fields of this class can describe i.e. newer version of the binding object. Could be null.

Returns:

the static bindings StructType

_newInstance2

public static Unauthorized _newInstance2(com.vmware.vapi.data.StructValue structValue)

WARNING: Internal method, subject to change in future versions.
Serves as a versioning mechanism.