org.onosproject.rest.resources

Class ClusterWebResource

java.lang.Object

org.onlab.rest.BaseResource

org.onosproject.rest.AbstractWebResource

org.onosproject.rest.resources.ClusterWebResource

All Implemented Interfaces:

org.onosproject.codec.CodecContext

@Path(value="cluster")
public class ClusterWebResource
extends org.onosproject.rest.AbstractWebResource

Manage cluster of ONOS instances.

Constructor Summary

Constructors

Constructor and Description
ClusterWebResource()

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	formCluster(InputStream config) Forms cluster of ONOS instances.
javax.ws.rs.core.Response	getClusterNode(String id) Get cluster node details.
javax.ws.rs.core.Response	getClusterNodes() Get all cluster nodes.

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

ClusterWebResource

public ClusterWebResource()

Method Detail

getClusterNodes

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

Get all cluster nodes. Returns array of all cluster nodes.

Returns:

200 OK with a collection of cluster nodes

onos model

Cluster

getClusterNode

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

Get cluster node details. Returns details of the specified cluster node.

Parameters:

id - cluster node identifier

Returns:

200 OK with a cluster node

onos model

ClusterNode

formCluster

@POST
 @Path(value="configuration")
 @Produces(value="application/json")
public javax.ws.rs.core.Response formCluster(InputStream config)
                                                                                                               throws IOException

Forms cluster of ONOS instances. Forms ONOS cluster using the uploaded JSON definition.

Parameters:

config - cluster definition

Returns:

200 OK

Throws:

IOException - to signify bad request

onos model

ClusterPost