xmlParsing
Class PlanetLabConfigXmlParser

java.lang.Object
  xmlParsing.PlanetLabConfigXmlParser

public class PlanetLabConfigXmlParser
extends java.lang.Object

This class parses the PlanetLabConfig.xml for the login stuff.

Author:

Leo Bosnjak

Field Summary

private org.w3c.dom.Document	document Represents the XML-DOM document
private java.lang.String	fileName The path to the configuration file
private static java.lang.String	PASSWORD_ATTRIB The XML attribute name of the ROOT_TAG which contains the PlanetLab password
private static java.lang.String	ROLE_ATTRIB The XML attribute name of the ROOT_TAG which contains the PlanetLab user role
private static java.lang.String	ROOT_TAG The name of the XML root tag which contains all other needed elements.
private static java.lang.String	SLICE_NAME_TAG The XML tag which textContent contains the name of ONE slice
private static java.lang.String	SLICE_TAG The XML tag which contains information about ONE slice
private static java.lang.String	SLICES_TAG The XML tag that contains the slices of the user
private static java.lang.String	USERNAME_ATTRIB The XML attribute name of the ROOT_TAG which contains the PlanetLab username

Constructor Summary

PlanetLabConfigXmlParser()
Construct a PlanetLabConfigXmlParser with default parameters.

PlanetLabConfigXmlParser(java.lang.String fileName)
Construct a PlanetLabConfigXmlParser with the given file.

Method Summary

private javax.xml.parsers.DocumentBuilder	createDocumentBuilder() Creates a new documentBuilder with the needed preferences
java.lang.String	getFileName() get the name of the file to be parsed
java.lang.String	getPassword() Returns the password of the PlanetLab Central API user.
java.lang.String	getRole() Returns the role of the PlanetLab Central API user.
private java.lang.String	getRootAttribute(java.lang.String attribName) Returns the value of the specified attribute name.
java.lang.String[]	getSlicenames() Returns an array containing all the slice names.
java.lang.String	getUsername() Returns the username of the PlanetLab Central API user.
static void	main(java.lang.String[] args) This method is used to test this class.
org.w3c.dom.Document	parseFile() Parse the file into an XML-DOM Document
org.w3c.dom.Document	parseFile(java.lang.String fileName) Parse the file into an XML-DOM Document using the given fileName
boolean	saveConfig() Saves the previously loaded document into the XML file.
private boolean	saveConfig(java.lang.String fileName, org.w3c.dom.Document doc) Saves XML Document into XML file.
void	setFileName(java.lang.String fileName) set the name of the file to be parsed
void	setPassword(java.lang.String password) Sets the password of the PlanetLab Central API user.
void	setRole(java.lang.String role) Sets the role of the PlanetLab Central API user.
private boolean	setRootAttribute(java.lang.String attribName, java.lang.String value) Returns the value of the specified attribute name.
void	setSlicenames(java.util.Vector<java.lang.String> slicenames) Sets the slicenames of the PlanetLab Central API user.
void	setUsername(java.lang.String username) Sets the username of the PlanetLab Central API user.

Methods inherited from class java.lang.Object

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

Field Detail

ROOT_TAG

private static final java.lang.String ROOT_TAG

The name of the XML root tag which contains all other needed elements.

See Also:

Constant Field Values

USERNAME_ATTRIB

private static final java.lang.String USERNAME_ATTRIB

The XML attribute name of the ROOT_TAG which contains the PlanetLab username

See Also:

Constant Field Values

PASSWORD_ATTRIB

private static final java.lang.String PASSWORD_ATTRIB

The XML attribute name of the ROOT_TAG which contains the PlanetLab password

See Also:

Constant Field Values

ROLE_ATTRIB

private static final java.lang.String ROLE_ATTRIB

The XML attribute name of the ROOT_TAG which contains the PlanetLab user role

See Also:

Constant Field Values

SLICES_TAG

private static final java.lang.String SLICES_TAG

The XML tag that contains the slices of the user

See Also:

Constant Field Values

SLICE_TAG

private static final java.lang.String SLICE_TAG

The XML tag which contains information about ONE slice

See Also:

Constant Field Values

SLICE_NAME_TAG

private static final java.lang.String SLICE_NAME_TAG

The XML tag which textContent contains the name of ONE slice

See Also:

Constant Field Values

document

private org.w3c.dom.Document document

Represents the XML-DOM document

fileName

private java.lang.String fileName

The path to the configuration file

Constructor Detail

PlanetLabConfigXmlParser

public PlanetLabConfigXmlParser()

Construct a PlanetLabConfigXmlParser with default parameters.

PlanetLabConfigXmlParser

public PlanetLabConfigXmlParser(java.lang.String fileName)
                         throws org.xml.sax.SAXException,
                                javax.xml.parsers.ParserConfigurationException,
                                java.io.IOException

