Package io.lighty.modules.southbound.netconf.impl

Interface NetconfBaseService

All Superinterfaces:
org.opendaylight.mdsal.dom.api.DOMService
All Known Subinterfaces:
NetconfNmdaBaseService
All Known Implementing Classes:
NetconfBaseServiceImpl, NetconfNmdaBaseServiceImpl
public interface NetconfBaseService extends org.opendaylight.mdsal.dom.api.DOMService
This service implements Netconf protocol operations as specified in NETCONF Protocol Operations Instance of this service is bound to specific Netconf device in topology-netconf. Supported Netconf operations: get, get-config ,edit-config, copy-config, delete-config, lock, unlock. Operations close-session and kill-session are not supported by this service, because this functionality is in responsibility of Netconf SBP itself.

  • Method Summary

    Modifier and Type
    Method
    Description
    com.google.common.util.concurrent.ListenableFuture<? extends org.opendaylight.mdsal.dom.api.DOMRpcResult>
    copyConfig(org.opendaylight.yangtools.yang.common.QName sourceDatastore, org.opendaylight.yangtools.yang.common.QName targetDatastore)
    Netconf protocol operation copy-config.
    com.google.common.util.concurrent.ListenableFuture<? extends org.opendaylight.mdsal.dom.api.DOMRpcResult>
    deleteConfig(org.opendaylight.yangtools.yang.common.QName targetDatastore)
    Netconf protocol operation delete-config.
    com.google.common.util.concurrent.ListenableFuture<? extends org.opendaylight.mdsal.dom.api.DOMRpcResult>
    editConfig(org.opendaylight.yangtools.yang.common.QName targetDatastore, Optional<org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode> data, org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier dataPath, Optional<org.opendaylight.netconf.api.EffectiveOperation> dataEffectiveOperationAttribute, Optional<org.opendaylight.netconf.api.EffectiveOperation> defaultEffectiveOperation, boolean rollback)
    Netconf protocol operation edit-config.
    com.google.common.util.concurrent.ListenableFuture<? extends org.opendaylight.mdsal.dom.api.DOMRpcResult>
    get(Optional<org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier> filterYII)
    Netconf protocol operation get.
    com.google.common.util.concurrent.ListenableFuture<? extends org.opendaylight.mdsal.dom.api.DOMRpcResult>
    getConfig(org.opendaylight.yangtools.yang.common.QName sourceDatastore, Optional<org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier> filterYII)
    Netconf protocol operation get-config.
    org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NodeId
    getDeviceId()
    Get Id of the Netconf device of this service instance.
    org.opendaylight.mdsal.dom.api.DOMRpcService
    getDOMRpcService()
    Get DOMRpcService for the Netconf device of this service instance.
    org.opendaylight.yangtools.yang.model.api.EffectiveModelContext
    getEffectiveModelContext()
    Get SchemaContext for the Netconf device of this service instance.
    com.google.common.util.concurrent.ListenableFuture<? extends org.opendaylight.mdsal.dom.api.DOMRpcResult>
    lock(org.opendaylight.yangtools.yang.common.QName targetDatastore)
    Netconf protocol operation lock.
    com.google.common.util.concurrent.ListenableFuture<? extends org.opendaylight.mdsal.dom.api.DOMRpcResult>
    unlock(org.opendaylight.yangtools.yang.common.QName targetDatastore)
    Netconf protocol operation unlock.

  • Method Details

    • get

      com.google.common.util.concurrent.ListenableFuture<? extends org.opendaylight.mdsal.dom.api.DOMRpcResult> get(Optional<org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier> filterYII)
      Netconf protocol operation get.
      Parameters:
      filterYII - may contain filter YangInstanceIdentifier if needed
      Returns:
      future with RPC result

    • getConfig

      com.google.common.util.concurrent.ListenableFuture<? extends org.opendaylight.mdsal.dom.api.DOMRpcResult> getConfig(org.opendaylight.yangtools.yang.common.QName sourceDatastore, Optional<org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier> filterYII)
      Netconf protocol operation get-config.
      Parameters:
      sourceDatastore - type of the configuration datastore being queried
      filterYII - may contain filter YangInstanceIdentifier if needed
      Returns:
      future with RPC result

    • editConfig

      com.google.common.util.concurrent.ListenableFuture<? extends org.opendaylight.mdsal.dom.api.DOMRpcResult> editConfig(org.opendaylight.yangtools.yang.common.QName targetDatastore, Optional<org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode> data, org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier dataPath, Optional<org.opendaylight.netconf.api.EffectiveOperation> dataEffectiveOperationAttribute, Optional<org.opendaylight.netconf.api.EffectiveOperation> defaultEffectiveOperation, boolean rollback)
      Netconf protocol operation edit-config.
      Parameters:
      targetDatastore - type of the configuration datastore being edited
      data - configuration data
      dataPath - YangInstanceIdentifier for the configuration data
      dataEffectiveOperationAttribute - may contain operation attribute for the configuration data
      defaultEffectiveOperation - may contain default operation
      rollback - if true, rollback on error option is added to the edit-config message
      Returns:
      future with RPC result

    • copyConfig

      com.google.common.util.concurrent.ListenableFuture<? extends org.opendaylight.mdsal.dom.api.DOMRpcResult> copyConfig(org.opendaylight.yangtools.yang.common.QName sourceDatastore, org.opendaylight.yangtools.yang.common.QName targetDatastore)
      Netconf protocol operation copy-config.
      Parameters:
      sourceDatastore - type of the configuration datastore to use as the source of the copy-config operation
      targetDatastore - type of the configuration datastore to use as the destination of the copy-config operation
      Returns:
      future with RPC result

    • deleteConfig

      com.google.common.util.concurrent.ListenableFuture<? extends org.opendaylight.mdsal.dom.api.DOMRpcResult> deleteConfig(org.opendaylight.yangtools.yang.common.QName targetDatastore)
      Netconf protocol operation delete-config.
      Parameters:
      targetDatastore - type of the configuration datastore to delete
      Returns:
      future with RPC result

    • lock

      com.google.common.util.concurrent.ListenableFuture<? extends org.opendaylight.mdsal.dom.api.DOMRpcResult> lock(org.opendaylight.yangtools.yang.common.QName targetDatastore)
      Netconf protocol operation lock.
      Parameters:
      targetDatastore - of the configuration datastore to lock
      Returns:
      future with RPC result

    • unlock

      com.google.common.util.concurrent.ListenableFuture<? extends org.opendaylight.mdsal.dom.api.DOMRpcResult> unlock(org.opendaylight.yangtools.yang.common.QName targetDatastore)
      Netconf protocol operation unlock.
      Parameters:
      targetDatastore - of the configuration datastore to unlock
      Returns:
      future with RPC result

    • getDeviceId

      org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NodeId getDeviceId()
      Get Id of the Netconf device of this service instance.
      Returns:
      Id of the Netconf device

    • getDOMRpcService

      org.opendaylight.mdsal.dom.api.DOMRpcService getDOMRpcService()
      Get DOMRpcService for the Netconf device of this service instance.
      Returns:
      DOMRpcService for the Netconf device

    • getEffectiveModelContext

      org.opendaylight.yangtools.yang.model.api.EffectiveModelContext getEffectiveModelContext()
      Get SchemaContext for the Netconf device of this service instance.
      Returns:
      SchemaContext for the Netconf device