planetLabAPI
Class PlanetLabXmlRpcCaller

java.lang.Object
  planetLabAPI.PlanetLabXmlRpcCaller

public class PlanetLabXmlRpcCaller
extends java.lang.Object

This class is the interface to the PlanetLab Central API The API functions are called through xml-rpc calls over an ssl connection

Author:

Leo Bosnjak

Nested Class Summary

class

PlanetLabXmlRpcCaller.MyTypeFactory This class handles "nil" values returned by the PLC xml rpc server.

Field Summary

private java.util.Map<java.lang.String,java.lang.String>	authMap
private org.apache.xmlrpc.client.XmlRpcClient	client
static java.lang.String	serverPage

Constructor Summary

PlanetLabXmlRpcCaller()
Constructs the object and initializes the XmlRpcClient with the appropriate settings.

Method Summary

boolean	AddNodesToSlice(java.lang.String sliceName, int[] nodeIds) adds nodes to a slice see: https://www.planet-lab.org/doc/plc_api#AddSliceToNodes
boolean	AddNodesToSlice(java.lang.String sliceName, java.lang.String[] nodeHostnames) adds nodes to a slice see: https://www.planet-lab.org/doc/plc_api#AddSliceToNodes
private void	checkAuthenticationData()
boolean	DeleteNodesFromSlice(java.lang.String sliceName, int[] nodeIds) deletes nodes from a slice see: https://www.planet-lab.org/doc/plc_api#DeleteSliceFromNodes
java.lang.Object	execute(java.lang.String function, java.lang.Object[] params) executes a xml-rpc
java.lang.Object[]	getAllNodes(java.lang.String[] returnFields) gets the Data of all nodes by calling GetNodes() from PlanetLab Central API see: https://www.planet-lab.org/doc/plc_api#GetNodes
boolean	GetNodeDetails(java.lang.String sliceName, int[] nodeIds) adds nodes to a slice see: https://www.planet-lab.org/doc/plc_api#AddSliceToNodes
java.lang.Object[]	getNodeNetworks(int nodenetworkId, java.lang.String[] returnFields) Gets the information about a network interface of a node by calling GetNodeNetworks() from PlanetLab Central API see: https://www.planet-lab.org/doc/plc_api#GetNodeNetworks
java.lang.Object[]	getNodesByHostname(java.lang.String[] hostnames, java.lang.String[] returnFields) gets the Data of some nodes by calling GetNodes() from PlanetLab Central API see: https://www.planet-lab.org/doc/plc_api#GetNodes
java.lang.Object[]	getNodesById(int[] nodeIds, java.lang.String[] returnFields) gets the Data of some nodes by calling GetNodes() from PlanetLab Central API see: https://www.planet-lab.org/doc/plc_api#GetNodes
java.lang.Object[]	getSitesById(int[] siteIds, java.lang.String[] returnFields) gets the Data of some sites by calling GetSites() from PlanetLab Central API see: https://www.planet-lab.org/doc/plc_api#GetSites
java.util.Map<java.lang.String,java.lang.Object[]>	getSliceAttribsByName(java.lang.String sliceName, java.lang.String[] returnFields) gets the Data of one slice by calling GetSlices() from PlanetLab Central API see: https://www.planet-lab.org/doc/plc_api#GetSlices
static void	main(java.lang.String[] args) The main method can be used for testing the connection to the PLCAPI without the need to start the whole software.
void	setAuthenticationData(java.lang.String userName, java.lang.String password, java.lang.String role) Sets the authentication data needed for PLC-API calls.

Methods inherited from class java.lang.Object

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

Field Detail

client

private org.apache.xmlrpc.client.XmlRpcClient client

serverPage

public static java.lang.String serverPage

authMap

private java.util.Map<java.lang.String,java.lang.String> authMap

Constructor Detail

PlanetLabXmlRpcCaller

public PlanetLabXmlRpcCaller()
                      throws java.net.MalformedURLException

Constructs the object and initializes the XmlRpcClient with the appropriate settings.

Throws:

java.net.MalformedURLException

Method Detail

setAuthenticationData

public void setAuthenticationData(java.lang.String userName,
                                  java.lang.String password,
                                  java.lang.String role)

Sets the authentication data needed for PLC-API calls.

Parameters:

userName - the e-mail address of a planetlab user

password -

role - one of admin, pi, user, node

execute

public java.lang.Object execute(java.lang.String function,
                                java.lang.Object[] params)
                         throws org.apache.xmlrpc.XmlRpcException,
                                AuthDataNotSetException

executes a xml-rpc

Parameters:

function - - name of the function to execute

params - - parameters to pass the function

Returns:

- return value of the function

Throws:

org.apache.xmlrpc.XmlRpcException

AuthDataNotSetException - - if the authentication data was not set before call

checkAuthenticationData

private void checkAuthenticationData()
                              throws AuthDataNotSetException

Throws:

AuthDataNotSetException

getSliceAttribsByName

public java.util.Map<java.lang.String,java.lang.Object[]> getSliceAttribsByName(java.lang.String sliceName,
                                                                                java.lang.String[] returnFields)
                                                                         throws org.apache.xmlrpc.XmlRpcException,
                                                                                AuthDataNotSetException

gets the Data of one slice by calling GetSlices() from PlanetLab Central API see: https://www.planet-lab.org/doc/plc_api#GetSlices

Parameters:

sliceName - - name of the slice you want some infos of

returnFields - - the fields you're interested in

Returns:

- a Map containing the returnFields if successful, null otherwise

Throws:

org.apache.xmlrpc.XmlRpcException

AuthDataNotSetException

getNodesById

