Package org.opendaylight.netconf.mapping.api

Interface NetconfOperation

All Known Subinterfaces:

SessionAwareNetconfOperation

public interface NetconfOperation

NetconfOperation handles netconf requests. Multiple operations might be capable of handling one request at the same time. In such case, these operations are chained (ordered by HandlingPriority returned by canHandle method) and executed.

Operation can be declared as singleton or last in chain (see abstract implementations in netconf-util). If the operation is not singleton or last, it is responsible for the execution of subsequent operation and for merging the results.

Method Summary

Modifier and Type	Method	Description
HandlingPriority	canHandle(Document message)	Singleton operations should return HandlingPriority.HANDLE_WITH_MAX_PRIORITY, last operations HandlingPriority.HANDLE_WITH_DEFAULT_PRIORITY.
Document	handle(Document requestMessage, NetconfOperationChainedExecution subsequentOperation)	Execute current netconf operation and trigger execution of subsequent operations.

Method Detail

canHandle

HandlingPriority canHandle(Document message)
                    throws org.opendaylight.netconf.api.DocumentedException

Singleton operations should return HandlingPriority.HANDLE_WITH_MAX_PRIORITY, last operations HandlingPriority.HANDLE_WITH_DEFAULT_PRIORITY.

Parameters:

message - request message

Returns:

handling priority

Throws:

org.opendaylight.netconf.api.DocumentedException

handle

Document handle(Document requestMessage,
                NetconfOperationChainedExecution subsequentOperation)
         throws org.opendaylight.netconf.api.DocumentedException

Execute current netconf operation and trigger execution of subsequent operations. subsequentOperation parameter will provide information, if current operation is the termination point in execution. In case of last/singleton operation, subsequentOperation must indicate termination point.

Parameters:

requestMessage - request message

subsequentOperation - execution of subsequent netconf operation

Returns:

document

Throws:

org.opendaylight.netconf.api.DocumentedException - if operation fails