* Callback that can be registered with {@link OvsdbClient} to
* get notified of a lock stolen.
* @see <a href="http://tools.ietf.org/html/draft-pfaff-ovsdb-proto-04#section-4.1.10">ovsdb spec</a>
- * <p/>
- *
* @see OvsdbClient
*/
public interface LockAquisitionCallback {
* Callback that can be registered with {@link org.opendaylight.ovsdb.lib.OvsdbClient} to
* get notified of a lock stolen.
* @see <a href="http://tools.ietf.org/html/draft-pfaff-ovsdb-proto-04#section-4.1.10">ovsdb spec</a>
- * <p/>
+ * <p>
*
* @see org.opendaylight.ovsdb.lib.OvsdbClient#lock(String, LockAquisitionCallback, LockStolenCallback)
*/
public interface OvsdbConnectionListener {
/**
* Event thrown to the connection listener when a new Passive connection is established.
- * @param OvsdbClient that represents the connection.
+ * @param client OvsdbClient that represents the connection.
*/
public void connected(OvsdbClient client);
/**
* Event thrown to the connection listener when an existing connection is terminated.
- * @param OvsdbClient that represents the connection.
+ * @param client OvsdbClient that represents the connection.
*/
public void disconnected(OvsdbClient client);
}
/**
* This class represents a version according to RFC 7047
* The default implementation assumes the left-most digit is most significant when performing comparisons
- * @see <a href-="http://tools.ietf.org/html/rfc7047#section-3.1">RFC7047 Section 3.1</a>
+ * @see <a href="http://tools.ietf.org/html/rfc7047#section-3.1">RFC7047 Section 3.1</a>
*/
public class Version implements Comparable<Version> {
* provide a type-safe infrastructure for the applications to built on top of.
* And this Typed infra is completely optional.
*
- * It is the applications responsibility to pass on the raw Row parameter & this method will
+ * It is the applications responsibility to pass on the raw Row parameter and this method will
* return the appropriate Proxy wrapper for the passed klazz Type.
* The raw Row parameter may be null if the caller is interested in just the ColumnSchema.
* But that is not a very common use-case.
* to provide a type-safe infrastructure for the applications to built on top of.
* And this Typed infra is completely optional.
*
- * It is the applications responsibility to pass on the raw Row parameter & this method
+ * It is the applications responsibility to pass on the raw Row parameter and this method
* will return the appropriate Proxy wrapper for the passed klazz Type.
* The raw Row parameter may be null if the caller is interested in just the
* ColumnSchema. But that is not a very common use-case.
}
/**
- * This method extracts all row updates of Class<T> klazz from a TableUpdates
+ * This method extracts all row updates of Class<T> klazz from a TableUpdates
* that correspond to insertion or updates of rows of type klazz.
* Example:
* <code>
- * Map<UUID,Bridge> updatedBridges = extractRowsUpdated(Bridge.class,updates,dbSchema)
+ * Map<UUID,Bridge> updatedBridges = extractRowsUpdated(Bridge.class,updates,dbSchema)
* </code>
*
* @param klazz Class for row type to be extracted
* @param updates TableUpdates from which to extract rowUpdates
* @param dbSchema Dbschema for the TableUpdates
- * @return Map<UUID,T> for the type of things being sought
+ * @return Map<UUID,T> for the type of things being sought
*/
public static <T> Map<UUID,T> extractRowsUpdated(Class<T> klazz,TableUpdates updates,DatabaseSchema dbSchema) {
Preconditions.checkNotNull(klazz);
}
/**
- * This method extracts all row updates of Class<T> klazz from a TableUpdates
+ * This method extracts all row updates of Class<T> klazz from a TableUpdates
* that correspond to old version of rows of type klazz that have been updated
* Example:
* <code>
- * Map<UUID,Bridge> oldBridges = extractRowsOld(Bridge.class,updates,dbSchema)
+ * Map<UUID,Bridge> oldBridges = extractRowsOld(Bridge.class,updates,dbSchema)
* </code>
*
* @param klazz Class for row type to be extracted
* @param updates TableUpdates from which to extract rowUpdates
* @param dbSchema Dbschema for the TableUpdates
- * @return Map<UUID,T> for the type of things being sought
+ * @return Map<UUID,T> for the type of things being sought
*/
public static <T> Map<UUID,T> extractRowsOld(Class<T> klazz,TableUpdates updates,DatabaseSchema dbSchema) {
Preconditions.checkNotNull(klazz);
}
/**
- * This method extracts all row updates of Class<T> klazz from a TableUpdates
+ * This method extracts all row updates of Class<T> klazz from a TableUpdates
* that correspond to removal of rows of type klazz.
* Example:
* <code>
- * Map<UUID,Bridge> updatedBridges = extractRowsRemoved(Bridge.class,updates,dbSchema)
+ * Map<UUID,Bridge> updatedBridges = extractRowsRemoved(Bridge.class,updates,dbSchema)
* </code>
*
* @param klazz Class for row type to be extracted
* @param updates TableUpdates from which to extract rowUpdates
* @param dbSchema Dbschema for the TableUpdates
- * @return Map<UUID,T> for the type of things being sought
+ * @return Map<UUID,T> for the type of things being sought
*/
public static <T> Map<UUID,T> extractRowsRemoved(Class<T> klazz,TableUpdates updates,DatabaseSchema dbSchema) {
Preconditions.checkNotNull(klazz);
}
/**
- * This method extracts all RowUpdates of Class<T> klazz from a TableUpdates
+ * This method extracts all RowUpdates of Class<T> klazz from a TableUpdates
* that correspond to rows of type klazz.
* Example:
* <code>
- * Map<UUID,TableUpdate<GenericTableSchema>.RowUpdate<GenericTableSchema>> updatedBridges =
+ * Map<UUID,TableUpdate<GenericTableSchema>.RowUpdate<GenericTableSchema>> updatedBridges =
* extractRowsUpdates(Bridge.class,updates,dbSchema)
* </code>
*
* @param klazz Class for row type to be extracted
* @param updates TableUpdates from which to extract rowUpdates
* @param dbSchema Dbschema for the TableUpdates
- * @return Map<UUID,TableUpdate<GenericTableSchema>.RowUpdate<GenericTableSchema>>
+ * @return Map<UUID,TableUpdate<GenericTableSchema>.RowUpdate<GenericTableSchema>>
* for the type of things being sought
*/
public static Map<UUID,TableUpdate<GenericTableSchema>.RowUpdate<GenericTableSchema>>
* @param nodeType type of node e.g OVS
* @param nodeId ID of the node
* @param tableName name of the OVSDB table
- * @param row the {@link OvsdbRow} Row that is being inserted
+ * @param rowJson the {@link OvsdbRow} Row that is being inserted
*
* @return Response as dictated by the HTTP Response Status code
*
/**
* Enqueue the event.
*
- * @param event the {@link org.opendaylight.ovsdb.openstack.netvirt.AbstractEvent} event to be handled.
+ * @param abstractEvent the {@link org.opendaylight.ovsdb.openstack.netvirt.AbstractEvent} event to be handled.
* @see org.opendaylight.ovsdb.openstack.netvirt.api.EventDispatcher
*/
protected void enqueueEvent(AbstractEvent abstractEvent) {
/**
* Process the event.
*
- * @param event the {@link org.opendaylight.ovsdb.openstack.netvirt.AbstractEvent} event to be handled.
+ * @param abstractEvent the {@link org.opendaylight.ovsdb.openstack.netvirt.AbstractEvent} event to be handled.
* @see org.opendaylight.ovsdb.openstack.netvirt.api.EventDispatcher
*/
public abstract void processEvent(AbstractEvent abstractEvent);
* Process the event.
*
* @param abstractEvent the {@link org.opendaylight.ovsdb.openstack.netvirt.AbstractEvent} event to be handled.
- * @see EventDispatcher
+ * @see org.opendaylight.ovsdb.openstack.netvirt.api.EventDispatcher
*/
@Override
public void processEvent(AbstractEvent abstractEvent) {
/**
* Look up in the NeutronNetworkCRUD cache and NeutronSubnetCRUD cache for
* extracting the provider segmentation_type and segmentation_id
- * @param subnetId Subnet UUID
+ * @param subnetID Subnet UUID
* @return {Type: ID} pair for that subnet ID
*/
public static Map.Entry<String,String> getProviderInformation(INeutronNetworkCRUD neutronNetworkCache,
/**
* Invoked to take action after a port has been created.
*
- * @param port An instance of new Neutron Port object.
+ * @param neutronPort An instance of new Neutron Port object.
*/
@Override
public void neutronPortCreated(NeutronPort neutronPort) {
/**
* Invoked to take action after a port has been updated.
*
- * @param port An instance of modified Neutron Port object.
+ * @param neutronPort An instance of modified Neutron Port object.
*/
@Override
public void neutronPortUpdated(NeutronPort neutronPort) {
* Process the event.
*
* @param abstractEvent the {@link org.opendaylight.ovsdb.openstack.netvirt.AbstractEvent} event to be handled.
- * @see EventDispatcher
+ * @see org.opendaylight.ovsdb.openstack.netvirt.api.EventDispatcher
*/
@Override
public void processEvent(AbstractEvent abstractEvent) {
* Process the event.
*
* @param abstractEvent the {@link org.opendaylight.ovsdb.openstack.netvirt.AbstractEvent} event to be handled.
- * @see EventDispatcher
+ * @see org.opendaylight.ovsdb.openstack.netvirt.api.EventDispatcher
*/
@Override
public void processEvent(AbstractEvent abstractEvent) {
* OpenStack Neutron with the Open vSwitch plugin relies on a typical bridge configuration that
* consists of br-int (Integration Bridge), br-net (Network bridge), br-ex (External bridge).
*
- * This class ensures that the bridges on each {@link org.opendaylight.controller.sal.core.Node}
+ * This class ensures that the bridges on each {@link Node}
* are correctly configured for OpenStack Neutron
*
*/
/**
* A helper function to get the UUID of a given Bridge
- * @param node the {@link org.opendaylight.controller.sal.core.Node} where the bridge is configured
+ * @param node the {@link Node} where the bridge is configured
* @param bridgeName the name of the bridge
* @return the UUID of the bridge
*/
/**
* Checks for the existence of the Integration Bridge on a given Node
- * @param node the {@link org.opendaylight.controller.sal.core.Node} where the bridge should be configured
+ * @param node the {@link Node} where the bridge should be configured
* @return True if the bridge exists, False if it does not
*/
public boolean isNodeNeutronReady(Node node);
/**
* Checks for the existence of the Network Bridge on a given Node
- * @param node the {@link org.opendaylight.controller.sal.core.Node} where the bridge should be configured
+ * @param node the {@link Node} where the bridge should be configured
* @return True if the bridge exists, False if it does not
*/
public boolean isNodeOverlayReady(Node node);
/**
* Checks for the existence of the Network Bridge on a given Node
- * @param node the {@link org.opendaylight.controller.sal.core.Node} where the bridge should be configured
+ * @param node the {@link Node} where the bridge should be configured
* @return True if the bridge exists, False if it does not
*/
* Checks that a Node is ready for a Tunnel Network Provider
* For OpenFlow 1.0 the Integration, Network Bridge and corresponding patch ports are required
* For OpenFlow 1.3 only the Integration Bridge is required
- * @param node the {@link org.opendaylight.controller.sal.core.Node} where the bridge is configured
+ * @param node the {@link Node} where the bridge is configured
* @return True or False
*/
public boolean isNodeTunnelReady(Node node);
* For OpenFlow 1.0 the Integration Bridge, Network Bridge, patch ports and a physical device connected to the
* Network Bridge are required.
* For OpenFlow 1.3 the Integration Bridge is required and must have a physical device connected.
- * @param node the {@link org.opendaylight.controller.sal.core.Node} where the bridge is configured
+ * @param node the {@link Node} where the bridge is configured
* @param network the {@link org.opendaylight.neutron.spi.NeutronNetwork}
* @return True or False
*/
/**
* A helper function to determine if a port exists on a given bridge
- * @param node the {@link org.opendaylight.controller.sal.core.Node} where the bridge is configured
+ * @param node the {@link Node} where the bridge is configured
* @param bridge the {@link org.opendaylight.ovsdb.schema.openvswitch.Bridge} to query
* @param portName the name of the port to search for
* @return True if the port exists, otherwise False
/**
* Returns true if the bridges required for the provider network type are created
* If the bridges are not created, this method will attempt to create them
- * @param node the {@link org.opendaylight.controller.sal.core.Node} to query
+ * @param node the {@link Node} to query
* @param network the {@link org.opendaylight.neutron.spi.NeutronNetwork}
* @return True or False
*/
/**
* Prepares the given Node for Neutron Networking by creating the Integration Bridge
- * @param node the {@link org.opendaylight.controller.sal.core.Node} to prepare
+ * @param node the {@link Node} to prepare
*/
public void prepareNode(Node node);
/** Returns all physical interfaces configured in the bridge mapping
* Bridge mappings will be of the following format:
- * @param node the {@link org.opendaylight.controller.sal.core.Node} to query
+ * @param node the {@link Node} to query
* @return a List in the format {eth1, eth2} given bridge_mappings=physnet1:eth1,physnet2:eth2
*/
public List<String> getAllPhysicalInterfaceNames(Node node);
-}
\ No newline at end of file
+}
/**
* Gets the tunnel endpoint address for a given Node
- * @param node a {@link org.opendaylight.controller.sal.core.Node}
+ * @param node a {@link Node}
* @return the tunnel endpoint
* @see java.net.InetAddress
*/
* @return the MacAddress to use for the default gateway; or null if none is configured.
*/
public String getDefaultGatewayMacAddress(Node node);
-}
\ No newline at end of file
+}
import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.Node;
/**
- * The NetworkingProviderManager handles the mapping between {@link org.opendaylight.controller.sal.core.Node}
+ * The NetworkingProviderManager handles the mapping between {@link Node}
* and registered {@link org.opendaylight.ovsdb.openstack.netvirt.api.NetworkingProvider} implementations
*/
public interface NetworkingProviderManager {
/**
* Returns the Networking Provider for a given node
- * @param node a {@link org.opendaylight.controller.sal.core.Node}
+ * @param node a {@link Node}
* @return a NetworkProvider
* @see NetworkingProvider
*/
/**
* Get the VLAN assigned to the provided Network
- * @param node the {@link org.opendaylight.controller.sal.core.Node} to query
+ * @param node the {@link Node} to query
* @param networkId the Neutron Network ID
* @return the assigned VLAN ID or 0 in case of an error
*/
/**
* Reclaim the assigned VLAN for the given Network
- * @param node the {@link org.opendaylight.controller.sal.core.Node} to query
+ * @param node the {@link Node} to query
* @param portUUID the UUID of the neutron Port
* @param network the Neutron Network ID
*/
/**
* Configures the VLAN for a Tenant Network
- * @param node the {@link org.opendaylight.controller.sal.core.Node} to configure
+ * @param node the {@link Node} to configure
* @param portUUID the UUID of the port to configure
* @param network the Neutron Network ID
*/
/**
* Check is the given network is present on a Node
- * @param node the {@link org.opendaylight.controller.sal.core.Node} to query
+ * @param node the {@link Node} to query
* @param segmentationId the Neutron Segementation ID
* @return True or False
*/
* Network Deleted Callback
*/
public void networkDeleted(String id);
-}
\ No newline at end of file
+}
/**
* Assigns a free VLAN ID for the given tenant network
- * @param node an Open vSwitch {@link org.opendaylight.controller.sal.core.Node}
+ * @param node an Open vSwitch {@link Node}
* @param networkId the Neutron Network ID
* @return a VLAN ID or 0 in case of an error
*/
/**
* Recovers an assigned VLAN ID when it is no longer required
- * @param node an Open vSwitch {@link org.opendaylight.controller.sal.core.Node}
+ * @param node an Open vSwitch {@link Node}
* @param networkId the Neutron Network ID
* @return the reclaimed VLAN ID or 0 in case of an error
*/
/**
* Returns a VLAN ID assigned to a given tenant network
- * @param node an Open vSwitch {@link org.opendaylight.controller.sal.core.Node}
+ * @param node an Open vSwitch {@link Node}
* @param networkId the Neutron Network ID
* @return the VLAN ID or 0 in case of an error
*/
public interface OvsdbConfigurationService {
/**
- * @deprecated This version of insertRow is a short-term replacement for the older & now deprecated method of the same name.
+ * @deprecated This version of insertRow is a short-term replacement for the older and now deprecated method of the same name.
* This API assumes an Open_vSwitch database Schema.
*
* This API is replaced by
- * {@link #insertRow(Node, String, String, String, Row<GenericTableSchema>) insertRow} and
- * {@link #insertTree(Node, String, String, String, Row<GenericTableSchema>) insertTree}
+ * {@link #insertRow(Node, String, String, UUID, Row) insertRow} and
+ * {@link #insertTree(Node, String, String, UUID, Row) insertTree}
*
* @param node OVSDB Node
* @param tableName Table on which the row is inserted
/**
* insert a Row in a Table of a specified Database Schema. This is a convenience method on top of
- * {@link insertRow(Node, String, String, String, UUID, String, Row<GenericTableSchema>) insertRow}
+ * {@link #insertRow(Node, String, String, String, UUID, String, Row) insertRow}
* which assumes that OVSDB schema implementation that corresponds to the databaseName will provide
* the necessary service to populate the Parent Table Name and Parent Column Name.
*
* This method can insert just a single Row specified in the row parameter.
- * But {@link #insertTree(Node, String, String, UUID, Row<GenericTableSchema>) insertTree}
+ * But {@link #insertTree(Node, String, String, UUID, Row) insertTree}
* can insert a hierarchy of rows with parent-child relationship.
*
* @param node OVSDB Node
* @param databaseName Database Name that represents the Schema supported by the node.
* @param tableName Table on which the row is inserted
- * @param parentUuid UUID of the parent table to which this operation will result in attaching/mutating.
+ * @param parentRowUuid UUID of the parent table to which this operation will result in attaching/mutating.
* @param row Row of table Content to be inserted
* @throws OvsdbPluginException Any failure during the insert transaction will result in a specific exception.
* @return UUID of the inserted Row
* insert a Row in a Table of a specified Database Schema.
*
* This method can insert just a single Row specified in the row parameter.
- * But {@link #insertTree(Node, String, String, UUID, Row<GenericTableSchema>) insertTree}
+ * But {@link #insertTree(Node, String, String, UUID, Row) insertTree}
* can insert a hierarchy of rows with parent-child relationship.
*
* @param node OVSDB Node
* @param databaseName Database Name that represents the Schema supported by the node.
* @param tableName Table on which the row is inserted
* @param parentTable Name of the Parent Table to which this operation will result in attaching/mutating.
- * @param parentUuid UUID of a Row in parent table to which this operation will result in attaching/mutating.
+ * @param parentRowUuid UUID of a Row in parent table to which this operation will result in attaching/mutating.
* @param parentColumn Name of the Column in the Parent Table to be mutated with the UUID that results from the insert operation.
* @param row Row of table Content to be inserted
* @throws OvsdbPluginException Any failure during the insert transaction will result in a specific exception.
/**
* inserts a Tree of Rows in multiple Tables that has parent-child relationships referenced through the OVSDB schema's refTable construct.
- * This is a convenience method on top of {@link #insertTree(Node, String, String, String, UUID, String, Row<GenericTableSchema>) insertTree}
+ * This is a convenience method on top of {@link #insertTree(Node, String, String, String, UUID, String, Row) insertTree}
*
* @param node OVSDB Node
* @param databaseName Database Name that represents the Schema supported by the node.
* @param tableName Table on which the row is inserted
- * @param parentUuid UUID of a Row in parent table to which this operation will result in attaching/mutating.
+ * @param parentRowUuid UUID of a Row in parent table to which this operation will result in attaching/mutating.
* @param row Row Tree with parent-child relationships via column of type refTable.
* @throws OvsdbPluginException Any failure during the insert transaction will result in a specific exception.
* @return Returns the row tree with the UUID of every inserted Row populated in the _uuid column of every row in the tree
* @param databaseName Database Name that represents the Schema supported by the node.
* @param tableName Table on which the row is inserted
* @param parentTable Name of the Parent Table to which this operation will result in attaching/mutating.
- * @param parentUuid UUID of a Row in parent table to which this operation will result in attaching/mutating.
+ * @param parentRowUuid UUID of a Row in parent table to which this operation will result in attaching/mutating.
* @param parentColumn Name of the Column in the Parent Table to be mutated with the UUID that results from the insert operation.
* @param row Row Tree with parent-child relationships via column of type refTable.
* @throws OvsdbPluginException Any failure during the insert transaction will result in a specific exception.
String parentColumn, Row<GenericTableSchema> row) throws OvsdbPluginException;
/**
- * @deprecated This version of updateRow is a short-term replacement for the older & now deprecated method of the same name.
+ * @deprecated This version of updateRow is a short-term replacement for the older and now deprecated method of the same name.
* This API assumes an Open_vSwitch database Schema.
*
* This API is replaced by
- * {@link #updateRow(Node, String, String, UUID, Row<GenericTableSchema>, boolean) updateRow}
+ * {@link #updateRow(Node, String, String, UUID, Row, boolean) updateRow}
*
* @param node OVSDB Node
* @param tableName Table on which the row is Updated
Row<GenericTableSchema> row, boolean overwrite) throws OvsdbPluginException;
/**
- * @deprecated This version of deleteRow is a short-term replacement for the older & now deprecated method of the same name.
+ * @deprecated This version of deleteRow is a short-term replacement for the older and now deprecated method of the same name.
* This API assumes an Open_vSwitch database Schema.
*
* This API is replaced by {@link #deleteRow(Node, String, String, UUID) deleteRow}
UUID parentRowUuid, String parentColumn, UUID rowUuid) throws OvsdbPluginException;
/**
- * @deprecated This version of getRow is a short-term replacement for the older & now deprecated method of the same name.
+ * @deprecated This version of getRow is a short-term replacement for the older and now deprecated method of the same name.
* This API assumes an Open_vSwitch database Schema.
*
* This API is replaced by {@link #getRow(Node, String, String, UUID) getRow}
*
* @param node OVSDB Node
* @param tableName Table Name
- * @param rowUuid UUID of the row being queried
+ * @param uuid UUID of the row being queried
* @return a row with a list of Column data that corresponds to an unique Row-identifier called uuid in a given table.
*/
@Deprecated
public Row<GenericTableSchema> getRow(Node node, String databaseName, String tableName, UUID uuid) throws OvsdbPluginException;
/**
- * @Deprecated This version of getRows is a short-term replacement for the older & now deprecated method of the same name.
+ * @deprecated This version of getRows is a short-term replacement for the older and now deprecated method of the same name.
* This API assumes an Open_vSwitch database Schema.
*
* This API is replaced by
* @param node OVSDB Node
* @param databaseName Database Name that represents the Schema supported by the node.
* @param tableName Table Name
- * @param fiqlQuery FIQL style String Query {@link http://tools.ietf.org/html/draft-nottingham-atompub-fiql-00} to filter rows
+ * @param fiqlQuery FIQL style String Query <a href="http://tools.ietf.org/html/draft-nottingham-atompub-fiql-00">draft-nottingham-atompub-fiql</a> to filter rows
* @throws OvsdbPluginException Any failure during the get operation will result in a specific exception.
* @return Map of rows to its UUID that makes the entire Table.
*/
public ConcurrentMap<UUID, Row<GenericTableSchema>> getRows(Node node, String databaseName, String tableName, String fiqlQuery) throws OvsdbPluginException;
/**
- * @Deprecated Returns all the Tables in a given Ndoe.
+ * @deprecated Returns all the Tables in a given Ndoe.
* This API assumes an Open_vSwitch database Schema.
*
* This API is replaced by
public interface OvsdbConfigurationService {
/**
- * @deprecated This version of insertRow is a short-term replacement for the older & now deprecated method of the same name.
+ * @deprecated This version of insertRow is a short-term replacement for the older and now deprecated method of the same name.
* This API assumes an Open_vSwitch database Schema.
*
* This API is replaced by
- * {@link #insertRow(Node, String, String, String, Row<GenericTableSchema>) insertRow} and
- * {@link #insertTree(Node, String, String, String, Row<GenericTableSchema>) insertTree}
+ * {@link #insertRow(Node, String, String, Row)} and
+ * {@link #insertTree(Node, String, String, UUID, Row)}
*
* @param node OVSDB Node
* @param tableName Table on which the row is inserted
/**
* insert a Row in a Table of a specified Database Schema. This is a convenience method on top of
- * {@link insertRow(Node, String, String, String, UUID, String, Row<GenericTableSchema>) insertRow}
+ * {@link insertRow(Node, String, String, String, UUID, String, Row) insertRow}
* which assumes that OVSDB schema implementation that corresponds to the databaseName will provide
* the necessary service to populate the Parent Table Name and Parent Column Name.
*
* This method can insert just a single Row specified in the row parameter.
- * But {@link #insertTree(Node, String, String, UUID, Row<GenericTableSchema>) insertTree}
+ * But {@link #insertTree(Node, String, String, UUID, Row) insertTree}
* can insert a hierarchy of rows with parent-child relationship.
*
* @param node OVSDB Node
* @param databaseName Database Name that represents the Schema supported by the node.
* @param tableName Table on which the row is inserted
- * @param parentUuid UUID of the parent table to which this operation will result in attaching/mutating.
+ * @param parentRowUuid UUID of the parent table to which this operation will result in attaching/mutating.
* @param row Row of table Content to be inserted
* @throws OvsdbPluginException Any failure during the insert transaction will result in a specific exception.
* @return UUID of the inserted Row
* insert a Row in a Table of a specified Database Schema.
*
* This method can insert just a single Row specified in the row parameter.
- * But {@link #insertTree(Node, String, String, UUID, Row<GenericTableSchema>) insertTree}
+ * But {@link #insertTree(Node, String, String, UUID, Row)}
* can insert a hierarchy of rows with parent-child relationship.
*
* @param node OVSDB Node
* @param databaseName Database Name that represents the Schema supported by the node.
* @param tableName Table on which the row is inserted
* @param parentTable Name of the Parent Table to which this operation will result in attaching/mutating.
- * @param parentUuid UUID of a Row in parent table to which this operation will result in attaching/mutating.
+ * @param parentRowUuid UUID of a Row in parent table to which this operation will result in attaching/mutating.
* @param parentColumn Name of the Column in the Parent Table to be mutated with the UUID that results from the insert operation.
* @param row Row of table Content to be inserted
* @throws OvsdbPluginException Any failure during the insert transaction will result in a specific exception.
/**
* inserts a Tree of Rows in multiple Tables that has parent-child relationships referenced through the OVSDB schema's refTable construct.
- * This is a convenience method on top of {@link #insertTree(Node, String, String, String, UUID, String, Row<GenericTableSchema>) insertTree}
+ * This is a convenience method on top of {@link #insertTree(Node, String, String, String, UUID, String, Row)}
*
* @param node OVSDB Node
* @param databaseName Database Name that represents the Schema supported by the node.
* @param tableName Table on which the row is inserted
- * @param parentUuid UUID of a Row in parent table to which this operation will result in attaching/mutating.
+ * @param parentRowUuid UUID of a Row in parent table to which this operation will result in attaching/mutating.
* @param row Row Tree with parent-child relationships via column of type refTable.
* @throws OvsdbPluginException Any failure during the insert transaction will result in a specific exception.
* @return Returns the row tree with the UUID of every inserted Row populated in the _uuid column of every row in the tree
* @param databaseName Database Name that represents the Schema supported by the node.
* @param tableName Table on which the row is inserted
* @param parentTable Name of the Parent Table to which this operation will result in attaching/mutating.
- * @param parentUuid UUID of a Row in parent table to which this operation will result in attaching/mutating.
+ * @param parentRowUuid UUID of a Row in parent table to which this operation will result in attaching/mutating.
* @param parentColumn Name of the Column in the Parent Table to be mutated with the UUID that results from the insert operation.
* @param row Row Tree with parent-child relationships via column of type refTable.
* @throws OvsdbPluginException Any failure during the insert transaction will result in a specific exception.
String parentColumn, Row<GenericTableSchema> row) throws OvsdbPluginException;
/**
- * @deprecated This version of updateRow is a short-term replacement for the older & now deprecated method of the same name.
+ * @deprecated This version of updateRow is a short-term replacement for the older and now deprecated method of the same name.
* This API assumes an Open_vSwitch database Schema.
*
* This API is replaced by
- * {@link #updateRow(Node, String, String, UUID, Row<GenericTableSchema>, boolean) updateRow}
+ * {@link #updateRow(Node, String, String, UUID, Row, boolean) updateRow}
*
* @param node OVSDB Node
* @param tableName Table on which the row is Updated
- * @param parentUuid UUID of the parent row on which this operation might result in mutating.
+ * @param rowUuid UUID of the parent row on which this operation might result in mutating.
* @param rowUuid UUID of the row that is being updated
* @param row Row of table Content to be Updated. Include just those columns that needs to be updated.
*/
Row<GenericTableSchema> row, boolean overwrite) throws OvsdbPluginException;
/**
- * @deprecated This version of deleteRow is a short-term replacement for the older & now deprecated method of the same name.
+ * @deprecated This version of deleteRow is a short-term replacement for the older and now deprecated method of the same name.
* This API assumes an Open_vSwitch database Schema.
*
- * This API is replaced by {@link #deleteRow(Node, String, String, UUID) deleteRow}
+ * This API is replaced by {@link #deleteRow(Node, String, String, UUID)}
*
* @param node OVSDB Node
* @param tableName Table on which the row is Updated
UUID parentRowUuid, String parentColumn, UUID rowUuid) throws OvsdbPluginException;
/**
- * @deprecated This version of getRow is a short-term replacement for the older & now deprecated method of the same name.
+ * @deprecated This version of getRow is a short-term replacement for the older and now deprecated method of the same name.
* This API assumes an Open_vSwitch database Schema.
*
* This API is replaced by {@link #getRow(Node, String, String, UUID) getRow}
*
* @param node OVSDB Node
* @param tableName Table Name
- * @param rowUuid UUID of the row being queried
+ * @param uuid UUID of the row being queried
* @return a row with a list of Column data that corresponds to an unique Row-identifier called uuid in a given table.
*/
@Deprecated
public Row<GenericTableSchema> getRow(Node node, String databaseName, String tableName, UUID uuid) throws OvsdbPluginException;
/**
- * @Deprecated This version of getRows is a short-term replacement for the older & now deprecated method of the same name.
+ * @deprecated This version of getRows is a short-term replacement for the older and now deprecated method of the same name.
* This API assumes an Open_vSwitch database Schema.
*
* This API is replaced by
* @param node OVSDB Node
* @param databaseName Database Name that represents the Schema supported by the node.
* @param tableName Table Name
- * @param fiqlQuery FIQL style String Query {@link http://tools.ietf.org/html/draft-nottingham-atompub-fiql-00} to filter rows
+ * @param fiqlQuery FIQL style String Query <a href="http://tools.ietf.org/html/draft-nottingham-atompub-fiql-00">draft-nottingham-atompub-fiql</a> to filter rows
* @throws OvsdbPluginException Any failure during the get operation will result in a specific exception.
* @return Map of rows to its UUID that makes the entire Table.
*/
public ConcurrentMap<UUID, Row<GenericTableSchema>> getRows(Node node, String databaseName, String tableName, String fiqlQuery) throws OvsdbPluginException;
/**
- * @Deprecated Returns all the Tables in a given Ndoe.
+ * @deprecated Returns all the Tables in a given Ndoe.
* This API assumes an Open_vSwitch database Schema.
*
* This API is replaced by
* insert a Row in a Table of a specified Database Schema.
*
* This method can insert just a single Row specified in the row parameter.
- * But {@link #insertTree(Node, String, String, UUID, Row<GenericTableSchema>) insertTree}
+ * But {@link #insertTree(Node, String, String, UUID, Row) insertTree}
* can insert a hierarchy of rows with parent-child relationship.
*
* @param node OVSDB Node
/**
* insert a Row in a Table of a specified Database Schema. This is a convenience method on top of
- * {@link insertRow(Node, String, String, String, UUID, String, Row<GenericTableSchema>) insertRow}
+ * {@link insertRow(Node, String, String, String, UUID, String, Row) insertRow}
* which assumes that OVSDB schema implementation that corresponds to the databaseName will provide
* the necessary service to populate the Parent Table Name and Parent Column Name.
*
* This method can insert just a single Row specified in the row parameter.
- * But {@link #insertTree(Node, String, String, UUID, Row<GenericTableSchema>) insertTree}
+ * But {@link #insertTree(Node, String, String, UUID, Row) insertTree}
* can insert a hierarchy of rows with parent-child relationship.
*
* @param node OVSDB Node
* @param databaseName Database Name that represents the Schema supported by the node.
* @param tableName Table on which the row is inserted
- * @param parentUuid UUID of the parent table to which this operation will result in attaching/mutating.
+ * @param parentRowUuid UUID of the parent table to which this operation will result in attaching/mutating.
* @param row Row of table Content to be inserted
* @throws OvsdbPluginException Any failure during the insert transaction will result in a specific exception.
* @return UUID of the inserted Row
/**
* inserts a Tree of Rows in multiple Tables that has parent-child relationships referenced through the OVSDB schema's refTable construct.
- * This is a convenience method on top of {@link #insertTree(Node, String, String, String, UUID, String, Row<GenericTableSchema>) insertTree}
+ * This is a convenience method on top of {@link #insertTree(Node, String, String, String, UUID, String, Row) insertTree}
*
* @param node OVSDB Node
* @param databaseName Database Name that represents the Schema supported by the node.
* @param tableName Table on which the row is inserted
- * @param parentUuid UUID of a Row in parent table to which this operation will result in attaching/mutating.
+ * @param parentRowUuid UUID of a Row in parent table to which this operation will result in attaching/mutating.
* @param row Row Tree with parent-child relationships via column of type refTable.
* @throws OvsdbPluginException Any failure during the insert transaction will result in a specific exception.
* @return Returns the row tree with the UUID of every inserted Row populated in the _uuid column of every row in the tree
* As per RFC 7047, section 4.1.5, if a Monitor request is sent without any columns, the update response will not include
* the _uuid column.
* ----------------------------------------------------------------------------------------------------------------------------------
- * Each <monitor-request> specifies one or more columns and the manner in which the columns (or the entire table) are to be monitored.
+ * Each <monitor-request> specifies one or more columns and the manner in which the columns (or the entire table) are to be monitored.
* The "columns" member specifies the columns whose values are monitored. It MUST NOT contain duplicates.
* If "columns" is omitted, all columns in the table, except for "_uuid", are monitored.
* ----------------------------------------------------------------------------------------------------------------------------------
}
/**
- * Create Set Vlan ID Instruction - This includes push vlan action, and set field -> vlan vid action
+ * Create Set Vlan ID Instruction - This includes push vlan action, and set field -> vlan vid action
*
* @param ib Map InstructionBuilder without any instructions
* @param vlanId Integer representing a VLAN ID Integer representing a VLAN ID
/**
* Create Source TCP Port Match
*
- * @param matchBuilder @param matchbuilder MatchBuilder Object without a match yet
+ * @param matchBuilder MatchBuilder Object without a match yet
* @param tcpport Integer representing a source TCP port
* @return matchBuilder Map MatchBuilder Object with a match
*/
* @param tcpPort PortNumber representing a destination TCP port
* @param tcpFlag int representing a tcp_flag
* @return match containing TCP_Flag (), IP Protocol (TCP), TCP_Flag (SYN)
- * <p/>
+ * <p>
* Defined TCP Flag values in OVS v2.1+
* TCP_FIN 0x001 / TCP_SYN 0x002 / TCP_RST 0x004
* TCP_PSH 0x008 / TCP_ACK 0x010 / TCP_URG 0x020
/**
* Create TCP Port Match
*
- * @param matchBuilder @param matchbuilder MatchBuilder Object without a match yet
- * @param tcpport Integer representing a source TCP port
+ * @param matchBuilder MatchBuilder Object without a match yet
+ * @param ipProtocol Integer representing the IP protocol
* @return matchBuilder Map MatchBuilder Object with a match
*/
public static MatchBuilder createIpProtocolMatch(MatchBuilder matchBuilder, short ipProtocol) {
Code Review / ovsdb.git / commitdiff