org.opencord.cordvtn.api

Class Instance

java.lang.Object

org.opencord.cordvtn.api.Instance

public final class Instance
extends Object

Provides methods to help to handle network service instance.

Field Summary

Fields

Modifier and Type	Field and Description
static String	CREATE_TIME
static String	NESTED_INSTANCE
static String	PORT_ID
static String	SERVICE_ID
static String	SERVICE_TYPE
static String	TRUE

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	isNestedInstance() Returns if the instance is nested container or not.
org.onlab.packet.MacAddress	mac() Returns MAC address of this instance.
static Instance	of(org.onosproject.net.Host host) Returns new instance.
org.onosproject.xosclient.api.VtnPortId	portId() Returns port ID of a given host.
org.onosproject.net.PortNumber	portNumber() Returns the port number where this host is.
org.onosproject.xosclient.api.VtnServiceId	serviceId() Returns service ID of a given host.
org.onosproject.xosclient.api.VtnServiceApi.ServiceType	serviceType() Returns service type of a given host.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

SERVICE_ID

public static final String SERVICE_ID

See Also:

Constant Field Values

SERVICE_TYPE

public static final String SERVICE_TYPE

See Also:

Constant Field Values

PORT_ID

public static final String PORT_ID

See Also:

Constant Field Values

CREATE_TIME

public static final String CREATE_TIME

See Also:

Constant Field Values

NESTED_INSTANCE

public static final String NESTED_INSTANCE

See Also:

Constant Field Values

TRUE

public static final String TRUE

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

serviceId

public org.onosproject.xosclient.api.VtnServiceId serviceId()

Returns service ID of a given host.

Returns:

vtn service id

serviceType

public org.onosproject.xosclient.api.VtnServiceApi.ServiceType serviceType()

Returns service type of a given host.

Returns:

vtn service type

portId

public org.onosproject.xosclient.api.VtnPortId portId()

Returns port ID of a given host.

Returns:

vtn port id

isNestedInstance

public boolean isNestedInstance()

Returns if the instance is nested container or not.

Returns:

true if it's nested container; 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