diff options
author | Ashlee Young <ashlee@onosfw.com> | 2015-09-09 22:15:21 -0700 |
---|---|---|
committer | Ashlee Young <ashlee@onosfw.com> | 2015-09-09 22:15:21 -0700 |
commit | 13d05bc8458758ee39cb829098241e89616717ee (patch) | |
tree | 22a4d1ce65f15952f07a3df5af4b462b4697cb3a /framework/src/onos/core/api/src/main/java/org/onosproject/net/Port.java | |
parent | 6139282e1e93c2322076de4b91b1c85d0bc4a8b3 (diff) |
ONOS checkin based on commit tag e796610b1f721d02f9b0e213cf6f7790c10ecd60
Change-Id: Ife8810491034fe7becdba75dda20de4267bd15cd
Diffstat (limited to 'framework/src/onos/core/api/src/main/java/org/onosproject/net/Port.java')
-rw-r--r-- | framework/src/onos/core/api/src/main/java/org/onosproject/net/Port.java | 100 |
1 files changed, 100 insertions, 0 deletions
diff --git a/framework/src/onos/core/api/src/main/java/org/onosproject/net/Port.java b/framework/src/onos/core/api/src/main/java/org/onosproject/net/Port.java new file mode 100644 index 00000000..d70b1e17 --- /dev/null +++ b/framework/src/onos/core/api/src/main/java/org/onosproject/net/Port.java @@ -0,0 +1,100 @@ +/* + * Copyright 2014 Open Networking Laboratory + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.onosproject.net; + + +/** + * Abstraction of a network port. + */ +public interface Port extends Annotated { + + /** Represents coarse port type classification. */ + enum Type { + /** + * Signifies copper-based connectivity. + */ + COPPER, + + /** + * Signifies optical fiber-based connectivity. + */ + FIBER, + + /** + * Signifies optical fiber-based packet port. + */ + PACKET, + + /** + * Signifies optical fiber-based optical tributary port (called T-port). + * The signal from the client side will be formed into a ITU G.709 (OTN) frame. + */ + ODUCLT, + + /** + * Signifies optical fiber-based Line-side port (called L-port). + */ + OCH, + + /** + * Signifies optical fiber-based WDM port (called W-port). + * Optical Multiplexing Section (See ITU G.709). + */ + OMS, + + /** + * Signifies virtual port. + */ + VIRTUAL + } + + /** + * Returns the parent network element to which this port belongs. + * + * @return parent network element + */ + Element element(); + + /** + * Returns the port number. + * + * @return port number + */ + PortNumber number(); + + /** + * Indicates whether or not the port is currently up and active. + * + * @return true if the port is operational + */ + boolean isEnabled(); + + /** + * Returns the port type. + * + * @return port type + */ + Type type(); + + /** + * Returns the current port speed in Mbps. + * + * @return current port speed + */ + long portSpeed(); + + // TODO: more attributes? +} |