AuthenticationScheme

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

All Implemented Interfaces:

com.vmware.vapi.bindings.StaticStructure, com.vmware.vapi.bindings.Structure, java.io.Serializable
```
public final class AuthenticationScheme
extends java.lang.Object
implements java.io.Serializable, com.vmware.vapi.bindings.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 com.vmware.vapi.data.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(com.vmware.vapi.data.StructValue __dynamicStructureFields)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
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.StructType`	`_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.StructType`	`_getType()`
`boolean`	`_hasTypeNameOf(java.lang.Class<? extends com.vmware.vapi.bindings.Structure> clazz)`
`static AuthenticationScheme`	`_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 AuthenticationScheme`	`_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)`
`int`	`hashCode()`
`java.lang.String`	`toString()`

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 com.vmware.vapi.data.StructValue __dynamicStructureFields
```
- Constructor Detail
  - AuthenticationScheme
```
public AuthenticationScheme()
```
    Default constructor.
  - AuthenticationScheme
```
protected AuthenticationScheme(com.vmware.vapi.data.StructValue __dynamicStructureFields)
```
- Method Detail
  - _getType
```
public com.vmware.vapi.bindings.type.StructType _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
  - toString
```
public java.lang.String toString()
```
    Specified by:
    
    toString in interface com.vmware.vapi.bindings.StaticStructure
    
    Overrides:
    
    toString in class java.lang.Object
  - _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.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()
```
    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
  - _newInstance
```
public static AuthenticationScheme _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 AuthenticationScheme _newInstance2(com.vmware.vapi.data.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