org.onosproject.castor

Class CastorWebResource

java.lang.Object

org.onlab.rest.BaseResource

org.onosproject.rest.AbstractWebResource

org.onosproject.castor.CastorWebResource

All Implemented Interfaces:

CodecContext

@Path(value="castor")
public class CastorWebResource
extends AbstractWebResource

The Web Resource for REST API calls to the Castor application.

Constructor Summary

Constructors

Constructor and Description
CastorWebResource()

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	addPeer(String incomingData) Add a Peer.
javax.ws.rs.core.Response	addRouteServer(String incomingData) Add router server.
javax.ws.rs.core.Response	deletePeer(String incomingData) Delete a Peer.
javax.ws.rs.core.Response	getMac() Get the present ARP Mapping.
javax.ws.rs.core.Response	getPeers() Get list of added peers.

Methods inherited from class org.onosproject.rest.AbstractWebResource

codec, encodeArray, getService, mapper, newArray, newObject

Methods inherited from class org.onlab.rest.BaseResource

get, ok, setServiceDirectory

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

CastorWebResource

public CastorWebResource()

Method Detail

getMac

@GET
 @Path(value="mac-map")
public javax.ws.rs.core.Response getMac()

Get the present ARP Mapping. Use this to get the present ARP map stored by Castor

Returns:

200 OK

getPeers

@GET
 @Path(value="get-peers")
public javax.ws.rs.core.Response getPeers()

Get list of added peers. List of peers added.

Returns:

200 OK

addPeer

@POST
 @Path(value="add-peer")
 @Consumes(value="application/json")
public javax.ws.rs.core.Response addPeer(String incomingData)

Add a Peer. Use this to add a Customer or a BGP Peer

Parameters:

incomingData - json Data

Returns:

200 OK

"onos model"

PeerModel

deletePeer

@POST
 @Path(value="delete-peer")
 @Consumes(value="application/json")
public javax.ws.rs.core.Response deletePeer(String incomingData)

Delete a Peer. Use this to delete a Peer. IpAddress should match as entered while adding.

Parameters:

incomingData - json Data

Returns:

200 OK

"onos model"

PeerModel

addRouteServer

@POST
 @Path(value="route-server")
 @Consumes(value="application/json")
public javax.ws.rs.core.Response addRouteServer(String incomingData)

Add router server. Use this to add to add Route Servers for initializing

Parameters:

incomingData - json Data

Returns:

200 OK

"onos model"

PeerModel