public interface ExecPlugin
In an OSGi environment such implementations should be registered at the OSGi
service registry specifying the list of root node URIs in a
array or in case of a single value as
String in the
execRootURIs registration parameter.
|Modifier and Type||Field and Description|
The string to be used as key for the "execRootURIs" property when an ExecPlugin is registered.
The string to be used as key for the mount points property when an Exec Plugin is registered with mount points.
static final String MOUNT_POINTS
void execute(DmtSession session, String nodePath, String correlator, String data) throws DmtException
The semantics of an execute operation and the data parameter it takes
depends on the definition of the managed object on which the command is
issued. Session information is given as it is needed for sending alerts
back from the plugin. If a correlation ID is specified, it should be used
correlator parameter for alerts sent in response to this
nodePath parameter contains an array of path segments
identifying the node to be executed in the subtree of this plugin. This
is an absolute path, so the first segment is always ".".
Special characters appear escaped in the segments.
session- a reference to the session in which the operation was issued, must not be
nodePath- the absolute path of the node to be executed, must not be
correlator- an identifier to associate this operation with any alerts sent in response to it, can be
data- the parameter of the execute operation, can be
DmtException- with the following possible error codes:
NODE_NOT_FOUNDif the node does not exist
METADATA_MISMATCHif the command failed because of meta-data restrictions
DATA_STORE_FAILUREif an error occurred while accessing the data store
COMMAND_FAILEDif some unspecified error is encountered while attempting to complete the command
DmtSession.execute(String, String, String)
Copyright © Contributors to the Eclipse Foundation Licensed under the Eclipse Foundation Specification License – v1.0