com.redhat.thermostat.client.ui

Interface HostContextAction

All Superinterfaces:

ContextAction

@ExtensionPoint
public interface HostContextAction
extends ContextAction

HostContextActions provide actions that are associated with hosts and can be invoked by users. The exact position and appearance of these HostContextActions varies based on the implementation.

Plugins can register implementations of this interface as OSGi services to provide additional HostContextActions.

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 interface to provide menu items for the Host/VM tree. The menu is shown when a user right clicks a host in the Host/VM tree. A menu item for every HostContextAction is added, if the Filter matches, to this menu. Selecting a menu item invokes the appropriate HostContextAction.

See Also:

VMContextAction

Method Summary

Methods

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

Method Detail

getName

String getName()

A user-visible name for this HostContextAction. This should be localized.

Specified by:

getName in interface ContextAction

getDescription

String getDescription()

A user-visible description for this HostContextAction. This should be localized.

Specified by:

getDescription in interface ContextAction

execute

void execute(HostRef reference)

Invoked when the user selects this HostContextAction.

Parameters:

reference - the host on which this HostContextAction was invoked on.

getFilter

Filter<HostRef> getFilter()

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