AuthenticationScheme (vSphere Automation SDK for Java 6.7.3)

java.lang.Object
- com.vmware.vapi.std.AuthenticationScheme

All Implemented Interfaces:

StaticStructure, Structure, java.io.Serializable
```
public final class AuthenticationScheme
extends java.lang.Object
implements java.io.Serializable, StaticStructure
```
The AuthenticationScheme class defines constants for authentication scheme identifiers for authentication mechanisms present in the vAPI infrastructure shipped by VMware.
A third party extension can define and implements it's own authentication mechanism and define a constant in a different IDL file.

See Also:
Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class AuthenticationScheme.Builder
Builder class for AuthenticationScheme.

Nested Classes
Modifier and Type	Class and Description
`static class`	`AuthenticationScheme.Builder` Builder class for `AuthenticationScheme`.

Field Summary

Fields
Modifier and Type	Field and Description
`protected StructValue`	`__dynamicStructureFields`
`static java.lang.String`	`NO_AUTHENTICATION` Indicates that the request doesn't need any authentication.
`static java.lang.String`	`OAUTH_ACCESS_TOKEN` Indicates that the security context in a request is using OAuth2 based authentication scheme.
`static java.lang.String`	`SAML_BEARER_TOKEN` Indicates that the security context in a request is using a SAML bearer token based authentication scheme.
`static java.lang.String`	`SAML_HOK_TOKEN` Indicates that the security context in a request is using a SAML holder-of-key token based authentication scheme.
`static java.lang.String`	`SESSION_ID` Indicates that the security context in a request is using a session identifier based authentication scheme.
`static java.lang.String`	`USER_PASSWORD` Indicates that the security context in a request is using username/password based authentication scheme.

Constructor Summary

Constructors
Modifier Constructor and Description

AuthenticationScheme()
Default constructor.

protected AuthenticationScheme(StructValue __dynamicStructureFields)

Constructors
Modifier	Constructor and Description
	`AuthenticationScheme()` Default constructor.
`protected`	`AuthenticationScheme(StructValue __dynamicStructureFields)`

Method Summary

Methods
Modifier and Type	Method and Description
`<T extends Structure> T`	`_convertTo(java.lang.Class<T> clazz)` Converts this structure into an instance of the provided class structure if possible.
`java.lang.String`	`_getCanonicalName()` Returns the canonical name of the structure.
`static java.lang.String`	`_getCanonicalTypeName()` Returns the canonical type name.
`static com.vmware.vapi.bindings.type.StructType`	`_getClassType()` WARNING: Internal method, subject to change in future versions.
`StructValue`	`_getDataValue()` Returns this `Structure` represented in the dynamic `DataValue` model.
`DataValue`	`_getDynamicField(java.lang.String fieldName)` Get dynamic filed value.
`java.util.Set<java.lang.String>`	`_getDynamicFieldNames()` Get the names of the dynamic fields in the structure.
`com.vmware.vapi.bindings.type.StructType`	`_getType()` WARNING: Internal method, subject to change in future versions.
`boolean`	`_hasTypeNameOf(java.lang.Class<? extends Structure> clazz)` Checks if the runtime type name of this structure matches the type represented by the specified binding class.
`static AuthenticationScheme`	`_newInstance(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 AuthenticationScheme`	`_newInstance2(StructValue structValue)` WARNING: Internal method, subject to change in future versions. Serves as a versioning mechanism.
`void`	`_setDynamicField(java.lang.String fieldName, DataValue fieldValue)` Sets a dynamic field value.
`protected void`	`_updateDataValue(StructValue structValue)`
`void`	`_validate()` Validates the state of the discriminated unions and HasFieldsOf restrictions (if any) in this Java language binding `Structure`.
`boolean`	`equals(java.lang.Object obj)`
`int`	`hashCode()`
`java.lang.String`	`toString()` Returns a string representation of this structure.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - NO_AUTHENTICATION
```
public static final java.lang.String NO_AUTHENTICATION
```
    Indicates that the request doesn't need any authentication.
    
    See Also:
    Constant Field Values
  - SAML_BEARER_TOKEN
```
public static final java.lang.String SAML_BEARER_TOKEN
```
    Indicates that the security context in a request is using a SAML bearer token based authentication scheme.
    In this scheme, the following pieces of information has to be passed in the SecurityContext structure in the execution context of the request:
    - The scheme identifier: com.vmware.vapi.std.security.saml_bearer_token
    - The token itself
    Sample security context in JSON format that matches the specification: { 'schemeId': 'com.vmware.vapi.std.security.saml_bearer_token', 'token': 'the token itself' } vAPI runtime provide convenient factory methods that take SAML bearer token and to create the security context that conforms to the above mentioned format.
    See Also:
    Constant Field Values
  - SAML_HOK_TOKEN
