org.onosproject.rest.resources

Class TenantWebResource

java.lang.Object

org.onlab.rest.BaseResource

org.onosproject.rest.AbstractWebResource

org.onosproject.rest.resources.TenantWebResource

All Implemented Interfaces:

org.onosproject.codec.CodecContext

@Path(value="tenants")
public class TenantWebResource
extends org.onosproject.rest.AbstractWebResource

Query and manage tenants of virtual networks.

Constructor Summary

Constructors

Constructor and Description
TenantWebResource()

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	addTenantId(InputStream stream) Creates a tenant with the given tenant identifier.
protected static org.onosproject.incubator.net.virtual.TenantId	getExistingTenantId(org.onosproject.incubator.net.virtual.VirtualNetworkAdminService vnetAdminSvc, org.onosproject.incubator.net.virtual.TenantId tidIn) Get the matching tenant identifier from existing tenant identifiers in system.
javax.ws.rs.core.Response	getVirtualNetworkTenantIds() Returns all tenant identifiers.
javax.ws.rs.core.Response	removeTenantId(String tenantId) Removes the specified tenant with the specified tenant identifier.

Methods inherited from class org.onosproject.rest.AbstractWebResource

codec, encodeArray, getService, mapper, newArray, newObject

Methods inherited from class org.onlab.rest.BaseResource

get, ok

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.onosproject.codec.CodecContext

decode, encode

Constructor Detail

TenantWebResource

public TenantWebResource()

Method Detail

getVirtualNetworkTenantIds

@GET
 @Produces(value="application/json")
public javax.ws.rs.core.Response getVirtualNetworkTenantIds()

Returns all tenant identifiers.

Returns:

200 OK with set of tenant identifiers

onos model

TenantIds

addTenantId

@POST
 @Consumes(value="application/json")
 @Produces(value="application/json")
public javax.ws.rs.core.Response addTenantId(InputStream stream)

Creates a tenant with the given tenant identifier.

Parameters:

stream - TenantId JSON stream

Returns:

status of the request - CREATED if the JSON is correct, BAD_REQUEST if the JSON is invalid

onos model

TenantId

removeTenantId

@DELETE
 @Path(value="{tenantId}")
public javax.ws.rs.core.Response removeTenantId(@PathParam(value="tenantId")
                                                                                   String tenantId)

Removes the specified tenant with the specified tenant identifier.

Parameters:

tenantId - tenant identifier

Returns:

204 NO CONTENT

getExistingTenantId

protected static org.onosproject.incubator.net.virtual.TenantId getExistingTenantId(org.onosproject.incubator.net.virtual.VirtualNetworkAdminService vnetAdminSvc,
                                                                                    org.onosproject.incubator.net.virtual.TenantId tidIn)

Get the matching tenant identifier from existing tenant identifiers in system.

Parameters:

vnetAdminSvc - virtual network administration service

tidIn - tenant identifier

Returns:

TenantId