com.vmware.vapi.protocol

Enum HttpConfiguration.Protocol

java.lang.Object

java.lang.Enum<HttpConfiguration.Protocol>

com.vmware.vapi.protocol.HttpConfiguration.Protocol

All Implemented Interfaces:

Serializable, Comparable<HttpConfiguration.Protocol>

Enclosing class:

HttpConfiguration

public static enum HttpConfiguration.Protocol
extends Enum<HttpConfiguration.Protocol>

Enumerates the wire protocols supported by the vAPI client for invoking APIs.

vAPI JSON-RPC is a JSON-RPC based protocol supported by vAPI clients and servers.

Enum Constant Summary

Enum Constants

Enum Constant and Description
VAPI_JSON_RPC_1_0 vAPI JSON-RPC 1.0 (over HTTP) protocol.
VAPI_JSON_RPC_1_1 vAPI JSON-RPC 1.1 (over HTTP) protocol.

Method Summary

Modifier and Type	Method and Description
static HttpConfiguration.Protocol	valueOf(String name) Returns the enum constant of this type with the specified name.
static HttpConfiguration.Protocol[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

VAPI_JSON_RPC_1_0

public static final HttpConfiguration.Protocol VAPI_JSON_RPC_1_0

vAPI JSON-RPC 1.0 (over HTTP) protocol.

This is the default and recommended version in use. In this protocol, all the information sent by the client is encapsulated in the JSON message sent as HTTP request payload.

VAPI_JSON_RPC_1_1

public static final HttpConfiguration.Protocol VAPI_JSON_RPC_1_1

vAPI JSON-RPC 1.1 (over HTTP) protocol.

This version is enhancement over 1.0, where target service and operation, authentication and other information is transported in HTTP headers. This benefits intermediaries and proxies for making authentication or routing decisions based on the HTTP headers only, and without need to parse the JSON payload.

vAPI servers which support vAPI JSON-RPC 1.1 are compatible with and fully support 1.0 clients.

Even 1.0 server can handle 1.1 clients, but any changes made by intermediaries to the HTTP header values will not be visible for the old 1.0 servers.

Method Detail

values

public static HttpConfiguration.Protocol[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (HttpConfiguration.Protocol c : HttpConfiguration.Protocol.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static HttpConfiguration.Protocol valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null