org.onosproject.incubator.net.tunnel

Class DefaultTunnel

java.lang.Object

org.onosproject.net.AbstractAnnotated

org.onosproject.net.AbstractModel

org.onosproject.incubator.net.tunnel.DefaultTunnel

All Implemented Interfaces:

Tunnel, Annotated, NetworkResource, Provided

@Beta
public final class DefaultTunnel
extends AbstractModel
implements Tunnel

The default implementation of an network tunnel. supports for creating a tunnel by connect point ,IP address, MAC address, device and so on.

Nested Class Summary

Nested classes/interfaces inherited from interface org.onosproject.incubator.net.tunnel.Tunnel

Tunnel.State, Tunnel.Type

Constructor Summary

Constructors

Constructor and Description
DefaultTunnel(ProviderId producerName, TunnelEndPoint src, TunnelEndPoint dst, Tunnel.Type type, GroupId groupId, TunnelId tunnelId, TunnelName tunnelName, Path path, Annotations... annotations) Creates an active infrastructure tunnel using the supplied information.
DefaultTunnel(ProviderId producerName, TunnelEndPoint src, TunnelEndPoint dst, Tunnel.Type type, GroupId groupId, TunnelId tunnelId, TunnelName tunnelName, Path path, NetworkResource networkRes, Annotations... annotations) Creates an active infrastructure tunnel using the supplied information.
DefaultTunnel(ProviderId producerName, TunnelEndPoint src, TunnelEndPoint dst, Tunnel.Type type, Tunnel.State state, GroupId groupId, TunnelId tunnelId, TunnelName tunnelName, Path path, Annotations... annotations) Creates an tunnel using the supplied information.
DefaultTunnel(ProviderId producerName, TunnelEndPoint src, TunnelEndPoint dst, Tunnel.Type type, Tunnel.State state, GroupId groupId, TunnelId tunnelId, TunnelName tunnelName, Path path, NetworkResource networkRes, Annotations... annotations) Creates an tunnel using the supplied information.

Method Summary

Modifier and Type	Method and Description
TunnelEndPoint	dst() the terminal of a tunnel.
boolean	equals(java.lang.Object obj)
GroupId	groupId() Returns group flow table id which a tunnel match up.
int	hashCode()
Path	path() Returns the path of the tunnel.
NetworkResource	resource() Network resource backing the tunnel, e.g.
TunnelEndPoint	src() the origin of a tunnel.
Tunnel.State	state() Returns the tunnel state.
java.lang.String	toString()
TunnelId	tunnelId() Returns tunnel identify generated by ONOS as primary key.
TunnelName	tunnelName() Return the name of a tunnel.
Tunnel.Type	type() Returns the tunnel type.

Methods inherited from class org.onosproject.net.AbstractModel

providerId

Methods inherited from class org.onosproject.net.AbstractAnnotated

annotations

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.onosproject.net.Annotated

annotations

Methods inherited from interface org.onosproject.net.Provided

providerId

Constructor Detail

DefaultTunnel

public DefaultTunnel(ProviderId producerName,
                     TunnelEndPoint src,
                     TunnelEndPoint dst,
                     Tunnel.Type type,
                     GroupId groupId,
                     TunnelId tunnelId,
                     TunnelName tunnelName,
                     Path path,
                     Annotations... annotations)

Creates an active infrastructure tunnel using the supplied information.

Parameters:

producerName - provider identity

src - tunnel source

dst - tunnel destination

type - tunnel type

groupId - groupId

tunnelId - tunnelId

tunnelName - tunnel name

path - the path of tunnel

annotations - optional key/value annotations

DefaultTunnel

public DefaultTunnel(ProviderId producerName,
                     TunnelEndPoint src,
                     TunnelEndPoint dst,
                     Tunnel.Type type,
                     Tunnel.State state,
                     GroupId groupId,
                     TunnelId tunnelId,
                     TunnelName tunnelName,
                     Path path,
                     Annotations... annotations)

Creates an tunnel using the supplied information.

Parameters:

producerName - provider identity

src - tunnel source

dst - tunnel destination

type - tunnel type

state - tunnel state

groupId - groupId

tunnelId - tunnelId

tunnelName - tunnel name

path - the path of tunnel

annotations - optional key/value annotations

DefaultTunnel

public DefaultTunnel(ProviderId producerName,
                     TunnelEndPoint src,
                     TunnelEndPoint dst,
                     Tunnel.Type type,
                     GroupId groupId,
                     TunnelId tunnelId,
                     TunnelName tunnelName,
                     Path path,
                     NetworkResource networkRes,
                     Annotations... annotations)

Creates an active infrastructure tunnel using the supplied information.

Parameters:

producerName - provider identity

src - tunnel source

dst - tunnel destination

type - tunnel type

groupId - groupId

tunnelId - tunnelId

tunnelName - tunnel name

path - the path of tunnel

networkRes - network resource of tunnel

annotations - optional key/value annotations

DefaultTunnel

public DefaultTunnel(ProviderId producerName,
                     TunnelEndPoint src,
                     TunnelEndPoint dst,
                     Tunnel.Type type,
                     Tunnel.State state,
                     GroupId groupId,
                     TunnelId tunnelId,
                     TunnelName tunnelName,
                     Path path,
                     NetworkResource networkRes,
                     Annotations... annotations)

Creates an tunnel using the supplied information.

Parameters:

producerName - provider identity

src - tunnel source

dst - tunnel destination

type - tunnel type

state - tunnel state

groupId - groupId

tunnelId - tunnelId

tunnelName - tunnel name

path - the path of tunnel

networkRes - network resource of tunnel

annotations - optional key/value annotations

Method Detail

src

public TunnelEndPoint src()

Description copied from interface: Tunnel

the origin of a tunnel.

Specified by:

src in interface Tunnel

Returns:

the origin of a tunnel

dst

public TunnelEndPoint dst()

Description copied from interface: Tunnel

the terminal of a tunnel.

Specified by:

dst in interface Tunnel

Returns:

the terminal of a tunnel

type

public Tunnel.Type type()

Description copied from interface: Tunnel

Returns the tunnel type.

Specified by:

type in interface Tunnel

Returns:

tunnel type

state

public Tunnel.State state()

Description copied from interface: Tunnel

Returns the tunnel state.

Specified by:

state in interface Tunnel

Returns:

tunnel state

resource

public NetworkResource resource()

Description copied from interface: Tunnel

Network resource backing the tunnel, e.g. lambda, VLAN id, MPLS tag.

Specified by:

resource in interface Tunnel

Returns:

backing resource

tunnelId

public TunnelId tunnelId()

Description copied from interface: Tunnel

Returns tunnel identify generated by ONOS as primary key.

Specified by:

tunnelId in interface Tunnel

Returns:

TunnelId

groupId

public GroupId groupId()

Description copied from interface: Tunnel

Returns group flow table id which a tunnel match up.

Specified by:

groupId in interface Tunnel

Returns:

OpenFlowGroupId

tunnelName

public TunnelName tunnelName()

Description copied from interface: Tunnel

Return the name of a tunnel.

Specified by:

tunnelName in interface Tunnel

Returns:

Tunnel Name

path

public Path path()

Description copied from interface: Tunnel

Returns the path of the tunnel.

Specified by:

path in interface Tunnel

Returns:

the path of the tunnel

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object