com.vmware.vapi.metadata.authentication

Class AuthenticationInfo

java.lang.Object

com.vmware.vapi.metadata.authentication.AuthenticationInfo

All Implemented Interfaces:

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

public final class AuthenticationInfo
extends java.lang.Object
implements java.io.Serializable, com.vmware.vapi.bindings.StaticStructure

The AuthenticationInfo class describes the authentication information. Authentication information could be specified for a package element, service elenent or an operation element.

Using the authentication scheme information, a client invoking an API call from any interface can figure out what kind of credentials are needed for that API call.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AuthenticationInfo.Builder Builder class for AuthenticationInfo.
static class	AuthenticationInfo.SchemeType The SchemeType enumeration class provides enumeration constants for the set of valid authentication scheme types.

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	AuthenticationInfo() Default constructor.
protected	AuthenticationInfo(com.vmware.vapi.data.StructValue __dynamicStructureFields)

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.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 AuthenticationInfo	_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 AuthenticationInfo	_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	getScheme() String identifier of the authentication scheme.
AuthenticationInfo.SchemeType	getSchemeType() The type of the authentication scheme.
java.lang.String	getSessionManager() In a session aware authentication scheme, a session manager is required that supports create, delete and keepAlive methods.
int	hashCode()
void	setScheme(java.lang.String scheme) String identifier of the authentication scheme.
void	setSchemeType(AuthenticationInfo.SchemeType schemeType) The type of the authentication scheme.
void	setSessionManager(java.lang.String sessionManager) In a session aware authentication scheme, a session manager is required that supports create, delete and keepAlive methods.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

__dynamicStructureFields

protected com.vmware.vapi.data.StructValue __dynamicStructureFields

Constructor Detail

AuthenticationInfo

public AuthenticationInfo()

Default constructor.

AuthenticationInfo

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

Method Detail

getSchemeType

public AuthenticationInfo.SchemeType getSchemeType()

The type of the authentication scheme.

Returns:

The current value of the property.

setSchemeType

public void setSchemeType(AuthenticationInfo.SchemeType schemeType)

The type of the authentication scheme.

Parameters:

schemeType - New value for the property.

getSessionManager

public java.lang.String getSessionManager()

In a session aware authentication scheme, a session manager is required that supports create, delete and keepAlive methods. The fully qualified interface name of the session manager is provided in getSessionManager() property. This interface is responsible for handling sessions. This property is optional and it is only relevant when the value of getSchemeType() is AuthenticationInfo.SchemeType.SESSION_AWARE.

Returns:

The current value of the property.

setSessionManager

public void setSessionManager(java.lang.String sessionManager)

In a session aware authentication scheme, a session manager is required that supports create, delete and keepAlive methods. The fully qualified interface name of the session manager is provided in getSessionManager() property. This interface is responsible for handling sessions. This property is optional and it is only relevant when the value of getSchemeType() is AuthenticationInfo.SchemeType.SESSION_AWARE.

Parameters:

sessionManager - New value for the property.

getScheme

public java.lang.String getScheme()

String identifier of the authentication scheme.

Following are the supported authentication schemes by the infrastructure:

• The identifier com.vmware.vapi.std.security.saml_hok_token for SAML holder of key token based authentication mechanism.
• The identifier com.vmware.vapi.std.security.bearer_token for SAML bearer token based authentication mechanism.
• The identifier com.vmware.vapi.std.security.session_id for session based authentication mechanism.
• The identifier com.vmware.vapi.std.security.user_pass for username and password based authentication mechanism.

Returns:

The current value of the property.

setScheme

public void setScheme(java.lang.String scheme)

String identifier of the authentication scheme.

Following are the supported authentication schemes by the infrastructure:

• The identifier com.vmware.vapi.std.security.saml_hok_token for SAML holder of key token based authentication mechanism.
• The identifier com.vmware.vapi.std.security.bearer_token for SAML bearer token based authentication mechanism.
• The identifier com.vmware.vapi.std.security.session_id for session based authentication mechanism.
• The identifier com.vmware.vapi.std.security.user_pass for username and password based authentication mechanism.

Parameters:

scheme - New value for the property.

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

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