org.onosproject.rest.resources

Class MastershipWebResource

java.lang.Object

org.onlab.rest.BaseResource

org.onosproject.rest.AbstractWebResource

org.onosproject.rest.resources.MastershipWebResource

All Implemented Interfaces:

org.onosproject.codec.CodecContext

@Path(value="mastership")
public final class MastershipWebResource
extends org.onosproject.rest.AbstractWebResource

Manage the mastership of ONOS instances.

Constructor Summary

Constructors

Constructor and Description
MastershipWebResource()

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	balanceRoles() Balances the mastership to be shared as evenly as possibly by all online instances.
javax.ws.rs.core.Response	getDeviceOf(String nodeId) Returns the devices for which a controller is master.
javax.ws.rs.core.Response	getLocalRole(String deviceId) Returns the role of the local node for the specified device.
javax.ws.rs.core.Response	getMasterFor(String deviceId) Returns the current master for a given device.
javax.ws.rs.core.Response	getNodesFor(String deviceId) Returns controllers connected to a given device, in order of preference.
javax.ws.rs.core.Response	relinquishMastership(String deviceId) Abandons mastership of the specified device on the local node thus forcing selection of a new master.
javax.ws.rs.core.Response	requestRoleFor(String deviceId) Returns the mastership status of the local controller for a given device forcing master selection if necessary.
javax.ws.rs.core.Response	setRole(InputStream stream) Applies the current mastership role for the specified 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

MastershipWebResource

public MastershipWebResource()

Method Detail

getLocalRole

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

Returns the role of the local node for the specified device.

Parameters:

deviceId - device identifier

Returns:

200 OK with role of the current node

onos model

MastershipRole

getMasterFor

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

Returns the current master for a given device.

Parameters:

deviceId - device identifier

Returns:

200 OK with the identifier of the master controller for the device

onos model

NodeId

getNodesFor

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

Returns controllers connected to a given device, in order of preference. The first entry in the list is the current master.

Parameters:

deviceId - device identifier

Returns:

200 OK with a list of controller identifiers

onos model

RoleInfo

getDeviceOf

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

Returns the devices for which a controller is master.

Parameters:

nodeId - controller identifier

Returns:

200 OK with a set of device identifiers

onos model

DeviceIds

requestRoleFor

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

Returns the mastership status of the local controller for a given device forcing master selection if necessary.

Parameters:

deviceId - device identifier

Returns:

200 OK with the role of this controller instance

onos model

MastershipRole

relinquishMastership

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

Abandons mastership of the specified device on the local node thus forcing selection of a new master. If the local node is not a master for this device, no master selection will occur.

Parameters:

deviceId - device identifier

Returns:

status of the request - CREATED if the JSON is correct

setRole

@PUT
 @Consumes(value="application/json")
public javax.ws.rs.core.Response setRole(InputStream stream)

Applies the current mastership role for the specified device.

Parameters:

stream - JSON representation of device, node, mastership info

Returns:

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

onos model

MastershipPut

balanceRoles

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

Balances the mastership to be shared as evenly as possibly by all online instances.

Returns:

status of the request - OK if the request is successfully processed