org.onosproject.incubator.net.tunnel

Class DefaultTunnelDescription

java.lang.Object

org.onosproject.net.AbstractDescription

org.onosproject.incubator.net.tunnel.DefaultTunnelDescription

All Implemented Interfaces:

TunnelDescription, Annotated, Description

@Beta
public class DefaultTunnelDescription
extends AbstractDescription
implements TunnelDescription

Default implementation of immutable tunnel description entity.

Constructor Summary

Constructors

Constructor and Description
DefaultTunnelDescription(TunnelId id, TunnelEndPoint src, TunnelEndPoint dst, Tunnel.Type type, GroupId groupId, ProviderId producerName, TunnelName tunnelName, Path path, NetworkResource networkRes, SparseAnnotations... annotations) Creates a tunnel description using the supplied information.
DefaultTunnelDescription(TunnelId id, TunnelEndPoint src, TunnelEndPoint dst, Tunnel.Type type, GroupId groupId, ProviderId producerName, TunnelName tunnelName, Path path, SparseAnnotations... annotations) Creates a tunnel description using the supplied information.

Method Summary

Modifier and Type	Method and Description
TunnelEndPoint	dst() Returns the connection point destination.
GroupId	groupId() Returns group flow table id which a tunnel match up.
TunnelId	id() Returns the tunnel id.
Path	path() Returns the path of the tunnel.
ProviderId	producerName() Returns tunnel producer name.
NetworkResource	resource() Returns the network resource backing the tunnel, e.g.
TunnelEndPoint	src() Returns the connection point source.
String	toString()
TunnelName	tunnelName() Return the name of a tunnel.
Tunnel.Type	type() Returns the tunnel type.

Methods inherited from class org.onosproject.net.AbstractDescription

annotations, equals, hashCode

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.onosproject.net.Description

annotations

Constructor Detail

DefaultTunnelDescription

public DefaultTunnelDescription(TunnelId id,
                                TunnelEndPoint src,
                                TunnelEndPoint dst,
                                Tunnel.Type type,
                                GroupId groupId,
                                ProviderId producerName,
                                TunnelName tunnelName,
                                Path path,
                                SparseAnnotations... annotations)

Creates a tunnel description using the supplied information.

Parameters:

id - TunnelId

src - TunnelPoint source

dst - TunnelPoint destination

type - tunnel type

groupId - groupId

producerName - tunnel producer

tunnelName - tunnel name

path - the path of tunnel

annotations - optional key/value annotations

DefaultTunnelDescription

public DefaultTunnelDescription(TunnelId id,
                                TunnelEndPoint src,
                                TunnelEndPoint dst,
                                Tunnel.Type type,
                                GroupId groupId,
                                ProviderId producerName,
                                TunnelName tunnelName,
                                Path path,
                                NetworkResource networkRes,
                                SparseAnnotations... annotations)

Creates a tunnel description using the supplied information.

Parameters:

id - TunnelId

src - TunnelPoint source

dst - TunnelPoint destination

type - tunnel type

groupId - groupId

producerName - tunnel producer

tunnelName - tunnel name

path - the path of tunnel

networkRes - network resource of tunnel

annotations - optional key/value annotations

Method Detail

id

public TunnelId id()

Description copied from interface: TunnelDescription

Returns the tunnel id.

Specified by:

id in interface TunnelDescription

Returns:

tunnelId

src

public TunnelEndPoint src()

Description copied from interface: TunnelDescription

Returns the connection point source.

Specified by:

src in interface TunnelDescription

Returns:

tunnel source ConnectionPoint

dst

public TunnelEndPoint dst()

Description copied from interface: TunnelDescription

Returns the connection point destination.

Specified by:

dst in interface TunnelDescription

Returns:

tunnel destination

type

public Tunnel.Type type()

Description copied from interface: TunnelDescription

Returns the tunnel type.

Specified by:

type in interface TunnelDescription

Returns:

tunnel type

groupId

public GroupId groupId()

Description copied from interface: TunnelDescription

Returns group flow table id which a tunnel match up.

Specified by:

groupId in interface TunnelDescription

Returns:

OpenFlowGroupId

producerName

public ProviderId producerName()

Description copied from interface: TunnelDescription

Returns tunnel producer name.

Specified by:

producerName in interface TunnelDescription

Returns:

producer name

tunnelName

public TunnelName tunnelName()

Description copied from interface: TunnelDescription

Return the name of a tunnel.

Specified by:

tunnelName in interface TunnelDescription

Returns:

Tunnel Name

path

public Path path()

Description copied from interface: TunnelDescription

Returns the path of the tunnel.

Specified by:

path in interface TunnelDescription

Returns:

the path of the tunnel

resource

public NetworkResource resource()

Description copied from interface: TunnelDescription

Returns the network resource backing the tunnel, e.g. lambda, VLAN id, MPLS tag, label stack.

Specified by:

resource in interface TunnelDescription

Returns:

backing resource

toString

public String toString()

Overrides:

toString in class Object