com.vmware.vapi.core

Class ExecutionContext.Builder

java.lang.Object

com.vmware.vapi.core.ExecutionContext.Builder

Enclosing class:

ExecutionContext

public static class ExecutionContext.Builder
extends Object

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
ExecutionContext	build()
static ExecutionContext.Builder	from(ExecutionContext ec) Initializes the builder with existing ExecutionContext data.
ExecutionContext.Builder	mergeApplicationData(Map<String,String> data) Add multiple entries to ExecutionContext.ApplicationData.
ExecutionContext.Builder	mergeApplicationData(String key, String value) Add setting to ExecutionContext.ApplicationData.
ExecutionContext.Builder	setApplicationData(ExecutionContext.ApplicationData applicationData)
ExecutionContext.Builder	setReadTimeout(Integer readTimeout) Sets the amount of time in milliseconds the client will wait for a response from the server before timing out.
ExecutionContext.Builder	setResponseAccessor(HttpResponseAccessor responseAccessor) Sets a HttpResponseAccessor instance which can access and capture information from the raw REST response.
ExecutionContext.Builder	setRuntimeKeyValue(String key, Object value) Store additional data in the API invocation execution context in the form of a key-value entry.
ExecutionContext.Builder	setSecurityContext(ExecutionContext.SecurityContext securityContext)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Method Detail

from

public static ExecutionContext.Builder from(ExecutionContext ec)

Initializes the builder with existing ExecutionContext data. This allows to update one or more settings.

Parameters:

ec - instance to be copied; If null blank fields will be used as starting point

Returns:

builder instance with mutable fields

setApplicationData

public ExecutionContext.Builder setApplicationData(ExecutionContext.ApplicationData applicationData)

Parameters:

applicationData - can be null

Returns:

this instance

mergeApplicationData

public ExecutionContext.Builder mergeApplicationData(String key,
                                                     String value)

Add setting to ExecutionContext.ApplicationData. If ExecutionContext.ApplicationData is null new instance will be created. If the key exists it will be replaced.

Thread-safety: This method is not thread-safe.

Parameters:

key - data key

value - data value

Returns:

the ExecutionContext.Builder instance

mergeApplicationData

public ExecutionContext.Builder mergeApplicationData(Map<String,String> data)

Add multiple entries to ExecutionContext.ApplicationData. If ExecutionContext.ApplicationData is null new instance will be created. Existing keys will be replaced (or values for existing keys)

Thread-safety: This method is not thread-safe.

Parameters:

data - values

Returns:

the ExecutionContext.Builder instance

setSecurityContext

public ExecutionContext.Builder setSecurityContext(ExecutionContext.SecurityContext securityContext)

Parameters:

securityContext - can be null

Returns:

this instance

setReadTimeout

public ExecutionContext.Builder setReadTimeout(Integer readTimeout)

Sets the amount of time in milliseconds the client will wait for a response from the server before timing out.

For the HTTP 1.1 transport protocol this value maps to the SO_TIMEOUT.

If not null, this property overrides the one read from HttpConfiguration.getSoTimeout().

The default value is null.

A value of zero is interpreted as an infinite timeout, null is interpreted as unspecified at this level (concrete invocation) and client-level configuration applies.

Parameters:

readTimeout - non-negative value or null

Returns:

this instance

setResponseAccessor

public ExecutionContext.Builder setResponseAccessor(HttpResponseAccessor responseAccessor)

Sets a HttpResponseAccessor instance which can access and capture information from the raw REST response.

This accessor is only applicable for requests executed from a client that uses REST transport.

Parameters:

responseAccessor - which will be provided with the raw REST response

Returns:

this instance

setRuntimeKeyValue

public ExecutionContext.Builder setRuntimeKeyValue(String key,
                                                   Object value)

Store additional data in the API invocation execution context in the form of a key-value entry. The entry is added to the ExecutionContext.RuntimeData. The value can be accessed throughout the invocation by calling RuntimeData#getValue(key). Existing keys will be replaced.

This key-value entry will not be serialized on the wire.

Thread-safety: This method is not thread-safe.

Parameters:

key - the entry key

value - the entry value

Returns:

this instance

build

public ExecutionContext build()