public java.lang.Object[] getNodesById(int[] nodeIds,
                                       java.lang.String[] returnFields)
                                throws org.apache.xmlrpc.XmlRpcException,
                                       AuthDataNotSetException

gets the Data of some nodes by calling GetNodes() from PlanetLab Central API see: https://www.planet-lab.org/doc/plc_api#GetNodes

Parameters:

nodeIds - - ids of the nodes you want some infos of

returnFields - - the fields you're interested in

Returns:

- an array of Map containing the returnFields of each node if successful, null otherwise

Throws:

org.apache.xmlrpc.XmlRpcException

AuthDataNotSetException

getNodesByHostname

public java.lang.Object[] getNodesByHostname(java.lang.String[] hostnames,
                                             java.lang.String[] returnFields)
                                      throws org.apache.xmlrpc.XmlRpcException,
                                             AuthDataNotSetException

gets the Data of some nodes by calling GetNodes() from PlanetLab Central API see: https://www.planet-lab.org/doc/plc_api#GetNodes

Parameters:

hostnames - - hostnames of the nodes you want some infos of

returnFields - - the fields you're interested in

Returns:

- an array of Map containing the returnFields of each node if successful, null otherwise

Throws:

org.apache.xmlrpc.XmlRpcException

AuthDataNotSetException

getNodeNetworks

public java.lang.Object[] getNodeNetworks(int nodenetworkId,
                                          java.lang.String[] returnFields)
                                   throws org.apache.xmlrpc.XmlRpcException,
                                          AuthDataNotSetException

Gets the information about a network interface of a node by calling GetNodeNetworks() from PlanetLab Central API see: https://www.planet-lab.org/doc/plc_api#GetNodeNetworks

Parameters:

nodenetworkId - - The id of the newtwork interface (can be obtained by calling GetNodes())

returnFields - - the fields you're interested in

Returns:

- an array of Map containing the returnFields of each node if successful, null otherwise

Throws:

org.apache.xmlrpc.XmlRpcException

AuthDataNotSetException

getAllNodes

public java.lang.Object[] getAllNodes(java.lang.String[] returnFields)
                               throws org.apache.xmlrpc.XmlRpcException,
                                      AuthDataNotSetException

gets the Data of all nodes by calling GetNodes() from PlanetLab Central API see: https://www.planet-lab.org/doc/plc_api#GetNodes

Parameters:

returnFields - - the fields you're interested in

Returns:

- an array of Map containing the returnFields of each node if successful, null otherwise

Throws:

org.apache.xmlrpc.XmlRpcException

AuthDataNotSetException

getSitesById

public java.lang.Object[] getSitesById(int[] siteIds,
                                       java.lang.String[] returnFields)
                                throws org.apache.xmlrpc.XmlRpcException,
                                       AuthDataNotSetException

gets the Data of some sites by calling GetSites() from PlanetLab Central API see: https://www.planet-lab.org/doc/plc_api#GetSites

Parameters:

siteIds - - ids of the sites you want some infos of

returnFields - - the fields you're interested in

Returns:

- an array of Map containing the returnFields of each site if successful, null otherwise

Throws:

org.apache.xmlrpc.XmlRpcException

AuthDataNotSetException

AddNodesToSlice

public boolean AddNodesToSlice(java.lang.String sliceName,
                               int[] nodeIds)
                        throws org.apache.xmlrpc.XmlRpcException,
                               AuthDataNotSetException

adds nodes to a slice see: https://www.planet-lab.org/doc/plc_api#AddSliceToNodes

Parameters:

sliceName - - name of the slice you want the nodes to be added to

nodeIds - - ids of the nodes you want to add

Returns:

- true if successful, false otherwise

Throws:

org.apache.xmlrpc.XmlRpcException

AuthDataNotSetException

AddNodesToSlice

public boolean AddNodesToSlice(java.lang.String sliceName,
                               java.lang.String[] nodeHostnames)
                        throws org.apache.xmlrpc.XmlRpcException,
                               AuthDataNotSetException

adds nodes to a slice see: https://www.planet-lab.org/doc/plc_api#AddSliceToNodes

Parameters:

sliceName - - name of the slice you want the nodes to be added to

nodeHostnames - - hostnames of the nodes you want to add

Returns:

- true if successful, false otherwise

Throws:

org.apache.xmlrpc.XmlRpcException

AuthDataNotSetException

DeleteNodesFromSlice

public boolean DeleteNodesFromSlice(java.lang.String sliceName,
                                    int[] nodeIds)
                             throws org.apache.xmlrpc.XmlRpcException,
                                    AuthDataNotSetException

deletes nodes from a slice see: https://www.planet-lab.org/doc/plc_api#DeleteSliceFromNodes

Parameters:

sliceName - - name of the slice you want the nodes to be deleted from

nodeIds - - ids of the nodes you want to delete

Returns:

- true if successful, false otherwise

Throws:

org.apache.xmlrpc.XmlRpcException

AuthDataNotSetException

GetNodeDetails

public boolean GetNodeDetails(java.lang.String sliceName,
                              int[] nodeIds)
                       throws org.apache.xmlrpc.XmlRpcException,
                              AuthDataNotSetException

adds nodes to a slice see: https://www.planet-lab.org/doc/plc_api#AddSliceToNodes

Parameters:

sliceName - - name of the slice you want the nodes to be added to

nodeIds - - ids of the nodes you want to add

Returns:

- true if successful, false otherwise

Throws:

org.apache.xmlrpc.XmlRpcException

AuthDataNotSetException

main

public static void main(java.lang.String[] args)

The main method can be used for testing the connection to the PLCAPI without the need to start the whole software.

Parameters:

args - - server-address, username and password may be passed. If not, they will be obtained interactively.