usr.interactor

Class RouterInteractor

java.lang.Object

usr.interactor.RouterInteractor

public class RouterInteractor
extends java.lang.Object

This class implements the REST protocol and acts as a client for interacting with the ManagementConsole of a Router.

Constructor Summary

Constructors

Constructor and Description
RouterInteractor(java.net.InetAddress addr, int port) Constructor for a MCRP connection to the ManagementConsole of a router.
RouterInteractor(java.lang.String addr, int port) Constructor for a MCRP connection to the ManagementConsole of a router.

Method Summary

Methods

Modifier and Type	Method and Description
java.util.List<java.lang.String>	appList() List all app APP_LIST
us.monoid.json.JSONObject	appStart(java.lang.String className, java.lang.String[] args) Start an app.
us.monoid.json.JSONObject	appStop(java.lang.String appName) Stop an app APP_STOP app_name
us.monoid.json.JSONObject	createConnection(java.lang.String address) Create a new router-to-router data connection to another router.
us.monoid.json.JSONObject	createConnection(java.lang.String address, int weight) Create a new router-to-router data connection to another router.
us.monoid.json.JSONObject	createConnection(java.lang.String address, int weight, java.lang.String name) Create a new router-to-router data connection to another router.
us.monoid.json.JSONObject	endLink(java.lang.String spec) End the link from this router to the router with a given spec
Address	getAddress() Get the address of the router.
java.lang.String	getConnectionPort() Get the port number to connect to on the router in order to make a new router-to-router data connection.
java.lang.String	getManagementConsoleAddress() Get the address of the Management Console as hostname:port
java.lang.String	getManagementConsolePort() Get the port number of the Management Console
java.lang.String	getName() Get the name of the router.
java.util.List<java.lang.String>	getNetIFStats() Get the NetIF stats from a Router.
int	getPort() Get the port this RouterInteractor is connecting to
java.lang.String	getPortAddress(java.lang.String port) Get the address of a port on the router.
java.lang.String	getPortName(java.lang.String port) Get the name of a port on the router.
java.lang.String	getPortRemoteAddress(java.lang.String port) Get the address of a remote router of a port on the router.
java.lang.String	getPortRemoteRouterName(java.lang.String port) Get the name of a remote router of a port on the router.
java.lang.String	getPortWeight(java.lang.String port) Get the weight of a port on the router.
java.util.List<java.lang.String>	getSocketStats() Get the socket stats from a Router.
RouterInteractor	incomingConnection(java.lang.String connectionID, java.lang.String name, Address addr, int weight, int port) Tell the router there has been an incoming connection on the router-to-router port.
java.util.List<java.lang.String>	listConnections() List all the router-to-router connections that the router has.
RouterInteractor	monitoringStart(java.net.InetSocketAddress addr, int howOften) Monitoring Start.
RouterInteractor	monitoringStop() Monitoring Stop
RouterInteractor	quit() Quit talking to the router Close a connection to the ManagementConsole of the router.
boolean	routerOK() Check router is responding
RouterInteractor	setAddress(Address addr) Set the global address of the router.
RouterInteractor	setAP(int GID, int APGID) Send a message to a local controller intended for a router to set its status as an aggregation point
RouterInteractor	setConfigString(java.lang.String config) Set the configuration string for a router
us.monoid.json.JSONObject	setLinkWeight(java.lang.String spec, int weight) Set the link weight from this router to the router with a given spec
RouterInteractor	setName(java.lang.String name) Set the name of the router.
RouterInteractor	setPortAddress(java.lang.String port, java.lang.String type, java.lang.String addr) Set the address of a port on the router.
RouterInteractor	setPortWeight(java.lang.String port, java.lang.String weight) Set the weight of a port on the router.
java.lang.Boolean	shutDown() Shutdown the Router we are interacting with.

Methods inherited from class java.lang.Object

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

Constructor Detail

RouterInteractor

public RouterInteractor(java.lang.String addr,
                int port)
                 throws java.net.UnknownHostException,
                        java.io.IOException

Constructor for a MCRP connection to the ManagementConsole of a router.

Parameters:

addr - the name of the host

port - the port the server is listening on

Throws:

java.net.UnknownHostException

java.io.IOException

RouterInteractor

public RouterInteractor(java.net.InetAddress addr,
                int port)
                 throws java.net.UnknownHostException,
                        java.io.IOException

Constructor for a MCRP connection to the ManagementConsole of a router.

Parameters:

addr - the InetAddress of the host

port - the port the server is listening on

Throws:

java.net.UnknownHostException

java.io.IOException

Method Detail

getPort

public int getPort()

Get the port this RouterInteractor is connecting to

quit

public RouterInteractor quit()
                      throws java.io.IOException,
                             us.monoid.json.JSONException

