|
OSGi™ Compendium Release 5 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ExecPlugin
An implementation of this interface takes the responsibility of handling node execute requests requests in a subtree of the DMT.
In an OSGi environment such implementations should be registered at the OSGi
service registry specifying the list of root node URIs in a String
array or in case of a single value as String
in the
execRootURIs
registration parameter.
Field Summary | |
---|---|
static java.lang.String |
EXEC_ROOT_URIS
The string to be used as key for the “execRootURIs” property when an ExecPlugin is registered. |
static java.lang.String |
MOUNT_POINTS
The string to be used as key for the mount points property when an Exec Plugin is registered with mount points. |
Method Summary | |
---|---|
void |
execute(DmtSession session,
java.lang.String[] nodePath,
java.lang.String correlator,
java.lang.String data)
Execute the given node with the given data. |
Field Detail |
---|
static final java.lang.String MOUNT_POINTS
static final java.lang.String EXEC_ROOT_URIS
Method Detail |
---|
void execute(DmtSession session, java.lang.String[] nodePath, java.lang.String correlator, java.lang.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
as the correlator
parameter for alerts sent in response to this
execute operation.
The 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 null
nodePath
- the absolute path of the node to be executed, must not be
null
correlator
- an identifier to associate this operation with any
alerts sent in response to it, can be null
data
- the parameter of the execute operation, can be null
DmtException
- with the following possible error codes:
NODE_NOT_FOUND
if the node does not existMETADATA_MISMATCH
if the command failed because of
meta-data restrictionsDATA_STORE_FAILURE
if an
error occurred while accessing the data storeCOMMAND_FAILED
if some unspecified error is encountered
while attempting to complete the commandDmtSession.execute(String, String)
,
DmtSession.execute(String, String, String)
|
OSGi™ Compendium Release 5 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |