org.onosproject.xosclient.impl

Class DefaultVtnPortApi

java.lang.Object

org.onosproject.xosclient.impl.XosApi

org.onosproject.xosclient.impl.DefaultVtnPortApi

All Implemented Interfaces:

VtnPortApi

public final class DefaultVtnPortApi
extends XosApi
implements VtnPortApi

Provides CORD VTN port APIs.

Field Summary

Fields inherited from class org.onosproject.xosclient.impl.XosApi

access, baseUrl, client, EMPTY_JSON_STRING, EMPTY_STRING

Constructor Summary

Constructors

Constructor and Description
DefaultVtnPortApi(String baseUrl, XosAccess access) Default constructor.

Method Summary

Modifier and Type	Method and Description
VtnPort	vtnPort(String portName, OpenStackAccess osAccess) Returns port information from OpenStack with port name.
VtnPort	vtnPort(VtnPortId portId) Returns port information with port id.
VtnPort	vtnPort(VtnPortId portId, OpenStackAccess osAccess) Returns port information from OpenStack with port id.
Set<VtnPort>	vtnPorts() Returns all ports.
Set<VtnPort>	vtnPorts(VtnServiceId serviceId) Returns all ports with a given service.

Methods inherited from class org.onosproject.xosclient.impl.XosApi

access, baseUrl, restGet

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultVtnPortApi

public DefaultVtnPortApi(String baseUrl,
                         XosAccess access)

Default constructor.

Parameters:

baseUrl - base url

access - xos access

Method Detail

vtnPorts

public Set<VtnPort> vtnPorts()

Description copied from interface: VtnPortApi

Returns all ports.

Specified by:

vtnPorts in interface VtnPortApi

Returns:

set of ports

vtnPorts

public Set<VtnPort> vtnPorts(VtnServiceId serviceId)

Description copied from interface: VtnPortApi

Returns all ports with a given service.

Specified by:

vtnPorts in interface VtnPortApi

Parameters:

serviceId - service id

Returns:

set of ports

vtnPort

public VtnPort vtnPort(VtnPortId portId)

Description copied from interface: VtnPortApi

Returns port information with port id.

Specified by:

vtnPort in interface VtnPortApi

Parameters:

portId - port id

Returns:

vtn port; null if it fails to get port information

vtnPort

public VtnPort vtnPort(String portName,
                       OpenStackAccess osAccess)

Description copied from interface: VtnPortApi

Returns port information from OpenStack with port name.

Specified by:

vtnPort in interface VtnPortApi

Parameters:

portName - port name

osAccess - OpenStack address for OS access

Returns:

vtn port; null if it fails to get port information

vtnPort

public VtnPort vtnPort(VtnPortId portId,
                       OpenStackAccess osAccess)

Description copied from interface: VtnPortApi

Returns port information from OpenStack with port id.

Specified by:

vtnPort in interface VtnPortApi

Parameters:

portId - port id

osAccess - OpenStack address for OS access

Returns:

vtn port; null if it fails to get port information