Fixing javadoc failures post MDSAL-API migration.
Change-Id: I9e6c5408c5f132006bc0c737a0980ac0fe6425c8
Signed-off-by: Nidhi Adhvaryu <nidhi.adhvaryu@ericsson.com>
Signed-off-by: Apurba Mukherjee <apurba.mukherjee@ericsson.com>
Signed-off-by: R P Karthika <r.p.karthika@ericsson.com>
/**
* Build a service information structure.
*
- * @deprecated Use {@link #buildServiceInfo(String, int)}.
+ * @deprecated Use {@link #buildServiceInfo(String, Uint8)}.
*/
@Deprecated
public static ServicesInfo buildServiceInfo(String serviceName, short serviceIndex, Uint8 servicePriority,
/**
* Build a service information structure.
*
- * @deprecated Use {@link #buildServiceInfo(String, int)}.
+ * @deprecated Use {@link #buildServiceInfo(String, Uint8)}.
*/
@Deprecated
public static ServicesInfo buildServiceInfo(String serviceName, short serviceIndex, Uint8 servicePriority,
/**
* Asynchronous non-blocking bulk delete to data store.
*
- * @deprecated Use {@link ManagedNewTransactionRunner} instead of this.
+ * @deprecated Use {@link org.opendaylight.genius.infra.ManagedNewTransactionRunner} instead of this.
*/
/*@Deprecated
public static <T extends DataObject> void asyncBulkRemove(final DataBroker broker,
BiFunction<@Nullable T, T, NextAction> callback,
Duration timeoutDuration, Consumer<DataTreeIdentifier<T>> timedOutCallback);
+
/**
* Call back when expected instance was added or updated, with NextAction support.
* @param store the expected data store
* @param callback the callback as {@link BiFunction}, where the first argument is the data before the update
* or null in case of an add, the second argument is the data after the update (or add; never null),
* and the returned value determines whether to keep listening for changes or not anymore.
+ * @param <T> DataObject subclass
*/
<T extends DataObject> void onAddOrUpdate(LogicalDatastoreType store, InstanceIdentifier<T> path,
BiFunction<@Nullable T, T, NextAction> callback);
/**
- * Call back when expected instance was added or updated, with implicit {@link NextAction#UNREGISTER}.
- * See {@link #onAddOrUpdate(LogicalDatastoreType, InstanceIdentifier, BiFunction)} for more details.
- * @param <T>
- * DataObject subclass
+ * Call back when expected instance was added or updated, with NextAction support.
+ * @param store the expected data store
+ * @param path the path to watch for changes on
+ * @param callback the callback as {@link BiFunction}, where the first argument is the data before the update
+ * or null in case of an add, the second argument is the data after the update (or add; never null),
+ * and the returned value determines whether to keep listening for changes or not anymore.
+ * @param <T> DataObject subclass
*/
default <T extends DataObject> void onAddOrUpdate(LogicalDatastoreType store, InstanceIdentifier<T> path,
BiConsumer<@Nullable T, T> callback) {
*
* <p>The consumer should not (cannot) itself use
* {@link WriteTransaction#cancel()}, or
- * {@link WriteTransaction#submit()} (it will throw an {@link UnsupportedOperationException}).
+ * (it will throw an {@link UnsupportedOperationException}).
*
* <p>This is an asynchronous API, like {@link DataBroker}'s own;
* when returning from this method, the operation of the Transaction may well still be ongoing in the background,
* (but better NOT by using the blocking {@link Future#get()} on it).
*
* @param txConsumer the {@link CheckedConsumer} that needs a new write only transaction
- * @return the {@link ListenableFuture} returned by {@link WriteTransaction#submit()},
+ * @return the {@link ListenableFuture} returned by ,
* or a failed future with an application specific exception (not from submit())
+ * @param <E> Exception subclass
*/
@CheckReturnValue
@Deprecated
*
* <p>The consumer should not (cannot) itself use
* {@link ReadWriteTransaction#cancel()}, or
- * {@link ReadWriteTransaction#submit()} (it will throw an {@link UnsupportedOperationException}).
+ * (it will throw an {@link UnsupportedOperationException}).
*
* <p>This is an asynchronous API, like {@link DataBroker}'s own;
* when returning from this method, the operation of the Transaction may well still be ongoing in the background,
* (but better NOT by using the blocking {@link Future#get()} on it).
*
* @param txConsumer the {@link CheckedConsumer} that needs a new read-write transaction
- * @return the {@link ListenableFuture} returned by {@link ReadWriteTransaction#submit()},
+ * @return the {@link ListenableFuture} returned by ,
* or a failed future with an application specific exception (not from submit())
+ * @param <E> Exception subclass
*/
@CheckReturnValue
@Deprecated
*
* @throws E if an error occurs.
* @throws InterruptedException if the transaction is interrupted.
+ * @param <D> DataObject subclass
+ * @param <E> Exception subclass
+ * @param <R> The type of result returned by the function.
*/
<D extends Datastore, E extends Exception, R> R applyWithNewReadOnlyTransactionAndClose(Class<D> datastoreType,
InterruptibleCheckedFunction<TypedReadTransaction<D>, R, E> txFunction) throws E, InterruptedException;
*
* <p>The function must not itself use
* {@link ReadWriteTransaction#cancel()}, or
- * {@link ReadWriteTransaction#submit()} (it will throw an {@link UnsupportedOperationException}).
+ * (it will throw an {@link UnsupportedOperationException}).
*
* <p>The provided transaction is specific to the given logical datastore type and cannot be used for any
* other.
* @param datastoreType the {@link Datastore} type that will be accessed
* @param txFunction the {@link InterruptibleCheckedFunction} that needs a new read-write transaction
*
- * @return the {@link ListenableFuture} returned by {@link ReadWriteTransaction#submit()},
+ * @return the {@link ListenableFuture} returned by ,
* or a failed future with an application specific exception (not from submit())
+ * @param <D> DataObject subclass
+ * @param <E> Exception subclass
+ * @param <R> The type of result returned by the function.
*/
@CheckReturnValue
<D extends Datastore, E extends Exception, R>
*
* @throws E if an error occurs.
* @throws InterruptedException if the transaction is interrupted.
+ * @param <D> DataObject subclass
+ * @param <E> Exception subclass
*/
<D extends Datastore, E extends Exception> void callWithNewReadOnlyTransactionAndClose(Class<D> datastoreType,
InterruptibleCheckedConsumer<TypedReadTransaction<D>, E> txConsumer) throws E, InterruptedException;
*
* <p>The consumer should not (cannot) itself use
* {@link ReadWriteTransaction#cancel()}, or
- * {@link ReadWriteTransaction#submit()} (it will throw an {@link UnsupportedOperationException}).
+ * (it will throw an {@link UnsupportedOperationException}).
*
* <p>The provided transaction is specific to the given logical datastore type and cannot be used for any
* other.
*
* @param datastoreType the {@link Datastore} type that will be accessed
* @param txConsumer the {@link InterruptibleCheckedConsumer} that needs a new read-write transaction
- * @return the {@link ListenableFuture} returned by {@link ReadWriteTransaction#submit()},
+ * @return the {@link ListenableFuture} returned by ,
* or a failed future with an application specific exception (not from submit())
+ * @param <D> DataObject subclass
+ * @param <E> Exception subclass
*/
@CheckReturnValue
<D extends Datastore, E extends Exception>
*
* <p>The consumer should not (cannot) itself use
* {@link WriteTransaction#cancel()}, or
- * {@link WriteTransaction#submit()} (it will throw an {@link UnsupportedOperationException}).
+ * (it will throw an {@link UnsupportedOperationException}).
*
* <p>The provided transaction is specific to the given logical datastore type and cannot be used for any
* other.
*
* @param datastoreType the {@link Datastore} type that will be accessed
* @param txConsumer the {@link InterruptibleCheckedConsumer} that needs a new write only transaction
- * @return the {@link ListenableFuture} returned by {@link WriteTransaction#submit()},
+ * @return the {@link ListenableFuture} returned by ,
* or a failed future with an application specific exception (not from submit())
+ * @param <D> DataObject subclass
+ * @param <E> Exception subclass
*/
@CheckReturnValue
<D extends Datastore, E extends Exception>
import java.util.Optional;
import org.opendaylight.mdsal.binding.api.ReadTransaction;
import org.opendaylight.mdsal.binding.api.Transaction;
+import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
import org.opendaylight.yangtools.yang.binding.DataObject;
import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
/**
* Reads an object from the given path.
*
- * @see ReadTransaction#read(org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType,
- * InstanceIdentifier)
+ * @see ReadTransaction#read(LogicalDatastoreType, InstanceIdentifier)
*
* @param path The path to read from.
* @param <T> The type of the expected object.
/**
* Determines if an object exists at the given path.
*
- * @see ReadTransaction#exists(org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType,
- * InstanceIdentifier)
+ * @see ReadTransaction#exists(LogicalDatastoreType, InstanceIdentifier)
*
* @param path The path to read from.
* @return A future providing access to the result of the check, when it’s available, or any error encountered.
import org.opendaylight.mdsal.binding.api.Transaction;
import org.opendaylight.mdsal.binding.api.WriteTransaction;
+import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
import org.opendaylight.yangtools.yang.binding.DataObject;
import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
/**
* Writes an object to the given path.
*
- * @see WriteTransaction#put(org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType,
- * InstanceIdentifier, DataObject)
+ * @see WriteTransaction#put(LogicalDatastoreType, InstanceIdentifier, DataObject) )
*
* @param path The path to write to.
* @param data The object to write.
/**
* Writes an object to the given path, creating missing parents if requested.
*
- * @see WriteTransaction#put(org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType,
- * InstanceIdentifier, DataObject, boolean)
+ * @see WriteTransaction#put(LogicalDatastoreType, InstanceIdentifier, DataObject)
*
* @param path The path to write to.
* @param data The object to write.
/**
* Merges an object with the data already present at the given path.
*
- * @see WriteTransaction#merge(org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType,
- * InstanceIdentifier, DataObject)
+ * @see WriteTransaction#merge(LogicalDatastoreType, InstanceIdentifier, DataObject)
*
* @param path The path to write to.
* @param data The object to merge.
/**
* Merges an object with the data already present at the given path, creating missing parents if requested.
*
- * @see WriteTransaction#merge(org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType,
- * InstanceIdentifier, DataObject, boolean)
+ * @see WriteTransaction#merge(LogicalDatastoreType, InstanceIdentifier, DataObject)
*
* @param path The path to write to.
* @param data The object to merge.
/**
* Deletes the object present at the given path.
*
- * @see WriteTransaction#delete(org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType,
- * InstanceIdentifier)
+ * @see WriteTransaction#delete(LogicalDatastoreType, InstanceIdentifier)
*
* @param path The path to delete.
*/
import java.util.Optional;
import java.util.concurrent.ExecutionException;
import org.opendaylight.genius.datastoreutils.SingleTransactionDataBroker;
+import org.opendaylight.genius.infra.Datastore;
import org.opendaylight.genius.mdsalutil.actions.ActionDrop;
import org.opendaylight.mdsal.binding.api.DataBroker;
import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
/**
* Deprecated read.
+ * @param datastoreType the {@link Datastore} type that will be accessed
+ * @param path The path to write to.
+ * @param broker the broker
* @deprecated Use {@link SingleTransactionDataBroker#syncReadOptionalAndTreatReadFailedExceptionAsAbsentOptional(
* DataBroker, LogicalDatastoreType, InstanceIdentifier)}
+ * @return returns an Optional object containing the data
+ * @param <T> DataObject subclass
*/
@Deprecated
public static <T extends DataObject> Optional<T> read(LogicalDatastoreType datastoreType,
/**
* Deprecated read.
+ * @param broker the broker
+ * @param datastoreType the {@link Datastore} type that will be accessed
+ * @param path The path to write to.
* @deprecated Use {@link SingleTransactionDataBroker#syncReadOptional(
* DataBroker, LogicalDatastoreType, InstanceIdentifier)}
+ * @return returns an Optional object containing the data
+ * @param <T> DataObject subclass
+ * @throws ExecutionException in case of a technical (!) error while reading
+ * @throws InterruptedException if the transaction is interrupted
*/
@Deprecated
public static <T extends DataObject> Optional<T> read(DataBroker broker, LogicalDatastoreType datastoreType,
/**
* Deprecated write.
*
+ * @param broker the broker
+ * @param datastoreType the {@link Datastore} type that will be accessed
+ * @param path The path to write to.
+ * @param data The object to write.
* @deprecated Use
* {@link SingleTransactionDataBroker#syncWrite(
* DataBroker, LogicalDatastoreType, InstanceIdentifier, DataObject)}
+ * @param <T> DataObject subclass
*/
@Deprecated
public static <T extends DataObject> void syncWrite(DataBroker broker,
/**
* Deprecated update.
*
+ * @param broker the broker
+ * @param datastoreType the {@link Datastore} type that will be accessed
+ * @param path The path to write to.
+ * @param data The object to write.
* @deprecated Use
* {@link SingleTransactionDataBroker#syncUpdate(
* DataBroker, LogicalDatastoreType, InstanceIdentifier, DataObject)}
+ * @param <T> DataObject subclass
*/
@Deprecated
public static <T extends DataObject> void syncUpdate(DataBroker broker,
/**
* Deprecated delete.
*
+ * @param broker the broker
+ * @param datastoreType the {@link Datastore} type that will be accessed
+ * @param path The path to write to.
* @deprecated Use
* {@link SingleTransactionDataBroker#syncDelete(DataBroker, LogicalDatastoreType, InstanceIdentifier)}
+ * @param <T> DataObject subclass
*/
@Deprecated
public static <T extends DataObject> void syncDelete(DataBroker broker,
* For the tunnel id with VNI and valid-vni-flag set, the most significant byte
* should have 08. So, shifting 08 to 7 bytes (56 bits) and the result is OR-ed with
* VNI being shifted to 1 byte.
+ * @param vni virtual network id
+ * @return TunnelId
*/
public static Uint64 getTunnelIdWithValidVniBitAndVniSet(int vni) {
return Uint64.valueOf(8L << 56 | vni << 8);
/** Utility to fetch the register value for lport dispatcher table.
* Register6 used for service binding will have first 4 bits of service-index, next 20 bits for lportTag,
* and next 4 bits for interface-type
+ * @param lportTag lport tag of interface
+ * @param serviceIndex serviceIndex of interface
+ * @param interfaceType type of interface
+ * @return reg6 value of lport dispatcher
*/
public static long getReg6ValueForLPortDispatcher(int lportTag, short serviceIndex, short interfaceType) {
// FIXME: this can be done more efficiently
* Accepts a MAC address and returns the corresponding long, where the MAC
* bytes are set on the lower order bytes of the long.
*
+ * @param macAddress The MAC
* @return a long containing the mac address bytes
*/
public static long macByteToLong(byte[] macAddress) {
/**
* Returns the ids of the currently operative DPNs.
+ * @param dataBroker instance of databroker
+ * @return List of DPNs
+ * @throws ExecutionException in case of a technical (!) error while reading
+ * @throws InterruptedException if the transaction is interrupted
*/
public static List<Uint64> getOperativeDPNs(DataBroker dataBroker) throws ExecutionException, InterruptedException {
List<Uint64> result = new LinkedList<>();
/**
* Adds a flow.
*
+ * @param flowEntity The flow entity.
* @deprecated Use {@link #addFlow(TypedWriteTransaction, FlowEntity)}.
+ * @return
*/
@Deprecated
FluentFuture<Void> installFlow(FlowEntity flowEntity);
/**
* Adds a flow.
*
+ * @param dpId The DPN identifier.
+ * @param flowEntity The flow entity.
* @deprecated Use {@link #addFlow(TypedWriteTransaction, Uint64, Flow)}.
+ * @return
*/
@Deprecated
FluentFuture<Void> installFlow(Uint64 dpId, Flow flowEntity);
/**
* Adds a flow.
*
+ * @param dpId The DPN identifier.
+ * @param flowEntity The flow entity.
* @deprecated Use {@link #addFlow(TypedWriteTransaction, FlowEntity)}.
+ * @return
*/
@Deprecated
FluentFuture<Void> installFlow(Uint64 dpId, FlowEntity flowEntity);
/**
* Removes a flow.
*
+ * @param dpId The DPN identifier.
+ * @param tableId The table identifier.
+ * @param flowId The flow identifier.
* @deprecated Use {@link #removeFlow(TypedReadWriteTransaction, Uint64, String, short)}.
+ * @return
*/
@Deprecated
ListenableFuture<Void> removeFlow(Uint64 dpId, short tableId, FlowId flowId);
/**
* Removes a flow.
*
+ * @param flowEntity The flow entity.
* @deprecated Use {@link #removeFlow(TypedReadWriteTransaction, FlowEntity)}.
+ * @return
*/
@Deprecated
FluentFuture<Void> removeFlow(FlowEntity flowEntity);
* @param tx The transaction to use.
* @param dpId The DPN identifier.
* @param flow The flow.
+ * @throws ExecutionException in case of a technical (!) error while reading
+ * @throws InterruptedException in case of a technical (!) error while reading
*/
void removeFlow(TypedReadWriteTransaction<Configuration> tx, Uint64 dpId, Flow flow)
throws ExecutionException, InterruptedException;
*
* @param tx The transaction to use.
* @param flowEntity The flow entity.
+ * @throws ExecutionException in case of a technical (!) error while reading
+ * @throws InterruptedException in case of a technical (!) error while reading
*/
void removeFlow(TypedReadWriteTransaction<Configuration> tx, FlowEntity flowEntity)
throws ExecutionException, InterruptedException;
* @param dpId The DPN identifier.
* @param flowKey The flow key.
* @param tableId The table identifier.
+ * @throws ExecutionException in case of a technical (!) error while reading
+ * @throws InterruptedException in case of a technical (!) error while reading
*/
void removeFlow(TypedReadWriteTransaction<Configuration> tx, Uint64 dpId, FlowKey flowKey, short tableId)
throws ExecutionException, InterruptedException;
* @param dpId The DPN identifier.
* @param flowId The flow identifier.
* @param tableId The table identifier.
+ * @throws ExecutionException in case of a technical (!) error while reading
+ * @throws InterruptedException in case of a technical (!) error while reading
*/
void removeFlow(TypedReadWriteTransaction<Configuration> tx, Uint64 dpId, String flowId, short tableId)
throws ExecutionException, InterruptedException;
/**
* Remove a group.
*
+ * @param groupEntity The group to remove.
* @deprecated Use {@link #removeGroup(TypedReadWriteTransaction, GroupEntity)}
*/
@Deprecated
*
* @param tx The transaction to use.
* @param groupEntity The group to remove.
+ * @throws ExecutionException in case of a technical (!) error while reading
+ * @throws InterruptedException in case of a technical (!) error while reading
*/
void removeGroup(TypedReadWriteTransaction<Configuration> tx, GroupEntity groupEntity)
throws ExecutionException, InterruptedException;
* @param tx The transaction to use.
* @param dpId The DPN identifier.
* @param group The group to remove.
+ * @throws ExecutionException in case of a technical (!) error while reading
+ * @throws InterruptedException in case of a technical (!) error while reading
*/
void removeGroup(TypedReadWriteTransaction<Configuration> tx, Uint64 dpId, Group group)
throws ExecutionException, InterruptedException;
* @param tx The transaction to use.
* @param dpId The DPN identifier.
* @param groupId The group identifier of the group to remove.
+ * @throws ExecutionException in case of a technical (!) error while reading
+ * @throws InterruptedException in case of a technical (!) error while reading
*/
void removeGroup(TypedReadWriteTransaction<Configuration> tx, Uint64 dpId, long groupId)
throws ExecutionException, InterruptedException;
* API to remove the flow on Data Plane Node synchronously. It internally waits for
* Flow Change Notification to confirm flow delete request is being sent with-in delayTime.
*
+ * @param flowEntity The flow entity.
+ * @param delayTime The delay time.
* @deprecated Use {@link #removeFlow(TypedReadWriteTransaction, FlowEntity)}.
*/
@Deprecated
/**
* Removes a flow.
*
+ * @param flowEntity The flow entity.
* @deprecated Use {@link #removeFlow(TypedReadWriteTransaction, FlowEntity)}.
*/
@Deprecated
/**
* Install a flow.
*
+ * @param flowEntity The flow entity.
+ * @param delayTime The delay time.
* @deprecated Use {@link #addFlow(TypedWriteTransaction, FlowEntity)}.
*/
@Deprecated
/**
* Installs a flow.
*
+ * @param flowEntity The flow entity.
* @deprecated Use {@link #addFlow(TypedWriteTransaction, FlowEntity)}.
*/
@Deprecated
/**
* Installs a group.
*
+ * @param groupEntity The group to add.
* @deprecated Use {@link #addGroup(TypedWriteTransaction, GroupEntity)}.
*/
@Deprecated
/**
* API to remove the Group on Data Plane Node synchronously. It internally waits for
* Group Change Notification to confirm group delete request is being sent.
+ * @param groupEntity The group to add.
* @deprecated Use {@link #removeGroup(TypedReadWriteTransaction, GroupEntity)}.
*/
@Deprecated
/**
* Sets the ICMP sequence number for the current ICMP object instance.
+ * @param seqNumber sequence number
+ * @return sequence number
*/
public ICMP setSequenceNumber(short seqNumber) {
byte[] icmpSeqNumber = BitBufferHelper.toByteArray(seqNumber);
*
* @param resourceType resource type that was registered with batch manager
* @param identifier identifier to be read
+ * @param <T> DataObject subclass
* @return a CheckFuture containing the result of the read
*/
public <T extends DataObject> FluentFuture<Optional<T>> read(
*
* @param nodeId
* the node id
+ * @param logicalSwitchName the logical switch name
* @param mac
* the mac
* @return the instance identifier
*
* @param nodeId
* the node id
+ * @param logicalSwitchName the logical switch name
* @param mac
* the mac
* @return the instance identifier
* the desc
* @param tunnelKey
* the tunnel key
+ * @param replicationMode replication mode
* @return the logical switches
*/
public static LogicalSwitches createLogicalSwitch(String name, String desc, String tunnelKey,
*
* @param transaction
* the transaction
+ * @param logicalDatastoreType the LogicalDatastoreType
* @param nodeId
* the node id
* @param logicalSwitch
/**
* Gets the logical switch.
*
+ * @param broker the broker
+ * @param datastoreType the datastore type
* @param nodeId
* the node id
* @param logicalSwitchName
* the logical switch name
* @return the logical switch
* @deprecated Use {@link #getLogicalSwitch(TypedReadTransaction, NodeId, String)}.
+ * @throws ExecutionException in case of a technical (!) error while reading
+ * @throws InterruptedException if the transaction is interrupted.
*/
@Deprecated
public static LogicalSwitches getLogicalSwitch(DataBroker broker, LogicalDatastoreType datastoreType, NodeId nodeId,
* @param portName
* port name under physical switch node id
* @return the physical port termination point
+ * @throws ExecutionException in case of a technical (!) error while reading
+ * @throws InterruptedException if the transaction is interrupted.
*/
public static TerminationPoint getPhysicalPortTerminationPoint(DataBroker broker,
LogicalDatastoreType datastoreType, NodeId nodeId, String portName) throws ExecutionException,
* @param vni
* virtual network id
* @return the logical switches
+ * @throws ExecutionException in case of a technical (!) error while reading
+ * @throws InterruptedException if the transaction is interrupted.
*/
public static LogicalSwitches getLogicalSwitches(DataBroker broker, String hwVtepNodeId, String vni)
throws ExecutionException, InterruptedException {
* @param phyLocatorIp
* the phy locator ip
* @return the physical locator
+ * @throws ExecutionException in case of a technical (!) error while reading
+ * @throws InterruptedException if the transaction is interrupted.
*/
public static HwvtepPhysicalLocatorAugmentation getPhysicalLocator(DataBroker broker,
LogicalDatastoreType datastoreType, NodeId nodeId, final IpAddress phyLocatorIp) throws
* the broker
* @param nodeId
* the node id
+ * @param logicalSwitchName the logical switch name
* @param mac
* the mac
* @return the listenable future
* the transaction
* @param nodeId
* the node id
+ * @param logialSwitchName the logical switch name
* @param mac
* the mac
* @deprecated Use {@link #deleteRemoteUcastMac(TypedWriteTransaction, NodeId, String, MacAddress)}.
* the broker
* @param nodeId
* the node id
+ * @param logicalSwitchName the logical switch name
* @param lstMac
* the lst mac
* @return the listenable future
* the transaction
* @param nodeId
* the node id
+ * @param logicalSwitchName the logical switch name
* @param lstMac
* the lst mac
* @deprecated Use {@link #deleteRemoteUcastMacs(TypedWriteTransaction, NodeId, String, Iterable)}.
/**
* Adds a remote multicast MAC.
*
+ * @param transaction the transaction
+ * @param logicalDatastoreType the LogicalDatastoreType
+ * @param nodeId the node id
+ * @param remoteMcastMac the remote mcast mac
* @deprecated Use {@link #addRemoteMcastMac(TypedWriteTransaction, NodeId, RemoteMcastMacs)}.
*/
@Deprecated
* the remote mcast macs key
* @return the remote mcast mac
* @deprecated Use {@link #getRemoteMcastMac(TypedReadTransaction, NodeId, RemoteMcastMacsKey)}.
+ * @throws ExecutionException in case of a technical (!) error while reading
+ * @throws InterruptedException if the transaction is interrupted.
*/
@Deprecated
public static RemoteMcastMacs getRemoteMcastMac(DataBroker broker, LogicalDatastoreType datastoreType,
* the node id
* @return the hw vtep node
* @deprecated Use {@link #getHwVtepNode(TypedReadTransaction, NodeId)}.
+ * @throws ExecutionException in case of a technical (!) error while reading
+ * @throws InterruptedException if the transaction is interrupted.
*/
@Deprecated
public static Node getHwVtepNode(DataBroker dataBroker, LogicalDatastoreType datastoreType, NodeId nodeId)
* Installs a list of Mac Addresses as remote Ucast address in an external
* device using the hwvtep-southbound.
*
+ * @param broker the databroker
* @param deviceNodeId
* NodeId if the ExternalDevice where the macs must be installed
* in.
* VTEP's IP in this OVS used for the tunnel with external
* device.
* @deprecated Use {@link #addUcastMacs(TypedWriteTransaction, String, Iterable, String, IpAddress)}.
+ * @return future if present
*/
@Deprecated
public static FluentFuture<? extends @NonNull CommitInfo> installUcastMacs(DataBroker broker,
/**
* Retrieves the database version.
*
+ * @param broker the broker
+ * @param nodeId the node id
* @deprecated Use {@link #getDbVersion(TypedReadTransaction, NodeId)}.
+ * @return dbversion
+ * @throws ExecutionException in case of a technical (!) error while reading
+ * @throws InterruptedException if the transaction is interrupted.
*/
@Deprecated
public static String getDbVersion(DataBroker broker, NodeId nodeId) throws ExecutionException,
* Fails all future reads.
*
* @param exception a {@link ReadFailedException} to throw from a
- * {@link ReadOnlyTransaction#read(LogicalDatastoreType, InstanceIdentifier)} call.
+ * {@link ReadWriteTransaction#read(LogicalDatastoreType, InstanceIdentifier)} call.
*/
void failReads(ReadFailedException exception);
* @param howManyTimes how many times to throw the passed exception, until it resets.
*
* @param exception a {@link ReadFailedException} to throw from a
- * {@link ReadOnlyTransaction#read(LogicalDatastoreType, InstanceIdentifier)} call.
+ * {@link ReadWriteTransaction#read(LogicalDatastoreType, InstanceIdentifier)} call.
*/
void failReads(int howManyTimes, ReadFailedException exception);
* Fails all future Transaction submits.
*
* @param exception
- * an Exception to throw from a {@link WriteTransaction#submit()}
- * (also {@link ReadWriteTransaction#submit()}) method
+ * an Exception to throw from a {@link WriteTransaction#commit()}
+ * (also {@link ReadWriteTransaction#commit()} ) method
*/
void failSubmits(TransactionCommitFailedException exception);
* how many times to throw the passed exception, until it resets
*
* @param exception
- * an Exception to throw from a {@link WriteTransaction#submit()}
- * (also {@link ReadWriteTransaction#submit()}) method
+ * an Exception to throw from a {@link WriteTransaction#commit()}
+ * (also {@link ReadWriteTransaction#commit()} method
*/
void failSubmits(int howManyTimes, TransactionCommitFailedException exception);
Code Review / genius.git / commitdiff