com.vmware.vapi.metadata.authentication

Class AuthenticationInfo.SchemeType

java.lang.Object

com.vmware.vapi.bindings.ApiEnumeration<AuthenticationInfo.SchemeType>

com.vmware.vapi.metadata.authentication.AuthenticationInfo.SchemeType

All Implemented Interfaces:

java.io.Serializable

Enclosing class:

AuthenticationInfo

public static final class AuthenticationInfo.SchemeType
extends ApiEnumeration<AuthenticationInfo.SchemeType>

The SchemeType enumeration class provides enumeration constants for the set of valid authentication scheme types.

See enumerated types description.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AuthenticationInfo.SchemeType.Values Native Java enum representing this enumeration class.

Field Summary

Fields

Modifier and Type	Field and Description
static AuthenticationInfo.SchemeType	SESSION_AWARE Indicates that the scheme is a session aware authentication scheme.
static AuthenticationInfo.SchemeType	SESSIONLESS Indicates that the scheme is a session less authentication scheme, the user is authenticated on every method.

Method Summary

Modifier and Type	Method and Description
AuthenticationInfo.SchemeType.Values	getEnumValue() Returns a native Java enum constant representing this enumeration constant.
boolean	isUnknown() Checks if this enumeration constant is unknown.
static AuthenticationInfo.SchemeType	valueOf(java.lang.String name) Returns the enumeration constant for the specified name.
static AuthenticationInfo.SchemeType[]	values() Retrieve all enumeration constants pre-defined by this enumeration class.

Methods inherited from class com.vmware.vapi.bindings.ApiEnumeration

buildNameMap, equals, hashCode, name, toString

Methods inherited from class java.lang.Object

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

Field Detail

SESSIONLESS

public static final AuthenticationInfo.SchemeType SESSIONLESS

Indicates that the scheme is a session less authentication scheme, the user is authenticated on every method. There is no explicit session establishment.

SESSION_AWARE

public static final AuthenticationInfo.SchemeType SESSION_AWARE

Indicates that the scheme is a session aware authentication scheme. It requires an explicit login before executing a method and logout when a session terminates. A interface might choose to have a session aware scheme if it wants to associate some state corresponding to the user until the user logs out or if it wants to mitigate the cost of authenticating the user on every method.

Method Detail

values

public static AuthenticationInfo.SchemeType[] values()

Retrieve all enumeration constants pre-defined by this enumeration class.

Additional instances might exist at runtime, for example to represent a new constant added to this enumeration class in subsequent version of the API. Such new constant is represented as instance of AuthenticationInfo.SchemeType but is not pre-defined.

Returns:

Array of all pre-defined enumeration constants. Never null.

valueOf

public static AuthenticationInfo.SchemeType valueOf(java.lang.String name)

Returns the enumeration constant for the specified name.

If the name matches exactly the identifier used to declare an enumeration constant from this enumeration class, the constant in question will be returned.

Otherwise, a new instance of AuthenticationInfo.SchemeType will be returned for the specified name, which will not be one of the pre-defined constant instances. Such new instance maps to the AuthenticationInfo.SchemeType.Values._UNKNOWN enum constant from the native Java enum.

Parameters:

name - The name of the constant to return. Must not be null.

Returns:

Enumeration constant for the specified name. Never null.

isUnknown

public boolean isUnknown()

Checks if this enumeration constant is unknown. Unknown is a constant that is not one of the pre-defined ones for this enumeration class. Also see valueOf(java.lang.String) and values().

Returns:

true if this constant is unknown, and false otherwise.

getEnumValue

public AuthenticationInfo.SchemeType.Values getEnumValue()

Returns a native Java enum constant representing this enumeration constant. The result is useful for usual handling of Java enum, for example it can be used in switch statements.

If this enumeration constant is unknown, then AuthenticationInfo.SchemeType.Values._UNKNOWN enum constant is returned.

The native Java enum is AuthenticationInfo.SchemeType.Values.

Returns:

The Java enum constant. Never null.