com.vmware.vapi.core

Class ExecutionContext

java.lang.Object

com.vmware.vapi.core.ExecutionContext

All Implemented Interfaces:

Serializable

public class ExecutionContext
extends Object
implements Serializable

The ExecutionContext class provides information about the execution of an API method invocation.

It consists of

1. out-of-band context data provided by client and passed along with the invocation/request
2. authentication/security context and data
3. runtime details, specific to the request being processed

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ExecutionContext.ApplicationData Immutable class representing additional application specific data associated with the request for method execution represented by this ExecutionContext.
static class	ExecutionContext.Builder
static class	ExecutionContext.RuntimeData This class contains data and settings related to the execution of the invocation by the vAPI runtime, protocol and transport.
static interface	ExecutionContext.SecurityContext Implementations of this interface will provide all needed data for authentication for the given invocation.

Field Summary

Fields

Modifier and Type	Field and Description
static ExecutionContext	EMPTY Empty context

Constructor Summary

Constructors

Constructor and Description
ExecutionContext() Default constructor.
ExecutionContext(ExecutionContext.ApplicationData wireData, ExecutionContext.SecurityContext securityContext) Do not use this constructor to recreate ExecutionContext instances with modified parameters.
ExecutionContext(ExecutionContext.ApplicationData wireData, ExecutionContext.SecurityContext securityContext, ExecutionContext.RuntimeData runtimeData) Do not use this constructor to recreate ExecutionContext instances with modified parameters.
ExecutionContext(ExecutionContext.SecurityContext securityContext) Do not use this constructor to recreate ExecutionContext instances with modified parameters.

Method Summary

Modifier and Type	Method and Description
ExecutionContext.ApplicationData	retrieveApplicationData()
ExecutionContext.RuntimeData	retrieveRuntimeData()
ExecutionContext.SecurityContext	retrieveSecurityContext()
ExecutionContext	withApplicationData(ExecutionContext.ApplicationData appData) Returns a new ExecutionContext instance with replaced application data
ExecutionContext	withSecurityContext(ExecutionContext.SecurityContext secCtx) Returns a new ExecutionContext instance with replaced security context

Methods inherited from class java.lang.Object

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

Field Detail

EMPTY

public static final ExecutionContext EMPTY

Empty context

Constructor Detail

ExecutionContext

public ExecutionContext()

Default constructor. Convenience one for creating an empty ExecutionContext.

Use EMPTY when distinct instance is not required.

ExecutionContext

public ExecutionContext(ExecutionContext.SecurityContext securityContext)

Do not use this constructor to recreate ExecutionContext instances with modified parameters. Leverage the ExecutionContext.Builder class instead.

Parameters:

securityContext - may be null

ExecutionContext

public ExecutionContext(ExecutionContext.ApplicationData wireData,
                        ExecutionContext.SecurityContext securityContext)

Do not use this constructor to recreate ExecutionContext instances with modified parameters. Leverage the ExecutionContext.Builder class instead.

Parameters:

wireData - may be null

securityContext - may be null

ExecutionContext

public ExecutionContext(ExecutionContext.ApplicationData wireData,
                        ExecutionContext.SecurityContext securityContext,
                        ExecutionContext.RuntimeData runtimeData)

Do not use this constructor to recreate ExecutionContext instances with modified parameters. Leverage the ExecutionContext.Builder class instead.

Parameters:

wireData - may be null

securityContext - may be null

runtimeData - may be null

Method Detail

withApplicationData

public ExecutionContext withApplicationData(ExecutionContext.ApplicationData appData)

Returns a new ExecutionContext instance with replaced application data

Parameters:

appData - ExecutionContext.ApplicationData to be used in the new instance

Returns:

new ExecutionContext instance with updated ExecutionContext.ApplicationData

withSecurityContext

public ExecutionContext withSecurityContext(ExecutionContext.SecurityContext secCtx)

Returns a new ExecutionContext instance with replaced security context

Parameters:

secCtx - ExecutionContext.SecurityContext to be used in the new instance

Returns:

new ExecutionContext instance with updated ExecutionContext.SecurityContext

retrieveApplicationData

public ExecutionContext.ApplicationData retrieveApplicationData()

Returns:

the application data; may be null

retrieveSecurityContext

public ExecutionContext.SecurityContext retrieveSecurityContext()

Returns:

the security context; may be null

retrieveRuntimeData

public ExecutionContext.RuntimeData retrieveRuntimeData()

Returns:

the runtime data; may be null