Package com.vmware.vapi.core
Class ExecutionContext
- java.lang.Object
-
- com.vmware.vapi.core.ExecutionContext
-
- All Implemented Interfaces:
java.io.Serializable
public class ExecutionContext extends java.lang.Object implements java.io.Serializable
TheExecutionContext
class provides information about the execution of an API method invocation.It consists of
- out-of-band context data provided by client and passed along with the invocation/request
- authentication/security context and data
- runtime details, specific to the request being processed
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
ExecutionContext.ApplicationData
Immutable class representing additional application specific data associated with the request for method execution represented by thisExecutionContext
.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 Description static ExecutionContext
EMPTY
Empty context
-
Constructor Summary
Constructors Constructor Description ExecutionContext()
Default constructor.ExecutionContext(ExecutionContext.ApplicationData wireData, ExecutionContext.SecurityContext securityContext)
Do not use this constructor to recreateExecutionContext
instances with modified parameters.ExecutionContext(ExecutionContext.ApplicationData wireData, ExecutionContext.SecurityContext securityContext, ExecutionContext.RuntimeData runtimeData)
Do not use this constructor to recreateExecutionContext
instances with modified parameters.ExecutionContext(ExecutionContext.SecurityContext securityContext)
Do not use this constructor to recreateExecutionContext
instances with modified parameters.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ExecutionContext.ApplicationData
retrieveApplicationData()
ExecutionContext.RuntimeData
retrieveRuntimeData()
ExecutionContext.SecurityContext
retrieveSecurityContext()
ExecutionContext
withApplicationData(ExecutionContext.ApplicationData appData)
Returns a newExecutionContext
instance with replaced application dataExecutionContext
withSecurityContext(ExecutionContext.SecurityContext secCtx)
Returns a newExecutionContext
instance with replaced security context
-
-
-
Field Detail
-
EMPTY
public static final ExecutionContext EMPTY
Empty context
-
-
Constructor Detail
-
ExecutionContext
public ExecutionContext()
Default constructor. Convenience one for creating an emptyExecutionContext
.Use
EMPTY
when distinct instance is not required.
-
ExecutionContext
public ExecutionContext(ExecutionContext.SecurityContext securityContext)
Do not use this constructor to recreateExecutionContext
instances with modified parameters. Leverage theExecutionContext.Builder
class instead.- Parameters:
securityContext
- may benull
-
ExecutionContext
public ExecutionContext(ExecutionContext.ApplicationData wireData, ExecutionContext.SecurityContext securityContext)
Do not use this constructor to recreateExecutionContext
instances with modified parameters. Leverage theExecutionContext.Builder
class instead.- Parameters:
wireData
- may benull
securityContext
- may benull
-
ExecutionContext
public ExecutionContext(ExecutionContext.ApplicationData wireData, ExecutionContext.SecurityContext securityContext, ExecutionContext.RuntimeData runtimeData)
Do not use this constructor to recreateExecutionContext
instances with modified parameters. Leverage theExecutionContext.Builder
class instead.- Parameters:
wireData
- may benull
securityContext
- may benull
runtimeData
- may benull
-
-
Method Detail
-
withApplicationData
public ExecutionContext withApplicationData(ExecutionContext.ApplicationData appData)
Returns a newExecutionContext
instance with replaced application data- Parameters:
appData
-ExecutionContext.ApplicationData
to be used in the new instance- Returns:
- new
ExecutionContext
instance with updatedExecutionContext.ApplicationData
-
withSecurityContext
public ExecutionContext withSecurityContext(ExecutionContext.SecurityContext secCtx)
Returns a newExecutionContext
instance with replaced security context- Parameters:
secCtx
-ExecutionContext.SecurityContext
to be used in the new instance- Returns:
- new
ExecutionContext
instance with updatedExecutionContext.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
-
-