org.opencord.cordvtn.api.core

Class Instance

java.lang.Object

org.opencord.cordvtn.api.core.Instance

public final class Instance
extends Object

Provides methods to help to handle network network instance.

Field Summary

Fields

Modifier and Type	Field and Description
static String	CREATE_TIME
static String	NETWORK_ID
static String	NETWORK_TYPE
static String	ORIGINAL_HOST_ID
static String	PORT_ID

Method Summary

Modifier and Type	Method and Description
org.onosproject.net.DeviceId	deviceId() Returns device ID of this host.
String	getAnnotation(String annotationKey) Returns annotation value with a given key.
org.onosproject.net.Host	host() Returns host object of this instance.
org.onlab.packet.Ip4Address	ipAddress() Returns IP address of this instance.
boolean	isAdditionalInstance() Returns if the instance is original instance or additional one.
org.onlab.packet.MacAddress	mac() Returns MAC address of this instance.
NetworkId	netId() Returns network ID of a given host.
ServiceNetwork.NetworkType	netType() Returns network type of a given host.
static Instance	of(org.onosproject.net.Host host) Returns new instance.
PortId	portId() Returns port ID of a given host.
org.onosproject.net.PortNumber	portNumber() Returns the port number where this host is.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

NETWORK_ID

public static final String NETWORK_ID

See Also:

Constant Field Values

NETWORK_TYPE

public static final String NETWORK_TYPE

See Also:

Constant Field Values

PORT_ID

public static final String PORT_ID

See Also:

Constant Field Values

ORIGINAL_HOST_ID

public static final String ORIGINAL_HOST_ID

See Also:

Constant Field Values

CREATE_TIME

public static final String CREATE_TIME

See Also:

Constant Field Values

Method Detail

host

public org.onosproject.net.Host host()

Returns host object of this instance.

Returns:

host

of

public static Instance of(org.onosproject.net.Host host)

Returns new instance.

Parameters:

host - host object of this instance

Returns:

instance

netId

public NetworkId netId()

Returns network ID of a given host.

Returns:

network id

netType

public ServiceNetwork.NetworkType netType()

Returns network type of a given host.

Returns:

network type

portId

public PortId portId()

Returns port ID of a given host.

Returns:

port id

isAdditionalInstance

public boolean isAdditionalInstance()

Returns if the instance is original instance or additional one.

Returns:

true if it's additional instance; false otherwise

mac

public org.onlab.packet.MacAddress mac()

Returns MAC address of this instance.

Returns:

mac address

ipAddress

public org.onlab.packet.Ip4Address ipAddress()

Returns IP address of this instance.

Returns:

ip address

deviceId

public org.onosproject.net.DeviceId deviceId()

Returns device ID of this host.

Returns:

device id

portNumber

public org.onosproject.net.PortNumber portNumber()

Returns the port number where this host is.

Returns:

port number

getAnnotation

public String getAnnotation(String annotationKey)

Returns annotation value with a given key.

Parameters:

annotationKey - annotation key

Returns:

annotation value

toString

public String toString()

Overrides:

toString in class Object