Module org.opendaylight.netconf.dom.api
Package org.opendaylight.netconf.dom.api

Interface NetconfDataTreeService

All Superinterfaces:
org.opendaylight.mdsal.dom.api.DOMService<NetconfDataTreeService,NetconfDataTreeService.Extension>, org.opendaylight.yangtools.concepts.ExtensibleObject<NetconfDataTreeService,NetconfDataTreeService.Extension>
public interface NetconfDataTreeService extends org.opendaylight.mdsal.dom.api.DOMService<NetconfDataTreeService,NetconfDataTreeService.Extension>
Interface for base and additional operations for NETCONF (e.g. get, get-config, edit-config, lock, unlock, commit, etc). The <edit-config> operation is extended according its attributes (merge, replace, create, delete, remove), as per RFC6241.

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static interface 
    NetconfDataTreeService.Extension
    Type capture of a DOMService.Extension applicable to NetconfDataTreeService implementations.

  • Method Summary

    Modifier and Type
    Method
    Description
    com.google.common.util.concurrent.ListenableFuture<? extends org.opendaylight.mdsal.dom.api.DOMRpcResult>
    commit()
    The <commit> operation.
    com.google.common.util.concurrent.ListenableFuture<? extends org.opendaylight.mdsal.dom.api.DOMRpcResult>
    create(org.opendaylight.mdsal.common.api.LogicalDatastoreType store, org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier path, org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode data, Optional<org.opendaylight.netconf.api.EffectiveOperation> defaultOperation)
    The <edit-config> operation with create attribute.
    com.google.common.util.concurrent.ListenableFuture<? extends org.opendaylight.mdsal.dom.api.DOMRpcResult>
    delete(org.opendaylight.mdsal.common.api.LogicalDatastoreType store, org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier path)
    The <edit-config> operation with create attribute.
    com.google.common.util.concurrent.ListenableFuture<? extends org.opendaylight.mdsal.dom.api.DOMRpcResult>
    discardChanges()
    The <discard-changes> operation.
    com.google.common.util.concurrent.ListenableFuture<Optional<org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode>>
    get(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier path)
    The <get> operation.
    com.google.common.util.concurrent.ListenableFuture<Optional<org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode>>
    get(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier path, List<org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier> fields)
    The <get> operation with specific fields that are read from device.
    com.google.common.util.concurrent.ListenableFuture<Optional<org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode>>
    getConfig(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier path)
    The <get-config> operation.
    com.google.common.util.concurrent.ListenableFuture<Optional<org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode>>
    getConfig(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier path, List<org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier> fields)
    The <get-config> operation with specified fields that are read from device.
    @NonNull Object
    getDeviceId()
    Return device identifier.
    com.google.common.util.concurrent.ListenableFuture<? extends org.opendaylight.mdsal.dom.api.DOMRpcResult>
    lock()
    The <lock> operation.
    com.google.common.util.concurrent.ListenableFuture<? extends org.opendaylight.mdsal.dom.api.DOMRpcResult>
    merge(org.opendaylight.mdsal.common.api.LogicalDatastoreType store, org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier path, org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode data, Optional<org.opendaylight.netconf.api.EffectiveOperation> defaultOperation)
    The <edit-config> operation with merge attribute.
    com.google.common.util.concurrent.ListenableFuture<? extends org.opendaylight.mdsal.dom.api.DOMRpcResult>
    remove(org.opendaylight.mdsal.common.api.LogicalDatastoreType store, org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier path)
    The <edit-config> operation with create attribute.
    com.google.common.util.concurrent.ListenableFuture<? extends org.opendaylight.mdsal.dom.api.DOMRpcResult>
    replace(org.opendaylight.mdsal.common.api.LogicalDatastoreType store, org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier path, org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode data, Optional<org.opendaylight.netconf.api.EffectiveOperation> defaultOperation)
    The <edit-config> operation with replace attribute.
    com.google.common.util.concurrent.ListenableFuture<? extends org.opendaylight.mdsal.dom.api.DOMRpcResult>
    unlock()
    The <lock> operation.

    Methods inherited from interface org.opendaylight.yangtools.concepts.ExtensibleObject

    extension, findExtension, supportedExtensions

  • Method Details

    • getDeviceId

      @NonNull Object getDeviceId()
      Return device identifier.
      Returns:
      Device's identifier, must not be null.

    • lock

      @CheckReturnValue com.google.common.util.concurrent.ListenableFuture<? extends org.opendaylight.mdsal.dom.api.DOMRpcResult> lock()
      The <lock> operation. Allows the client to lock the entire configuration datastore system of a device.
      Returns:
      result of <lock> operation

    • unlock

      @CheckReturnValue com.google.common.util.concurrent.ListenableFuture<? extends org.opendaylight.mdsal.dom.api.DOMRpcResult> unlock()
      The <lock> operation. Used to release a configuration lock, previously obtained with the <lock> operation.
      Returns:
      result of <unlock> operation

    • discardChanges

      com.google.common.util.concurrent.ListenableFuture<? extends org.opendaylight.mdsal.dom.api.DOMRpcResult> discardChanges()
      The <discard-changes> operation. If device supports :candidate capability, discards any uncommitted changes by resetting the candidate configuration with the content of the running configuration.
      Returns:
      result of <discard-changes> operation

    • get

      com.google.common.util.concurrent.ListenableFuture<Optional<org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode>> get(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier path)
      The <get> operation. Retrieve running configuration and device state information.
      Returns:
      result of <get> operation

    • get

      com.google.common.util.concurrent.ListenableFuture<Optional<org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode>> get(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier path, List<org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier> fields)
      The <get> operation with specific fields that are read from device.
      Parameters:
      path - path to data
      fields - list of fields (paths relative to parent path)
      Returns:
      result of <get> operation

    • getConfig

      com.google.common.util.concurrent.ListenableFuture<Optional<org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode>> getConfig(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier path)
      The <get-config> operation. Retrieve all or part of a specified configuration datastore.
      Returns:
      result of <get-config> operation

    • getConfig

      com.google.common.util.concurrent.ListenableFuture<Optional<org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode>> getConfig(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier path, List<org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier> fields)
      The <get-config> operation with specified fields that are read from device.
      Returns:
      result of <get-config> operation

    • merge

      com.google.common.util.concurrent.ListenableFuture<? extends org.opendaylight.mdsal.dom.api.DOMRpcResult> merge(org.opendaylight.mdsal.common.api.LogicalDatastoreType store, org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier path, org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode data, Optional<org.opendaylight.netconf.api.EffectiveOperation> defaultOperation)
      The <edit-config> operation with merge attribute. The configuration data identified by the element containing this attribute is merged with the configuration at the corresponding level in the configuration datastore.
      Returns:
      result of <edit-config> operation

    • replace

      com.google.common.util.concurrent.ListenableFuture<? extends org.opendaylight.mdsal.dom.api.DOMRpcResult> replace(org.opendaylight.mdsal.common.api.LogicalDatastoreType store, org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier path, org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode data, Optional<org.opendaylight.netconf.api.EffectiveOperation> defaultOperation)
      The <edit-config> operation with replace attribute. The configuration data identified by the element containing this attribute replaces any related configuration in the configuration datastore.
      Returns:
      result of <edit-config> operation

    • create

      com.google.common.util.concurrent.ListenableFuture<? extends org.opendaylight.mdsal.dom.api.DOMRpcResult> create(org.opendaylight.mdsal.common.api.LogicalDatastoreType store, org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier path, org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode data, Optional<org.opendaylight.netconf.api.EffectiveOperation> defaultOperation)
      The <edit-config> operation with create attribute. The configuration data identified by the element containing this attribute is added to the configuration if and only if the configuration data does not already exist in the configuration datastore.
      Returns:
      result of<edit-config> operation

    • delete

      com.google.common.util.concurrent.ListenableFuture<? extends org.opendaylight.mdsal.dom.api.DOMRpcResult> delete(org.opendaylight.mdsal.common.api.LogicalDatastoreType store, org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier path)
      The <edit-config> operation with create attribute. The configuration data identified by the element containing this attribute is deleted from the configuration if and only if the configuration data currently exists in the configuration datastore.
      Returns:
      result of <edit-config> operation

    • remove

      com.google.common.util.concurrent.ListenableFuture<? extends org.opendaylight.mdsal.dom.api.DOMRpcResult> remove(org.opendaylight.mdsal.common.api.LogicalDatastoreType store, org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier path)
      The <edit-config> operation with create attribute. The configuration data identified by the element containing this attribute is deleted from the configuration if the configuration data currently exists in the configuration datastore.
      Returns:
      result of <edit-config> operation

    • commit

      com.google.common.util.concurrent.ListenableFuture<? extends org.opendaylight.mdsal.dom.api.DOMRpcResult> commit()
      The <commit> operation. If device supports :candidate capability, commit the candidate configuration as the device's new current configuration.
      Returns:
      result of <commit> operation