org.onosproject.incubator.net.tunnel

Interface OpticalTunnelEndPoint

All Superinterfaces:

Annotated, NetworkResource, Provided, TunnelEndPoint

All Known Implementing Classes:

DefaultOpticalTunnelEndPoint

@Beta
public interface OpticalTunnelEndPoint
extends TunnelEndPoint, Annotated, Provided, NetworkResource

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.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	OpticalTunnelEndPoint.Type Represents coarse tunnel point type classification.

Method Summary

Modifier and Type	Method and Description
java.util.Optional<ElementId>	elementId() Returns the parent network element to which this tunnel point belongs.
OpticalLogicId	id() Returns the identifier.
boolean	isGlobal() Indicates whether or not the port is global significant.
java.util.Optional<OpticalTunnelEndPoint>	parentPoint() Returns the parent tunnel point to which this tunnel point belongs, optional.
java.util.Optional<PortNumber>	portNumber() Returns the parent network port to which this tunnel point belongs, can not be be null.
OpticalTunnelEndPoint.Type	type() Returns the tunnel point type.

Methods inherited from interface org.onosproject.net.Annotated

annotations

Methods inherited from interface org.onosproject.net.Provided

providerId

Method Detail

id

OpticalLogicId id()

Returns the identifier.

Returns:

identifier

elementId

java.util.Optional<ElementId> elementId()

Returns the parent network element to which this tunnel point belongs.

Returns:

parent network element

portNumber

java.util.Optional<PortNumber> portNumber()

Returns the parent network port to which this tunnel point belongs, can not be be null.

Returns:

port number

parentPoint

java.util.Optional<OpticalTunnelEndPoint> parentPoint()

Returns the parent tunnel point to which this tunnel point belongs, optional.

Returns:

parent tunnel point, if it is null, the parent is a physical port

isGlobal

boolean isGlobal()

Indicates whether or not the port is global significant.

Returns:

true if the port is global significant

type

OpticalTunnelEndPoint.Type type()

Returns the tunnel point type.

Returns:

tunnel point type