com.redhat.thermostat.client.ui

Interface VMContextAction

All Superinterfaces:

ContextAction

All Known Implementing Classes:

KillVMAction

@ExtensionPoint
public interface VMContextAction
extends ContextAction

VMContextActions provide actions that are associated with Java Virtual Machines and can be invoked by users. The exact position and appearance of these VMContextActions varies based on the client implementation.

Plugins can register implementation of this interface as OSGi services to provide additional VMContextActions.

Implementation Note

The following information is specific to the current release and may change in a future release.

The swing client uses instances of this class to provide menu items in the Host/VM tree. The menu is shown when a user right-clicks a VM in the Host/VM tree. A menu item for every VMContextAction is added, if the Filter matches, to this menu. Selecting a menu item invokes the corresponding VMContextAction.

See Also:

HostContextAction

Method Summary

Methods

Modifier and Type	Method and Description
void	execute(VmRef reference) Invoked when the user selects this VMContextAction.
String	getDescription() A user-visible description for VMContextAction.
Filter<VmRef>	getFilter() The Filter returned by this method is used to select what VMs this VMContextAction is applicable to.
String	getName() A user-visible name for this VMContextAction.

Method Detail

getName

String getName()

A user-visible name for this VMContextAction. Should be localized.

Specified by:

getName in interface ContextAction

getDescription

String getDescription()

A user-visible description for VMContextAction. Should be localized.

Specified by:

getDescription in interface ContextAction

execute

void execute(VmRef reference)

Invoked when the user selects this VMContextAction.

Parameters:

reference - specifies the vm that this VMContextAction was invoked on.

getFilter

Filter<VmRef> getFilter()

The Filter returned by this method is used to select what VMs this VMContextAction is applicable to.