diff options
Diffstat (limited to 'framework/src/onos/ovsdb/api/src/main')
15 files changed, 71 insertions, 64 deletions
diff --git a/framework/src/onos/ovsdb/api/src/main/java/org/onosproject/ovsdb/controller/EventSubject.java b/framework/src/onos/ovsdb/api/src/main/java/org/onosproject/ovsdb/controller/EventSubject.java index 6a067244..d8aaef65 100644 --- a/framework/src/onos/ovsdb/api/src/main/java/org/onosproject/ovsdb/controller/EventSubject.java +++ b/framework/src/onos/ovsdb/api/src/main/java/org/onosproject/ovsdb/controller/EventSubject.java @@ -16,8 +16,7 @@ package org.onosproject.ovsdb.controller; /** - * Represents for a entity that carry important information for listener. + * Representation for an entity that carries important information for a listener. */ public interface EventSubject { - } diff --git a/framework/src/onos/ovsdb/api/src/main/java/org/onosproject/ovsdb/controller/OvsdbBridge.java b/framework/src/onos/ovsdb/api/src/main/java/org/onosproject/ovsdb/controller/OvsdbBridge.java index 1ee0a367..18c59e14 100644 --- a/framework/src/onos/ovsdb/api/src/main/java/org/onosproject/ovsdb/controller/OvsdbBridge.java +++ b/framework/src/onos/ovsdb/api/src/main/java/org/onosproject/ovsdb/controller/OvsdbBridge.java @@ -21,7 +21,8 @@ import static com.google.common.base.Preconditions.checkNotNull; import java.util.Objects; /** - * The class representing a ovsdb bridge. This class is immutable. + * The class representing an ovsdb bridge. + * This class is immutable. */ public final class OvsdbBridge { @@ -29,7 +30,7 @@ public final class OvsdbBridge { private final OvsdbDatapathId datapathId; /** - * Constructor from a OvsdbBridgeName bridgeName and a OvsdbDatapathId + * Constructor from an OvsdbBridgeName bridgeName and an OvsdbDatapathId * datapathId. * * @param bridgeName the bridgeName to use @@ -43,16 +44,16 @@ public final class OvsdbBridge { } /** - * Gets the bridge name of the bridge. + * Gets the bridge name of bridge. * - * @return the bridge name of the bridge + * @return the bridge name of bridge */ public OvsdbBridgeName bridgeName() { return bridgeName; } /** - * Gets the datapathId of the bridge. + * Gets the datapathId of bridge. * * @return datapathId the datapathId to use */ diff --git a/framework/src/onos/ovsdb/api/src/main/java/org/onosproject/ovsdb/controller/OvsdbBridgeName.java b/framework/src/onos/ovsdb/api/src/main/java/org/onosproject/ovsdb/controller/OvsdbBridgeName.java index daedff5f..899799fa 100644 --- a/framework/src/onos/ovsdb/api/src/main/java/org/onosproject/ovsdb/controller/OvsdbBridgeName.java +++ b/framework/src/onos/ovsdb/api/src/main/java/org/onosproject/ovsdb/controller/OvsdbBridgeName.java @@ -21,14 +21,15 @@ import static com.google.common.base.Preconditions.checkNotNull; import java.util.Objects; /** - * The class representing a bridge name. This class is immutable. + * The class representing a bridge name. + * This class is immutable. */ public final class OvsdbBridgeName { private final String value; /** - * Constructor from a String bridge name. + * Constructor from a String. * * @param value the bridge name to use */ @@ -38,7 +39,7 @@ public final class OvsdbBridgeName { } /** - * Gets the value of the bridge name. + * Gets the value of bridge name. * * @return the value of the bridge name */ diff --git a/framework/src/onos/ovsdb/api/src/main/java/org/onosproject/ovsdb/controller/OvsdbClientService.java b/framework/src/onos/ovsdb/api/src/main/java/org/onosproject/ovsdb/controller/OvsdbClientService.java index e619f8e0..edd25ac6 100644 --- a/framework/src/onos/ovsdb/api/src/main/java/org/onosproject/ovsdb/controller/OvsdbClientService.java +++ b/framework/src/onos/ovsdb/api/src/main/java/org/onosproject/ovsdb/controller/OvsdbClientService.java @@ -43,7 +43,7 @@ public interface OvsdbClientService extends OvsdbRPC { OvsdbNodeId nodeId(); /** - * Creates the configuration for the tunnel. + * Creates the configuration for tunnel. * * @param srcIp source IP address * @param dstIp destination IP address @@ -62,7 +62,7 @@ public interface OvsdbClientService extends OvsdbRPC { boolean createTunnel(String bridgeName, String portName, String tunnelType, Map<String, String> options); /** - * Drops the configuration for the tunnel. + * Drops the configuration for tunnel. * * @param srcIp source IP address * @param dstIp destination IP address @@ -70,7 +70,7 @@ public interface OvsdbClientService extends OvsdbRPC { void dropTunnel(IpAddress srcIp, IpAddress dstIp); /** - * Gets tunnels of the node. + * Gets tunnels of node. * * @return set of tunnels; empty if no tunnel is find */ @@ -102,14 +102,14 @@ public interface OvsdbClientService extends OvsdbRPC { void dropBridge(String bridgeName); /** - * Gets bridges of the node. + * Gets bridges of node. * * @return set of bridges; empty if no bridge is find */ Set<OvsdbBridge> getBridges(); /** - * Gets controllers of the node. + * Gets controllers of node. * * @param openflowDeviceId target device id * @return set of controllers; empty if no controller is find @@ -155,7 +155,7 @@ public interface OvsdbClientService extends OvsdbRPC { void dropPort(String bridgeName, String portName); /** - * Gets ports of the bridge. + * Gets ports of bridge. * * @return set of ports; empty if no ports is find */ @@ -247,7 +247,7 @@ public interface OvsdbClientService extends OvsdbRPC { DatabaseSchema getDatabaseSchema(String dbName); /** - * Gets the ovsdb row from the local ovsdb store. + * Gets the ovsdb row from local ovsdb store. * * @param dbName database name * @param tableName table name @@ -257,7 +257,7 @@ public interface OvsdbClientService extends OvsdbRPC { Row getRow(String dbName, String tableName, String uuid); /** - * Removes the ovsdb row from the local ovsdb store. + * Removes the ovsdb row from local ovsdb store. * * @param dbName database name * @param tableName table name diff --git a/framework/src/onos/ovsdb/api/src/main/java/org/onosproject/ovsdb/controller/OvsdbController.java b/framework/src/onos/ovsdb/api/src/main/java/org/onosproject/ovsdb/controller/OvsdbController.java index 24bfeae9..f22a5787 100644 --- a/framework/src/onos/ovsdb/api/src/main/java/org/onosproject/ovsdb/controller/OvsdbController.java +++ b/framework/src/onos/ovsdb/api/src/main/java/org/onosproject/ovsdb/controller/OvsdbController.java @@ -21,7 +21,7 @@ import org.onlab.packet.TpPort; import java.util.List; /** - * Abstraction of an ovsdb controller. Serves as a one stop shop for obtaining + * Abstraction of an ovsdb controller. Serves as an one stop shop for obtaining * OvsdbNode and (un)register listeners on ovsdb events and ovsdb node events. */ public interface OvsdbController { @@ -62,7 +62,7 @@ public interface OvsdbController { List<OvsdbNodeId> getNodeIds(); /** - * Gets a ovsdb client by node identifier. + * Gets an ovsdb client by node identifier. * * @param nodeId node identifier * @return OvsdbClient ovsdb node information diff --git a/framework/src/onos/ovsdb/api/src/main/java/org/onosproject/ovsdb/controller/OvsdbDatapathId.java b/framework/src/onos/ovsdb/api/src/main/java/org/onosproject/ovsdb/controller/OvsdbDatapathId.java index 1a2d8366..8ccf45f2 100644 --- a/framework/src/onos/ovsdb/api/src/main/java/org/onosproject/ovsdb/controller/OvsdbDatapathId.java +++ b/framework/src/onos/ovsdb/api/src/main/java/org/onosproject/ovsdb/controller/OvsdbDatapathId.java @@ -20,13 +20,14 @@ import static com.google.common.base.Preconditions.checkNotNull; import java.util.Objects; /** - * The class representing a datapathid. This class is immutable. + * The class representing a datapathid. + * This class is immutable. */ public final class OvsdbDatapathId { private final String value; /** - * Constructor from a String datapathid. + * Constructor from a String. * * @param value the datapathid to use */ @@ -36,9 +37,9 @@ public final class OvsdbDatapathId { } /** - * Gets the value of the datapathid. + * Gets the value of datapathid. * - * @return the value of the datapathid + * @return the value of datapathid */ public String value() { return value; diff --git a/framework/src/onos/ovsdb/api/src/main/java/org/onosproject/ovsdb/controller/OvsdbEventSubject.java b/framework/src/onos/ovsdb/api/src/main/java/org/onosproject/ovsdb/controller/OvsdbEventSubject.java index 263027f2..226a26e6 100644 --- a/framework/src/onos/ovsdb/api/src/main/java/org/onosproject/ovsdb/controller/OvsdbEventSubject.java +++ b/framework/src/onos/ovsdb/api/src/main/java/org/onosproject/ovsdb/controller/OvsdbEventSubject.java @@ -21,7 +21,7 @@ import org.onlab.packet.IpAddress; import org.onlab.packet.MacAddress; /** - * Represents for a entity that carry important information for listener. + * Represents for an entity that carry important information for listener. */ public interface OvsdbEventSubject extends EventSubject { /** diff --git a/framework/src/onos/ovsdb/api/src/main/java/org/onosproject/ovsdb/controller/OvsdbIfaceId.java b/framework/src/onos/ovsdb/api/src/main/java/org/onosproject/ovsdb/controller/OvsdbIfaceId.java index b0535d21..10ba80bc 100644 --- a/framework/src/onos/ovsdb/api/src/main/java/org/onosproject/ovsdb/controller/OvsdbIfaceId.java +++ b/framework/src/onos/ovsdb/api/src/main/java/org/onosproject/ovsdb/controller/OvsdbIfaceId.java @@ -20,13 +20,14 @@ import static com.google.common.base.Preconditions.checkNotNull; import java.util.Objects; /** - * The class representing a ifaceid. This class is immutable. + * The class representing an ifaceid. + * This class is immutable. */ public class OvsdbIfaceId { private final String value; /** - * Constructor from a String ifaceid. + * Constructor from a String. * * @param value the ifaceid to use */ @@ -36,9 +37,9 @@ public class OvsdbIfaceId { } /** - * Gets the value of the ifaceid. + * Gets the value of ifaceid. * - * @return the value of the ifaceid + * @return the value of ifaceid */ public String value() { return value; diff --git a/framework/src/onos/ovsdb/api/src/main/java/org/onosproject/ovsdb/controller/OvsdbNodeId.java b/framework/src/onos/ovsdb/api/src/main/java/org/onosproject/ovsdb/controller/OvsdbNodeId.java index 2c1a440b..f3bba4b8 100644 --- a/framework/src/onos/ovsdb/api/src/main/java/org/onosproject/ovsdb/controller/OvsdbNodeId.java +++ b/framework/src/onos/ovsdb/api/src/main/java/org/onosproject/ovsdb/controller/OvsdbNodeId.java @@ -39,7 +39,7 @@ public final class OvsdbNodeId { public OvsdbNodeId(IpAddress ipAddress, long port) { checkNotNull(ipAddress, "ipAddress is not null"); this.ipAddress = ipAddress.toString(); - this.nodeId = ipAddress + ":" + port; + this.nodeId = ipAddress.toString(); } @Override diff --git a/framework/src/onos/ovsdb/api/src/main/java/org/onosproject/ovsdb/controller/OvsdbPort.java b/framework/src/onos/ovsdb/api/src/main/java/org/onosproject/ovsdb/controller/OvsdbPort.java index 3c04f6a5..deea42d7 100644 --- a/framework/src/onos/ovsdb/api/src/main/java/org/onosproject/ovsdb/controller/OvsdbPort.java +++ b/framework/src/onos/ovsdb/api/src/main/java/org/onosproject/ovsdb/controller/OvsdbPort.java @@ -29,7 +29,7 @@ public final class OvsdbPort { private final OvsdbPortName portName; /** - * Constructor from a OvsdbPortNumber portNumber, OvsdbPortName portName. + * Constructor from OvsdbPortNumber portNumber, OvsdbPortName portName. * * @param portNumber the portNumber to use * @param portName the portName to use @@ -42,18 +42,18 @@ public final class OvsdbPort { } /** - * Gets the port number of the port. + * Gets the port number of port. * - * @return the port number of the port + * @return the port number of port */ public OvsdbPortNumber portNumber() { return portNumber; } /** - * Gets the port name of the port. + * Gets the port name of port. * - * @return the port name of the port + * @return the port name of port */ public OvsdbPortName portName() { return portName; diff --git a/framework/src/onos/ovsdb/api/src/main/java/org/onosproject/ovsdb/controller/OvsdbPortName.java b/framework/src/onos/ovsdb/api/src/main/java/org/onosproject/ovsdb/controller/OvsdbPortName.java index aa0f55b0..d9c7c2da 100644 --- a/framework/src/onos/ovsdb/api/src/main/java/org/onosproject/ovsdb/controller/OvsdbPortName.java +++ b/framework/src/onos/ovsdb/api/src/main/java/org/onosproject/ovsdb/controller/OvsdbPortName.java @@ -21,14 +21,15 @@ import static com.google.common.base.Preconditions.checkNotNull; import java.util.Objects; /** - * The class representing a port number. This class is immutable. + * The class representing a port number. + * This class is immutable. */ public final class OvsdbPortName { private final String value; /** - * Constructor from a String port name. + * Constructor from a String. * * @param value the port name to use */ @@ -38,9 +39,9 @@ public final class OvsdbPortName { } /** - * Gets the value of the port name. + * Gets the value of port name. * - * @return the value of the port name + * @return the value of port name */ public String value() { return value; diff --git a/framework/src/onos/ovsdb/api/src/main/java/org/onosproject/ovsdb/controller/OvsdbPortNumber.java b/framework/src/onos/ovsdb/api/src/main/java/org/onosproject/ovsdb/controller/OvsdbPortNumber.java index 9c57b5df..bd094d04 100644 --- a/framework/src/onos/ovsdb/api/src/main/java/org/onosproject/ovsdb/controller/OvsdbPortNumber.java +++ b/framework/src/onos/ovsdb/api/src/main/java/org/onosproject/ovsdb/controller/OvsdbPortNumber.java @@ -20,14 +20,15 @@ import static com.google.common.base.MoreObjects.toStringHelper; import java.util.Objects; /** - * The class representing a port number. This class is immutable. + * The class representing a port number. + * This class is immutable. */ public final class OvsdbPortNumber { private final long value; /** - * Constructor from a long port number. + * Constructor from a long value. * * @param value the port number to use */ @@ -36,9 +37,9 @@ public final class OvsdbPortNumber { } /** - * Gets the value of the port number. + * Gets the value of port number. * - * @return the value of the port number + * @return the value of port number */ public long value() { return value; diff --git a/framework/src/onos/ovsdb/api/src/main/java/org/onosproject/ovsdb/controller/OvsdbTableStore.java b/framework/src/onos/ovsdb/api/src/main/java/org/onosproject/ovsdb/controller/OvsdbTableStore.java index 1d9146eb..72b64f32 100644 --- a/framework/src/onos/ovsdb/api/src/main/java/org/onosproject/ovsdb/controller/OvsdbTableStore.java +++ b/framework/src/onos/ovsdb/api/src/main/java/org/onosproject/ovsdb/controller/OvsdbTableStore.java @@ -29,18 +29,18 @@ public class OvsdbTableStore { /** * Gets the ovsdbRowStore. * - * @param tableName a ovsdb table name - * @return OvsdbRowStore the data of the table + * @param tableName an ovsdb table name + * @return OvsdbRowStore the data of table */ public OvsdbRowStore getRows(String tableName) { return tableStore.get(tableName); } /** - * Create or update a value to tableStore. + * Creates or updates a value to tableStore. * - * @param tableName key of the tableName - * @param rowStore a row of the table + * @param tableName key of tableName + * @param rowStore a row of table */ public void createOrUpdateTable(String tableName, OvsdbRowStore rowStore) { tableStore.put(tableName, rowStore); @@ -49,14 +49,14 @@ public class OvsdbTableStore { /** * Drops a value to table data. * - * @param tableName key of the tableName + * @param tableName key of tableName */ public void dropTable(String tableName) { tableStore.remove(tableName); } /** - * Gets the tableStore. + * Gets tableStore. * * @return tableStore */ diff --git a/framework/src/onos/ovsdb/api/src/main/java/org/onosproject/ovsdb/controller/OvsdbTunnel.java b/framework/src/onos/ovsdb/api/src/main/java/org/onosproject/ovsdb/controller/OvsdbTunnel.java index e1c5c7fd..8c857da4 100644 --- a/framework/src/onos/ovsdb/api/src/main/java/org/onosproject/ovsdb/controller/OvsdbTunnel.java +++ b/framework/src/onos/ovsdb/api/src/main/java/org/onosproject/ovsdb/controller/OvsdbTunnel.java @@ -23,7 +23,8 @@ import java.util.Objects; import org.onlab.packet.IpAddress; /** - * The class representing a ovsdb tunnel. This class is immutable. + * The class representing an ovsdb tunnel. + * This class is immutable. */ public final class OvsdbTunnel { @@ -38,7 +39,7 @@ public final class OvsdbTunnel { private final OvsdbTunnelName tunnelName; /** - * Constructor from a IpAddress localIp, IpAddress remoteIp Type tunnelType, + * Constructor from an IpAddress localIp, IpAddress remoteIp Type tunnelType, * OvsdbTunnelName tunnelName. * * @param localIp the localIp to use @@ -58,36 +59,36 @@ public final class OvsdbTunnel { } /** - * Gets the local IP of the tunnel. + * Gets the local IP of tunnel. * - * @return the local IP of the tunnel + * @return the local IP of tunnel */ public IpAddress localIp() { return localIp; } /** - * Gets the remote IP of the tunnel. + * Gets the remote IP of tunnel. * - * @return the remote IP of the tunnel + * @return the remote IP of tunnel */ public IpAddress remoteIp() { return remoteIp; } /** - * Gets the tunnel type of the tunnel. + * Gets the tunnel type of tunnel. * - * @return the tunnel type of the tunnel + * @return the tunnel type of tunnel */ public Type tunnelType() { return tunnelType; } /** - * Gets the tunnel name of the tunnel. + * Gets the tunnel name of tunnel. * - * @return the tunnel name of the tunnel + * @return the tunnel name of tunnel */ public OvsdbTunnelName tunnelName() { return tunnelName; diff --git a/framework/src/onos/ovsdb/api/src/main/java/org/onosproject/ovsdb/controller/OvsdbTunnelName.java b/framework/src/onos/ovsdb/api/src/main/java/org/onosproject/ovsdb/controller/OvsdbTunnelName.java index 116f6217..80befab3 100644 --- a/framework/src/onos/ovsdb/api/src/main/java/org/onosproject/ovsdb/controller/OvsdbTunnelName.java +++ b/framework/src/onos/ovsdb/api/src/main/java/org/onosproject/ovsdb/controller/OvsdbTunnelName.java @@ -21,13 +21,14 @@ import static com.google.common.base.Preconditions.checkNotNull; import java.util.Objects; /** - * The class representing a tunnel name. This class is immutable. + * The class representing a tunnel name. + * This class is immutable. */ public final class OvsdbTunnelName { private final String value; /** - * Constructor from a String tunnel name. + * Constructor from a String. * * @param value the tunnel name to use */ @@ -37,9 +38,9 @@ public final class OvsdbTunnelName { } /** - * Gets the value of the tunnel name. + * Gets the value of tunnel name. * - * @return the value of the tunnel name + * @return the value of tunnel name */ public String value() { return value; |