```
public static final java.lang.String SAML_HOK_TOKEN
```
    Indicates that the security context in a request is using a SAML holder-of-key token based authentication scheme.
    In this scheme, the following pieces of information has to be passed in the SecurityContext structure in the execution context of the request:
    - The scheme identifier: com.vmware.vapi.std.security.saml_hok_token
    - Signature of the request: This includes - algorithm used for signing the request, SAML holder of key token and signature digest
    - Request timestamp: This includes the created and expires timestamp of the request. The timestamp should match the following format - YYYY-MM-DDThh:mm:ss.sssZ (e.g. 1878-03-03T19:20:30.451Z).
    Sample security context in JSON format that matches the specification: { 'schemeId': 'com.vmware.vapi.std.security.saml_hok_token', 'signature': { 'alg': 'RS256', 'samlToken': ..., 'value': ...,}, 'timestamp': { 'created': '2012-10-26T12:24:18.941Z', 'expires': '2012-10-26T12:44:18.941Z', } } vAPI runtime provide convenient factory methods that take SAML holder of key token and private key to create the security context that conforms to the above mentioned format.
    See Also:
    Constant Field Values
  - SESSION_ID
```
public static final java.lang.String SESSION_ID
```
    Indicates that the security context in a request is using a session identifier based authentication scheme.
    In this scheme, the following pieces of information has to be passed in the SecurityContext structure in the execution context of the request:
    - The scheme identifier - com.vmware.vapi.std.security.session_id
    - Valid session identifier - This is usually returned by a login method of a session manager interface for a particular vAPI service of this authentication scheme
    Sample security context in JSON format that matches the specification: { 'schemeId': 'com.vmware.vapi.std.security.session_id', 'sessionId': ...., } vAPI runtime provides convenient factory methods that take session identifier as input parameter and create a security context that conforms to the above format.
    See Also:
    Constant Field Values
  - USER_PASSWORD
```
public static final java.lang.String USER_PASSWORD
```
    Indicates that the security context in a request is using username/password based authentication scheme.
    In this scheme, the following pieces of information has to be passed in the SecurityContext structure in the execution context of the request:
    - The scheme identifier - com.vmware.vapi.std.security.user_pass
    - Username
    - Password
    Sample security context in JSON format that matches the specification: { 'schemeId': 'com.vmware.vapi.std.security.user_pass', 'userName': ...., 'password': ... }
    vAPI runtime provides convenient factory methods that take username and password as input parameters and create a security context that conforms to the above format.
    See Also:
    Constant Field Values
  - OAUTH_ACCESS_TOKEN
```
public static final java.lang.String OAUTH_ACCESS_TOKEN
```
    Indicates that the security context in a request is using OAuth2 based authentication scheme.
    In this scheme, the following pieces of information has to be passed in the SecurityContext structure in the execution context of the request:
    - The scheme identifier - com.vmware.vapi.std.security.oauth
    - Valid OAuth2 access token - This is usually acquired by OAuth2 Authorization Server after successful authentication of the end user.
    Sample security context in JSON format that matches the specification: { 'schemeId': 'com.vmware.vapi.std.security.oauth', 'accesstoken': .... }
    vAPI runtime provides convenient factory methods that takes OAuth2 access token as input parameter and creates a security context that conforms to the above format.
    See Also:
    Constant Field Values
  - __dynamicStructureFields
```
protected StructValue __dynamicStructureFields
```
- Constructor Detail
  - AuthenticationScheme
```
public AuthenticationScheme()
```
    Default constructor.
  - AuthenticationScheme
```
protected AuthenticationScheme(StructValue __dynamicStructureFields)
```
- Method Detail
  - _getType
```
public com.vmware.vapi.bindings.type.StructType _getType()
```
    Description copied from interface: StaticStructure
    
    WARNING: Internal method, subject to change in future versions. Returns StructType instance representing the static bindings type for this Structure.
    
    Specified by:
    
    _getType in interface StaticStructure
    
    Returns:
    the static bindings StructType
  - _getDataValue
```
public StructValue _getDataValue()
```
    Description copied from interface: Structure
    
    Returns this Structure represented in the dynamic DataValue model.
    Attempts to change the returned StructValue representation are not required to change the state of this structure. Actually the behavior is implementation dependent and is unspecified. In general the returned value shouldn't be changed.
    
    Specified by:
    
    _getDataValue in interface Structure
    
    Returns:
    StructValue representing this structure
  - _updateDataValue
```
protected void _updateDataValue(StructValue structValue)
```
  - _validate
