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/incubator/api/src/main/java/org/onosproject/incubator/net/tunnel/OpticalTunnelEndPoint.java | |
parent | 6139282e1e93c2322076de4b91b1c85d0bc4a8b3 (diff) |
ONOS checkin based on commit tag e796610b1f721d02f9b0e213cf6f7790c10ecd60
Change-Id: Ife8810491034fe7becdba75dda20de4267bd15cd
Diffstat (limited to 'framework/src/onos/incubator/api/src/main/java/org/onosproject/incubator/net/tunnel/OpticalTunnelEndPoint.java')
-rw-r--r-- | framework/src/onos/incubator/api/src/main/java/org/onosproject/incubator/net/tunnel/OpticalTunnelEndPoint.java | 90 |
1 files changed, 90 insertions, 0 deletions
diff --git a/framework/src/onos/incubator/api/src/main/java/org/onosproject/incubator/net/tunnel/OpticalTunnelEndPoint.java b/framework/src/onos/incubator/api/src/main/java/org/onosproject/incubator/net/tunnel/OpticalTunnelEndPoint.java new file mode 100644 index 00000000..7d72398d --- /dev/null +++ b/framework/src/onos/incubator/api/src/main/java/org/onosproject/incubator/net/tunnel/OpticalTunnelEndPoint.java @@ -0,0 +1,90 @@ +/* + * Copyright 2015 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.incubator.net.tunnel; + +import java.util.Optional; + +import com.google.common.annotations.Beta; +import org.onosproject.net.Annotated; +import org.onosproject.net.ElementId; +import org.onosproject.net.NetworkResource; +import org.onosproject.net.PortNumber; +import org.onosproject.net.Provided; + +/** + * Generic representation of a logical port entity in a consistent way, + * it is used to identify e.g., ODUk timeSlot, WDM lambda, etc. + * It supports nested case. + */ +@Beta +public interface OpticalTunnelEndPoint extends TunnelEndPoint, Annotated, Provided, NetworkResource { + + /** Represents coarse tunnel point type classification. */ + public enum Type { + /** + * Signifies optical data unit-based tunnel point. + */ + TIMESLOT, + + /** + * Signifies optical wavelength-based tunnel point. + */ + LAMBDA + } + + /** + * Returns the identifier. + * + * @return identifier + */ + OpticalLogicId id(); + + /** + * Returns the parent network element to which this tunnel point belongs. + * + * @return parent network element + */ + Optional<ElementId> elementId(); + + /** + * Returns the parent network port to which this tunnel point belongs, can not be be null. + * + * @return port number + */ + Optional<PortNumber> portNumber(); + + /** + * Returns the parent tunnel point to which this tunnel point belongs, optional. + * + * @return parent tunnel point, if it is null, the parent is a physical port + */ + Optional<OpticalTunnelEndPoint> parentPoint(); + + /** + * Indicates whether or not the port is global significant. + * + * @return true if the port is global significant + */ + boolean isGlobal(); + + /** + * Returns the tunnel point type. + * + * @return tunnel point type + */ + Type type(); +} |