info.dmtree.spi.ExecPlugin Maven / Gradle / Ivy
/*
* Copyright (c) OSGi Alliance (2004, 2008). All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package info.dmtree.spi;
import info.dmtree.DmtException;
import info.dmtree.DmtSession;
/**
* 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 in the execRootURIs registration
* parameter.
*
* @version $Revision: 5673 $
*/
public interface ExecPlugin {
/**
* Execute the given node with the given data. This operation corresponds to
* the EXEC command in OMA DM.
*
* 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.
*
* @param session a reference to the session in which the operation was
* issued, must not be null
* @param nodePath the absolute path of the node to be executed, must not be
* null
* @param correlator an identifier to associate this operation with any
* alerts sent in response to it, can be null
* @param data the parameter of the execute operation, can be
* null
* @throws DmtException with the following possible error codes:
*
* NODE_NOT_FOUND if the node does not exist and
* the plugin does not allow executing unexisting nodes
* METADATA_MISMATCH if the command failed
* because of meta-data restrictions
* DATA_STORE_FAILURE if an error occurred while
* accessing the data store
* COMMAND_FAILED if some unspecified error is
* encountered while attempting to complete the command
*
* @see DmtSession#execute(String, String)
* @see DmtSession#execute(String, String, String)
*/
void execute(DmtSession session, String[] nodePath, String correlator,
String data) throws DmtException;
}