org.onosproject.net.behaviour

Class DefaultTunnelDescription

java.lang.Object

org.onosproject.net.AbstractDescription

org.onosproject.net.behaviour.DefaultTunnelDescription

All Implemented Interfaces:

Annotated, TunnelDescription, Description

public final class DefaultTunnelDescription
extends AbstractDescription
implements TunnelDescription

Default implementation of immutable tunnel interface description entity.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DefaultTunnelDescription.Builder

Nested classes/interfaces inherited from interface org.onosproject.net.behaviour.TunnelDescription

TunnelDescription.Type

Constructor Summary

Constructors

Constructor and Description
DefaultTunnelDescription(TunnelEndPoint src, TunnelEndPoint dst, TunnelDescription.Type type, TunnelName tunnelName, SparseAnnotations... annotations) Deprecated. version 1.7.0 - Hummingbird

Method Summary

Modifier and Type	Method and Description
static DefaultTunnelDescription.Builder	builder() Creates and returns a new builder instance.
Optional<String>	deviceId() Returns the identifier of the device where the interface is.
TunnelEndPoint	dst() Deprecated.
String	ifaceName() Return the name of the tunnel interface.
Optional<TunnelKey>	key() Returns the tunnel key.
Optional<TunnelEndPoint>	local() Returns the local connection point.
Optional<TunnelEndPoint>	remote() Returns the remote connection point.
TunnelEndPoint	src() Deprecated.
String	toString()
TunnelName	tunnelName() Deprecated.
TunnelDescription.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

@Deprecated
public DefaultTunnelDescription(TunnelEndPoint src,
                                            TunnelEndPoint dst,
                                            TunnelDescription.Type type,
                                            TunnelName tunnelName,
                                            SparseAnnotations... annotations)

Deprecated. version 1.7.0 - Hummingbird

Creates a tunnel description using the supplied information.

Parameters:

src - TunnelPoint source

dst - TunnelPoint destination

type - tunnel type

tunnelName - tunnel name

annotations - optional key/value annotations

Method Detail

deviceId

public Optional<String> deviceId()

Description copied from interface: TunnelDescription

Returns the identifier of the device where the interface is.

Specified by:

deviceId in interface TunnelDescription

Returns:

device identifier

ifaceName

public String ifaceName()

Description copied from interface: TunnelDescription

Return the name of the tunnel interface.

Specified by:

ifaceName in interface TunnelDescription

Returns:

tunnel interface name

src

@Deprecated
public TunnelEndPoint src()

Deprecated.

Description copied from interface: TunnelDescription

Returns the connection point source.

Specified by:

src in interface TunnelDescription

Returns:

tunnel source ConnectionPoint

dst

@Deprecated
public TunnelEndPoint dst()

Deprecated.

Description copied from interface: TunnelDescription

Returns the connection point destination.

Specified by:

dst in interface TunnelDescription

Returns:

tunnel destination

type

public TunnelDescription.Type type()

Description copied from interface: TunnelDescription

Returns the tunnel type.

Specified by:

type in interface TunnelDescription

Returns:

tunnel type

local

public Optional<TunnelEndPoint> local()

Description copied from interface: TunnelDescription

Returns the local connection point.

Specified by:

local in interface TunnelDescription

Returns:

tunnel source ConnectionPoint

remote

public Optional<TunnelEndPoint> remote()

Description copied from interface: TunnelDescription

Returns the remote connection point.

Specified by:

remote in interface TunnelDescription

Returns:

tunnel destination

key

public Optional<TunnelKey> key()

Description copied from interface: TunnelDescription

Returns the tunnel key.

Specified by:

key in interface TunnelDescription

Returns:

tunnel key

tunnelName

@Deprecated
public TunnelName tunnelName()

Deprecated.

Description copied from interface: TunnelDescription

Return the name of a tunnel.

Specified by:

tunnelName in interface TunnelDescription

Returns:

Tunnel Name

toString

public String toString()

Overrides:

toString in class Object

builder

public static DefaultTunnelDescription.Builder builder()

Creates and returns a new builder instance.

Returns:

default tunnel description builder