com.vmware.vapi.std.errors

Class Unauthenticated

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

All Implemented Interfaces:

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

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

The Unauthenticated exception indicates that the method requires authentication and the user is not authenticated.

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.

Examples:

• The SAML token in the request's security context has expired.
• The user name and password in the request's security context are invalid.
• The session identifier in the request's security context identifies a session that has expired.

Counterexamples:

• The user is authenticated but isn't authorized to perform the requested method. The Unauthorized 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 which part of the security context is correct or incorrect. For example the messages would not disclose whether a username or a password is valid or invalid, but only that a combination of username and password is invalid.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

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

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
	Unauthenticated() Default constructor.
	Unauthenticated(java.util.List<LocalizableMessage> messages, com.vmware.vapi.bindings.Structure data) This constructor is provided for backwards compatibility purposes only.
protected	Unauthenticated(com.vmware.vapi.data.StructValue __dynamicStructureFields)
protected	Unauthenticated(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 Unauthenticated	_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 Unauthenticated	_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	getChallenge() Indicates the authentication challenges applicable to the target API provider.
java.lang.String	getMessage()
int	hashCode()
void	setChallenge(java.lang.String challenge) Indicates the authentication challenges applicable to the target API provider.

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

Unauthenticated

public Unauthenticated(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.

Unauthenticated

public Unauthenticated()

Default constructor.

Unauthenticated

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

Unauthenticated

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

Method Detail

getChallenge

public java.lang.String getChallenge()

Indicates the authentication challenges applicable to the target API provider. It can be used by a client to discover the correct authentication scheme to use. The exact syntax of the value is defined by the specific provider, the protocol and authentication schemes used.

For example, a provider using REST may adhere to the WWW-Authenticate HTTP header specification, RFC7235, section 4.1. In this case an example challenge value may be: SIGN realm="27da1358-2ba4-11e9-b210-d663bd873d93",sts="http://vcenter/sso?vsphere.local", Basic realm="vCenter"

. This property was added in vSphere API 7.0.0.0. This property is optional because it was added in a newer version than its parent node.

Returns:

The current value of the property.

setChallenge

public void setChallenge(java.lang.String challenge)

Indicates the authentication challenges applicable to the target API provider. It can be used by a client to discover the correct authentication scheme to use. The exact syntax of the value is defined by the specific provider, the protocol and authentication schemes used.

For example, a provider using REST may adhere to the WWW-Authenticate HTTP header specification, RFC7235, section 4.1. In this case an example challenge value may be: SIGN realm="27da1358-2ba4-11e9-b210-d663bd873d93",sts="http://vcenter/sso?vsphere.local", Basic realm="vCenter"

. This property was added in vSphere API 7.0.0.0. This property is optional because it was added in a newer version than its parent node.

Parameters:

challenge - New value for the property.

_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 Unauthenticated _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 Unauthenticated _newInstance2(com.vmware.vapi.data.StructValue structValue)

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