org.rhq.enterprise.server.plugin.pc

Interface ControlFacet

public interface ControlFacet

Interface that server plugin components must implement if they want to expose control operations. These controls allow users to invoke plugin component operations at runtime.

Author:

John Mazzitelli

Method Summary

Methods

Modifier and Type	Method and Description
ControlResults	invoke(String name, org.rhq.core.domain.configuration.Configuration parameters) Plugin components must implement this method to allow its control operations to be invoked.

Method Detail

invoke

ControlResults invoke(String name,
                    org.rhq.core.domain.configuration.Configuration parameters)

Plugin components must implement this method to allow its control operations to be invoked. Note that implementations should not throw exceptions. If an invocation failed, the implementation must catch the exceptions and indicate the failure in the ControlResults.getError() message.

Parameters:

name - the name of the control operation to be invoked

parameters - the parameters being passed into the control operation (may be null if no parameters were defined for the named control operation)

Returns:

the results of the invocation, must never be null