com.vmware.vapi.bindings

Class StubConfiguration

java.lang.Object

com.vmware.vapi.bindings.StubConfigurationBase

com.vmware.vapi.bindings.StubConfiguration

public final class StubConfiguration
extends StubConfigurationBase

This is a helper class for creating stub configurations.

Constructor Summary

Constructors

Constructor and Description
StubConfiguration() Default Constructor.
StubConfiguration(ExecutionContext.SecurityContext securityContext) Constructor.

Method Summary

Modifier and Type	Method and Description
Set<ErrorType>	getErrorTypes() Returns ErrorTypes to be used for resolving VMODL2 for method invocations by the configured Stub.
RetryPolicy	getRetryPolicy()
ExecutionContext.SecurityContext	getSecurityContext()
void	registerErrorTypes(List<ErrorType> errors) Registers a list of ErrorTypes to be used by the configured stub for resolving VMODL2 errors received as result of a method invocation.
void	setRetryPolicy(RetryPolicy retryPolicy)
void	setSecurityContext(ExecutionContext.SecurityContext context)

Methods inherited from class java.lang.Object

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

Constructor Detail

StubConfiguration

public StubConfiguration()

Default Constructor.

StubConfiguration

public StubConfiguration(ExecutionContext.SecurityContext securityContext)

Constructor.

Parameters:

securityContext - can be null

Method Detail

setSecurityContext

public void setSecurityContext(ExecutionContext.SecurityContext context)

Parameters:

context - the security context that will be used in the stub. can be null.

getSecurityContext

public ExecutionContext.SecurityContext getSecurityContext()

Specified by:

getSecurityContext in class StubConfigurationBase

Returns:

the security context for the given stub instance. can be null.

See Also:

SecurityContextFactory

registerErrorTypes

public void registerErrorTypes(List<ErrorType> errors)

Registers a list of ErrorTypes to be used by the configured stub for resolving VMODL2 errors received as result of a method invocation.

The types for all standard VMODL2 errors are registered and resolvable by default. This method is useful for registration of additional types for custom errors.

Parameters:

errors - types to register; can not be null; can not contain null elements

getErrorTypes

public Set<ErrorType> getErrorTypes()

Description copied from class: StubConfigurationBase

Returns ErrorTypes to be used for resolving VMODL2 for method invocations by the configured Stub.

Specified by:

getErrorTypes in class StubConfigurationBase

Returns:

list of ErrorTypes

setRetryPolicy

public void setRetryPolicy(RetryPolicy retryPolicy)

Parameters:

retryPolicy - retry policy for failed invocations; can be null

getRetryPolicy

public RetryPolicy getRetryPolicy()

Overrides:

getRetryPolicy in class StubConfigurationBase

Returns:

retry policy for failed invocations; can be null