```
public void _validate()
```
    Description copied from interface: StaticStructure
    
    Validates the state of the discriminated unions and HasFieldsOf restrictions (if any) in this Java language binding Structure.
    More precisely, for each union: given value of the discriminant/tag field (@UnionTag in the IDL) of an union in this structure, validates that:
  - all fields of the union required for that value of the discriminant are set
  - fields of the union that are not allowed for that value of the discriminant are not set
  - any other fields of the structure (not participating in the union) do not affect the validation result

Specified by:: _validate in interface 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

toString
```
public java.lang.String toString()
```
Description copied from interface: StaticStructure

Returns a string representation of this structure. The result is pretty printed in order to be easy to read. It is intended to be used for different debugging/tracing purposes, e.g. dumping structures into logging traces.
In general no code should depend on the format of the resulting string. E.g. there must be no attempts to parse for re-creation of the original instance.

Specified by:

toString in interface StaticStructure

Overrides:

toString in class java.lang.Object

Returns:
a string representation of this static structure instance

_hasTypeNameOf
```
public boolean _hasTypeNameOf(java.lang.Class<? extends Structure> clazz)
```
Description copied from interface: Structure

Checks if the runtime type name of this structure matches the type represented by the specified binding class.
This can be used as efficient check to determine if this instance can be successfully converted to the target type.

Specified by:

_hasTypeNameOf in interface Structure

Parameters:
clazz - bindings class for the target structure; must not be null

Returns:
true if this structures type name matches exactly the specified class' type name.

_convertTo
```
public <T extends Structure> T _convertTo(java.lang.Class<T> clazz)
```
Description copied from interface: Structure

Converts this structure into an instance of the provided class structure if possible. A conversion will be possible if the requested structure's fields are all present in this structure.

Specified by:

_convertTo in interface Structure

Parameters:
clazz - type of the result structure. cannot be null.

Returns:
an instance of the requested type if conversion is possible. CoreException is thrown otherwise.

_setDynamicField
```
public void _setDynamicField(java.lang.String fieldName,
                    DataValue fieldValue)
```
Description copied from interface: StaticStructure

Sets a dynamic field value. The dynamic filed is extra filed that is not part of the static fields of the structure.

Specified by:

_setDynamicField in interface StaticStructure

Parameters:
fieldName - canonical name of the dynamic field to set
fieldValue - the value of the field

_getDynamicField
```
public DataValue _getDynamicField(java.lang.String fieldName)
```
Description copied from interface: StaticStructure

Get dynamic filed value. Works only on dynamic fields.

Specified by:

_getDynamicField in interface StaticStructure

Parameters:
fieldName - the canonical name of the dynamic field

Returns:
the DataValue of the dynamic field

_getDynamicFieldNames
```
public java.util.Set<java.lang.String> _getDynamicFieldNames()
```
Description copied from interface: StaticStructure

Get the names of the dynamic fields in the structure.

Specified by:

_getDynamicFieldNames in interface StaticStructure

Returns:
set of the canonical field names for the dynamic fields

_getClassType
```
public static com.vmware.vapi.bindings.type.StructType _getClassType()
```
WARNING: Internal method, subject to change in future versions.

Returns:
StructType instance representing the static bindings type for this Structure.

_getCanonicalName
```
public java.lang.String _getCanonicalName()
```
Description copied from interface: Structure

Returns the canonical name of the structure. By default the canonical name is derived from the fully-qualified IDL name by converting to lower case and inserting underscores between words. For example org.example.FooBar would turn into org.example.foo_bar.

Specified by:

_getCanonicalName in interface Structure

Returns:
canonical name

_getCanonicalTypeName
```
public static java.lang.String _getCanonicalTypeName()
```
Returns the canonical type name. See _getCanonicalName().

Returns:
canonical type name

_newInstance
```
public static AuthenticationScheme _newInstance(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 AuthenticationScheme _newInstance2(StructValue structValue)
```
WARNING: Internal method, subject to change in future versions.
Serves as a versioning mechanism.

Class AuthenticationScheme

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

NO_AUTHENTICATION

SAML_BEARER_TOKEN

SAML_HOK_TOKEN

SESSION_ID

USER_PASSWORD

OAUTH_ACCESS_TOKEN

__dynamicStructureFields

Constructor Detail

AuthenticationScheme

AuthenticationScheme

Method Detail

_getType

_getDataValue

_updateDataValue

_validate

equals

hashCode

toString

_hasTypeNameOf

_convertTo

_setDynamicField

_getDynamicField

_getDynamicFieldNames

_getClassType

_getCanonicalName

_getCanonicalTypeName

_newInstance

_newInstance2