Construct a PlanetLabConfigXmlParser with the given file. Tries to parse the file directly.

Parameters:

fileName - - the path to the config file

Throws:

org.xml.sax.SAXException

javax.xml.parsers.ParserConfigurationException

java.io.IOException

Method Detail

parseFile

public org.w3c.dom.Document parseFile()
                               throws org.xml.sax.SAXException,
                                      javax.xml.parsers.ParserConfigurationException,
                                      java.io.IOException

Parse the file into an XML-DOM Document

Returns:

the parsed XML-DOM Document

Throws:

org.xml.sax.SAXException

javax.xml.parsers.ParserConfigurationException

java.io.IOException

parseFile

public org.w3c.dom.Document parseFile(java.lang.String fileName)
                               throws org.xml.sax.SAXException,
                                      javax.xml.parsers.ParserConfigurationException,
                                      java.io.IOException

Parse the file into an XML-DOM Document using the given fileName

Parameters:

fileName -

Returns:

the parsed XML-DOM Document

Throws:

org.xml.sax.SAXException

javax.xml.parsers.ParserConfigurationException

java.io.IOException

createDocumentBuilder

private javax.xml.parsers.DocumentBuilder createDocumentBuilder()
                                                         throws javax.xml.parsers.ParserConfigurationException

Creates a new documentBuilder with the needed preferences

Returns:

DocumentBuilder - the created builder

Throws:

javax.xml.parsers.ParserConfigurationException

getFileName

public java.lang.String getFileName()

get the name of the file to be parsed

Returns:

the fileName

setFileName

public void setFileName(java.lang.String fileName)

set the name of the file to be parsed

Parameters:

fileName - the fileName to set

getUsername

public java.lang.String getUsername()
                             throws java.lang.Exception

Returns the username of the PlanetLab Central API user.

Returns:

the username

Throws:

java.lang.Exception - if the username could not be found

setUsername

public void setUsername(java.lang.String username)
                 throws java.lang.Exception

Sets the username of the PlanetLab Central API user.

Parameters:

username - - the username

Throws:

java.lang.Exception - if the role could not be found

getPassword

public java.lang.String getPassword()
                             throws java.lang.Exception

Returns the password of the PlanetLab Central API user.

Returns:

the password

Throws:

java.lang.Exception - if the password could not be found

setPassword

public void setPassword(java.lang.String password)
                 throws java.lang.Exception

Sets the password of the PlanetLab Central API user.

Parameters:

password - - the password value

Throws:

java.lang.Exception - if the role could not be found

getRole

public java.lang.String getRole()
                         throws java.lang.Exception

Returns the role of the PlanetLab Central API user.

Returns:

the role

Throws:

java.lang.Exception - if the role could not be found

setRole

public void setRole(java.lang.String role)
             throws java.lang.Exception

Sets the role of the PlanetLab Central API user.

Parameters:

role - - the role name

Throws:

java.lang.Exception - if the role could not be found

getSlicenames

public java.lang.String[] getSlicenames()
                                 throws java.lang.Exception

Returns an array containing all the slice names.

Returns:

the slice names

Throws:

java.lang.Exception - if something could not be found

setSlicenames

public void setSlicenames(java.util.Vector<java.lang.String> slicenames)
                   throws java.lang.Exception

Sets the slicenames of the PlanetLab Central API user.

Parameters:

slicenames - - the slicenames to set.

Throws:

java.lang.Exception - if the slicenames tags could not be created

getRootAttribute

private java.lang.String getRootAttribute(java.lang.String attribName)
                                   throws java.lang.Exception

Returns the value of the specified attribute name.

Parameters:

attribName - - the name of the attribute, which value is needed.

Returns:

the value of the attribute

Throws:

java.lang.Exception - if the attribute could not be found

setRootAttribute

private boolean setRootAttribute(java.lang.String attribName,
                                 java.lang.String value)
                          throws java.lang.Exception

Returns the value of the specified attribute name.

Parameters:

attribName - - the name of the attribute, which value is needed.

Returns:

the value of the attribute

Throws:

java.lang.Exception - if the attribute could not be found

saveConfig

public boolean saveConfig()
                   throws java.lang.Exception

Saves the previously loaded document into the XML file.

Returns:

true if successful

Throws:

java.lang.Exception

saveConfig

private boolean saveConfig(java.lang.String fileName,
                           org.w3c.dom.Document doc)
                    throws java.lang.Exception

Saves XML Document into XML file. thanks to Martin Glogar from http://labe.felk.cvut.cz/~xfaigl/mep/xml/java-xml.htm

Parameters:

fileName - XML file name

doc - XML document to save

Returns:

true if method success false otherwise

Throws:

java.lang.Exception

main

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

This method is used to test this class.

Parameters:

args - - [0] .. loadFilePath, [1] .. saveFilePath