org.onosproject.rest.resources

Class HostsWebResource

java.lang.Object

org.onlab.rest.BaseResource

org.onosproject.rest.AbstractWebResource

org.onosproject.rest.resources.HostsWebResource

All Implemented Interfaces:

org.onosproject.codec.CodecContext

@Path(value="hosts")
public class HostsWebResource
extends org.onosproject.rest.AbstractWebResource

Manage inventory of end-station hosts.

Constructor Summary

Constructors

Constructor and Description
HostsWebResource()

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	createAndAddHost(InputStream stream) Creates a new host based on JSON input and adds it to the current host inventory.
javax.ws.rs.core.Response	getHostById(String id) Get details of end-station host.
javax.ws.rs.core.Response	getHostByMacAndVlan(String mac, String vlan) Get details of end-station host with MAC/VLAN.
javax.ws.rs.core.Response	getHosts() Get all end-station hosts.
javax.ws.rs.core.Response	removeHost(String mac, String vlan) Removes infrastructure device.

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

HostsWebResource

public HostsWebResource()

Method Detail

getHosts

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

Get all end-station hosts. Returns array of all known end-station hosts.

Returns:

200 OK with array of all known end-station hosts.

onos model

Hosts

getHostById

@GET
 @Produces(value="application/json")
 @Path(value="{id}")
public javax.ws.rs.core.Response getHostById(@PathParam(value="id")
                                                                                                            String id)

Get details of end-station host. Returns detailed properties of the specified end-station host.

Parameters:

id - host identifier

Returns:

200 OK with detailed properties of the specified end-station host

onos model

Host

getHostByMacAndVlan

@GET
 @Produces(value="application/json")
 @Path(value="{mac}/{vlan}")
public javax.ws.rs.core.Response getHostByMacAndVlan(@PathParam(value="mac")
                                                                                                                            String mac,
                                                                                                                            @PathParam(value="vlan")
                                                                                                                            String vlan)

Get details of end-station host with MAC/VLAN. Returns detailed properties of the specified end-station host.

Parameters:

mac - host MAC address

vlan - host VLAN identifier

Returns:

200 OK with detailed properties of the specified end-station host

onos model

Host

createAndAddHost

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

Creates a new host based on JSON input and adds it to the current host inventory.

Parameters:

stream - input JSON

Returns:

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

onos model

HostPut

removeHost

@DELETE
 @Path(value="{mac}/{vlan}")
 @Produces(value="application/json")
public javax.ws.rs.core.Response removeHost(@PathParam(value="mac")
                                                                                                                      String mac,
                                                                                                                      @PathParam(value="vlan")
                                                                                                                      String vlan)

Removes infrastructure device. Administratively deletes the specified device from the inventory of known devices.

Parameters:

mac - host MAC address

vlan - host VLAN identifier

Returns:

204 OK

onos model

Host