Quit talking to the router Close a connection to the ManagementConsole of the router.

Throws:

java.io.IOException

us.monoid.json.JSONException

getName

public java.lang.String getName()
                         throws java.io.IOException,
                                us.monoid.json.JSONException

Get the name of the router.

Throws:

java.io.IOException

us.monoid.json.JSONException

setName

public RouterInteractor setName(java.lang.String name)
                         throws java.io.IOException,
                                us.monoid.json.JSONException

Set the name of the router.

Parameters:

name - the new name of the router

Throws:

java.io.IOException

us.monoid.json.JSONException

getAddress

public Address getAddress()
                   throws java.io.IOException,
                          us.monoid.json.JSONException

Get the address of the router.

Throws:

java.io.IOException

us.monoid.json.JSONException

setAddress

public RouterInteractor setAddress(Address addr)
                            throws java.io.IOException,
                                   us.monoid.json.JSONException

Set the global address of the router.

Parameters:

addr - the address of the router

Throws:

java.io.IOException

us.monoid.json.JSONException

getManagementConsoleAddress

public java.lang.String getManagementConsoleAddress()
                                             throws java.io.IOException

Get the address of the Management Console as hostname:port

Throws:

java.io.IOException

getManagementConsolePort

public java.lang.String getManagementConsolePort()
                                          throws java.io.IOException

Get the port number of the Management Console

Throws:

java.io.IOException

getConnectionPort

public java.lang.String getConnectionPort()
                                   throws java.io.IOException,
                                          us.monoid.json.JSONException

Get the port number to connect to on the router in order to make a new router-to-router data connection.

Throws:

java.io.IOException

us.monoid.json.JSONException

getPortName

public java.lang.String getPortName(java.lang.String port)
                             throws java.io.IOException,
                                    us.monoid.json.JSONException

Get the name of a port on the router.

Parameters:

port - the port name

Throws:

java.io.IOException

us.monoid.json.JSONException

getPortRemoteRouterName

public java.lang.String getPortRemoteRouterName(java.lang.String port)
                                         throws java.io.IOException,
                                                us.monoid.json.JSONException

Get the name of a remote router of a port on the router.

Parameters:

port - the port name

Throws:

java.io.IOException

us.monoid.json.JSONException

getPortRemoteAddress

public java.lang.String getPortRemoteAddress(java.lang.String port)
                                      throws java.io.IOException,
                                             us.monoid.json.JSONException

Get the address of a remote router of a port on the router.

Parameters:

port - the port name

Throws:

java.io.IOException

us.monoid.json.JSONException

getPortAddress

public java.lang.String getPortAddress(java.lang.String port)
                                throws java.io.IOException,
                                       us.monoid.json.JSONException

Get the address of a port on the router.

Parameters:

port - the port name

Throws:

java.io.IOException

us.monoid.json.JSONException

setPortAddress

public RouterInteractor setPortAddress(java.lang.String port,
                              java.lang.String type,
                              java.lang.String addr)
                                throws java.io.IOException,
                                       us.monoid.json.JSONException

Set the address of a port on the router. Need to specify the address type and address value.

Parameters:

port - the port name

addr - the value for the address

Throws:

java.io.IOException

us.monoid.json.JSONException

getPortWeight

public java.lang.String getPortWeight(java.lang.String port)
                               throws java.io.IOException,
                                      us.monoid.json.JSONException

Get the weight of a port on the router.

Parameters:

port - the port name

Throws:

java.io.IOException

us.monoid.json.JSONException

setPortWeight

public RouterInteractor setPortWeight(java.lang.String port,
                             java.lang.String weight)
                               throws java.io.IOException,
                                      us.monoid.json.JSONException

Set the weight of a port on the router. Need to specify the weight type and weight value.

Parameters:

port - the port name

weight - the value for the weight

Throws:

java.io.IOException

us.monoid.json.JSONException

incomingConnection

public RouterInteractor incomingConnection(java.lang.String connectionID,
                                  java.lang.String name,
                                  Address addr,
                                  int weight,
                                  int port)
                                    throws java.io.IOException,
                                           us.monoid.json.JSONException

Tell the router there has been an incoming connection on the router-to-router port.

Parameters:

connectionID - the name for the incoming connection

name - the name of the router making the connection

addr - the address of the router making the connection

weight - the weight of the connection

port - the port number

Throws:

java.io.IOException

us.monoid.json.JSONException

listConnections

public java.util.List<java.lang.String> listConnections()
                                                 throws java.io.IOException,
                                                        us.monoid.json.JSONException

List all the router-to-router connections that the router has.

Throws:

java.io.IOException

us.monoid.json.JSONException

appStart

public us.monoid.json.JSONObject appStart(java.lang.String className,
                                 java.lang.String[] args)
                                   throws java.io.IOException,
                                          us.monoid.json.JSONException

