com.vmware.vapi.std.activation.impl

Class ActivationManagerImpl

java.lang.Object

com.vmware.vapi.activation.ActivationMonitor

com.vmware.vapi.std.activation.impl.ActivationManagerImpl

All Implemented Interfaces:

Service, com.vmware.vapi.internal.std.activation.impl.ActivationRegistry, ActivationManagerProvider, ActivationManagerTypes

public class ActivationManagerImpl
extends ActivationMonitor
implements ActivationManagerProvider, com.vmware.vapi.internal.std.activation.impl.ActivationRegistry

WARNING: Use only as a sample. The API is experimental and subject to change in future versions.

In memory registry for activations. It is both an implementation of an activation manager service (used by clients to cancel method invocations) and a ActivationMonitor (used by service implementations to check for their own cancellation status). It requires an ActivationFilter to be deployed.

Thread-safety: the implementation is thread-safe.

Field Summary

Fields inherited from interface com.vmware.vapi.std.activation.ActivationManagerTypes

_VAPI_SERVICE_ID

Constructor Summary

Constructors

Constructor and Description
ActivationManagerImpl()

Method Summary

Modifier and Type	Method and Description
void	cancel(String activationId, AsyncContext<Void> asyncContext) Asks for cancellation of a running activation.
boolean	isCancelRequested(String activationId) Returns whether cancellation is requested for the specified activation.
void	register(String activationId, MethodIdentifier methodId) Registers an activation.
void	unregister(String activationId) Unregisters an activation.

Methods inherited from class java.lang.Object

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

Constructor Detail

ActivationManagerImpl

public ActivationManagerImpl()

Method Detail

register

public void register(String activationId,
                     MethodIdentifier methodId)
              throws IllegalArgumentException,
                     IllegalStateException

Description copied from interface: com.vmware.vapi.internal.std.activation.impl.ActivationRegistry

Registers an activation.

Specified by:

register in interface com.vmware.vapi.internal.std.activation.impl.ActivationRegistry

Parameters:

activationId - activation identifier; must not be null

methodId - identifier of the method whose activation is registered; must not be null

Throws:

IllegalArgumentException - if an argument is null

IllegalStateException - if there is already an activation with the specified identifier

unregister

public void unregister(String activationId)
                throws IllegalArgumentException

Description copied from interface: com.vmware.vapi.internal.std.activation.impl.ActivationRegistry

Unregisters an activation. Tolerates non-existing activations.

Specified by:

unregister in interface com.vmware.vapi.internal.std.activation.impl.ActivationRegistry

Parameters:

activationId - activation identifier; must not be null

Throws:

IllegalArgumentException - if the activation id is missing

isCancelRequested

public boolean isCancelRequested(String activationId)

Description copied from class: ActivationMonitor

Returns whether cancellation is requested for the specified activation.

Specified by:

isCancelRequested in class ActivationMonitor

Parameters:

activationId - activation identifier

Returns:

whether cancellation is request for the activation

cancel

public void cancel(String activationId,
                   AsyncContext<Void> asyncContext)

Description copied from interface: ActivationManagerProvider

Asks for cancellation of a running activation. Whether or not the cancellation request will have any effect depends on the implementation of the method that has to be canceled.

Operation Errors:
NotFound - there is no activation with the specified id

Specified by:

cancel in interface ActivationManagerProvider

Parameters:

activationId - activation identifier

asyncContext - Handle to report the progress, result or error of the operation invocation.