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

Class NetconfBaseServiceImpl

java.lang.Object

io.lighty.modules.southbound.netconf.impl.NetconfBaseServiceImpl

All Implemented Interfaces:

NetconfBaseService, org.opendaylight.mdsal.dom.api.DOMService

Direct Known Subclasses:

NetconfNmdaBaseServiceImpl

public class NetconfBaseServiceImpl
extends Object
implements NetconfBaseService

Constructor Summary

Constructors

Constructor	Description
NetconfBaseServiceImpl(org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NodeId nodeId, org.opendaylight.mdsal.dom.api.DOMRpcService domRpcService, org.opendaylight.yangtools.yang.model.api.SchemaContext schemaContext)

Method Summary

Modifier and Type	Method	Description
com.google.common.util.concurrent.ListenableFuture<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<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<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.ModifyAction> dataModifyActionAttribute, Optional<org.opendaylight.netconf.api.ModifyAction> defaultModifyAction, boolean rollback)	Netconf protocol operation edit-config.
com.google.common.util.concurrent.ListenableFuture<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<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.SchemaContext	getSchemaContext()	Get SchemaContext for the Netconf device of this service instance.
com.google.common.util.concurrent.ListenableFuture<org.opendaylight.mdsal.dom.api.DOMRpcResult>	lock(org.opendaylight.yangtools.yang.common.QName targetDatastore)	Netconf protocol operation lock.
com.google.common.util.concurrent.ListenableFuture<org.opendaylight.mdsal.dom.api.DOMRpcResult>	unlock(org.opendaylight.yangtools.yang.common.QName targetDatastore)	Netconf protocol operation unlock.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

NetconfBaseServiceImpl

public NetconfBaseServiceImpl(org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NodeId nodeId,
                              org.opendaylight.mdsal.dom.api.DOMRpcService domRpcService,
                              org.opendaylight.yangtools.yang.model.api.SchemaContext schemaContext)

Method Detail

get

public com.google.common.util.concurrent.ListenableFuture<org.opendaylight.mdsal.dom.api.DOMRpcResult> get(Optional<org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier> filterYII)

Description copied from interface: NetconfBaseService

Netconf protocol operation get.

Specified by:

get in interface NetconfBaseService

Parameters:

filterYII - may contain filter YangInstanceIdentifier if needed

Returns:

future with RPC result

getConfig

public com.google.common.util.concurrent.ListenableFuture<org.opendaylight.mdsal.dom.api.DOMRpcResult> getConfig(org.opendaylight.yangtools.yang.common.QName sourceDatastore,
                                                                                                                 Optional<org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier> filterYII)

Description copied from interface: NetconfBaseService

Netconf protocol operation get-config.

Specified by:

getConfig in interface NetconfBaseService

Parameters:

sourceDatastore - type of the configuration datastore being queried

filterYII - may contain filter YangInstanceIdentifier if needed

Returns:

future with RPC result

editConfig

public com.google.common.util.concurrent.ListenableFuture<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.ModifyAction> dataModifyActionAttribute,
                                                                                                                  Optional<org.opendaylight.netconf.api.ModifyAction> defaultModifyAction,
                                                                                                                  boolean rollback)

Description copied from interface: NetconfBaseService

Netconf protocol operation edit-config.

Specified by:

editConfig in interface NetconfBaseService

Parameters:

targetDatastore - type of the configuration datastore being edited

data - configuration data

dataPath - YangInstanceIdentifier for the configuration data

dataModifyActionAttribute - may contain operation attribute for the configuration data

defaultModifyAction - may contain default operation

rollback - if true, rollback on error option is added to the edit-config message

Returns:

future with RPC result

copyConfig

public com.google.common.util.concurrent.ListenableFuture<org.opendaylight.mdsal.dom.api.DOMRpcResult> copyConfig(org.opendaylight.yangtools.yang.common.QName sourceDatastore,
                                                                                                                  org.opendaylight.yangtools.yang.common.QName targetDatastore)

Description copied from interface: NetconfBaseService

Netconf protocol operation copy-config.

Specified by:

copyConfig in interface NetconfBaseService

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

public com.google.common.util.concurrent.ListenableFuture<org.opendaylight.mdsal.dom.api.DOMRpcResult> deleteConfig(org.opendaylight.yangtools.yang.common.QName targetDatastore)

Description copied from interface: NetconfBaseService

Netconf protocol operation delete-config.

Specified by:

deleteConfig in interface NetconfBaseService

Parameters:

targetDatastore - type of the configuration datastore to delete

Returns:

future with RPC result

lock

public com.google.common.util.concurrent.ListenableFuture<org.opendaylight.mdsal.dom.api.DOMRpcResult> lock(org.opendaylight.yangtools.yang.common.QName targetDatastore)

Description copied from interface: NetconfBaseService

Netconf protocol operation lock.

Specified by:

lock in interface NetconfBaseService

Parameters:

targetDatastore - of the configuration datastore to lock

Returns:

future with RPC result

unlock

public com.google.common.util.concurrent.ListenableFuture<org.opendaylight.mdsal.dom.api.DOMRpcResult> unlock(org.opendaylight.yangtools.yang.common.QName targetDatastore)

Description copied from interface: NetconfBaseService

Netconf protocol operation unlock.

Specified by:

unlock in interface NetconfBaseService

Parameters:

targetDatastore - of the configuration datastore to unlock

Returns:

future with RPC result

getDeviceId

public org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NodeId getDeviceId()

Description copied from interface: NetconfBaseService

Get Id of the Netconf device of this service instance.

Specified by:

getDeviceId in interface NetconfBaseService

Returns:

Id of the Netconf device

getDOMRpcService

public org.opendaylight.mdsal.dom.api.DOMRpcService getDOMRpcService()

Description copied from interface: NetconfBaseService

Get DOMRpcService for the Netconf device of this service instance.

Specified by:

getDOMRpcService in interface NetconfBaseService

Returns:

DOMRpcService for the Netconf device

getSchemaContext

public org.opendaylight.yangtools.yang.model.api.SchemaContext getSchemaContext()

Description copied from interface: NetconfBaseService

Get SchemaContext for the Netconf device of this service instance.

Specified by:

getSchemaContext in interface NetconfBaseService

Returns:

SchemaContext for the Netconf device