Start an app. APP_START classname args

Throws:

java.io.IOException

us.monoid.json.JSONException

appStop

public us.monoid.json.JSONObject appStop(java.lang.String appName)
                                  throws java.io.IOException,
                                         us.monoid.json.JSONException

Stop an app APP_STOP app_name

Throws:

java.io.IOException

us.monoid.json.JSONException

appList

public java.util.List<java.lang.String> appList()
                                         throws java.io.IOException,
                                                us.monoid.json.JSONException

List all app APP_LIST

Throws:

java.io.IOException

us.monoid.json.JSONException

createConnection

public us.monoid.json.JSONObject createConnection(java.lang.String address)
                                           throws java.io.IOException,
                                                  us.monoid.json.JSONException

Create a new router-to-router data connection to another router. CREATE_CONNECTION ip_addr/port connection_weight - create a new network interface to a router on the address ip_addr/port

Returns:

the name of the created connection, e.g. /Router-28/Connection-1

Throws:

java.io.IOException

us.monoid.json.JSONException

createConnection

public us.monoid.json.JSONObject createConnection(java.lang.String address,
                                         int weight)
                                           throws java.io.IOException,
                                                  us.monoid.json.JSONException

Create a new router-to-router data connection to another router. CREATE_CONNECTION ip_addr/port connection_weight - create a new network interface to a router on the address ip_addr/port with a connection weight of connection_weight

Returns:

the name of the created connection, e.g. /Router-28/Connection-1

Throws:

java.io.IOException

us.monoid.json.JSONException

createConnection

public us.monoid.json.JSONObject createConnection(java.lang.String address,
                                         int weight,
                                         java.lang.String name)
                                           throws java.io.IOException,
                                                  us.monoid.json.JSONException

Create a new router-to-router data connection to another router. CREATE_CONNECTION ip_addr/port connection_weight connection_name - create a new network interface to a router on the address ip_addr/port with a connection weight of connection_weight and a name of connection_name

Returns:

the name of the created connection, i.e. connection_name

Throws:

java.io.IOException

us.monoid.json.JSONException

endLink

public us.monoid.json.JSONObject endLink(java.lang.String spec)
                                  throws java.io.IOException,
                                         us.monoid.json.JSONException

End the link from this router to the router with a given spec

Throws:

java.io.IOException

us.monoid.json.JSONException

setLinkWeight

public us.monoid.json.JSONObject setLinkWeight(java.lang.String spec,
                                      int weight)
                                        throws java.io.IOException,
                                               us.monoid.json.JSONException

Set the link weight from this router to the router with a given spec

Throws:

java.io.IOException

us.monoid.json.JSONException

setConfigString

public RouterInteractor setConfigString(java.lang.String config)
                                 throws java.io.IOException,
                                        us.monoid.json.JSONException

Set the configuration string for a router

Throws:

java.io.IOException

us.monoid.json.JSONException

setAP

public RouterInteractor setAP(int GID,
                     int APGID)
                       throws java.io.IOException,
                              us.monoid.json.JSONException

Send a message to a local controller intended for a router to set its status as an aggregation point

Throws:

java.io.IOException

us.monoid.json.JSONException

getNetIFStats

public java.util.List<java.lang.String> getNetIFStats()
                                               throws java.io.IOException,
                                                      us.monoid.json.JSONException

Get the NetIF stats from a Router.

Throws:

java.io.IOException

us.monoid.json.JSONException

getSocketStats

public java.util.List<java.lang.String> getSocketStats()
                                                throws java.io.IOException,
                                                       us.monoid.json.JSONException

Get the socket stats from a Router.

Throws:

java.io.IOException

us.monoid.json.JSONException

monitoringStart

public RouterInteractor monitoringStart(java.net.InetSocketAddress addr,
                               int howOften)
                                 throws java.io.IOException,
                                        us.monoid.json.JSONException

Monitoring Start.

Parameters:

addr - The InetSocketAddress of the Monitoring data consumer

howOften - How many seconds between measurements

Throws:

java.io.IOException

us.monoid.json.JSONException

monitoringStop

public RouterInteractor monitoringStop()
                                throws java.io.IOException,
                                       us.monoid.json.JSONException

Monitoring Stop

Throws:

java.io.IOException

us.monoid.json.JSONException

routerOK

public boolean routerOK()
                 throws java.io.IOException,
                        us.monoid.json.JSONException

Check router is responding

Throws:

java.io.IOException

us.monoid.json.JSONException

shutDown

public java.lang.Boolean shutDown()
                           throws java.io.IOException,
                                  us.monoid.json.JSONException

Shutdown the Router we are interacting with.

Throws:

java.io.IOException

us.monoid.json.JSONException