SystemUtilX (Autonomous Unmanned Vehicle (AUV) Workbench Documentation)

java.lang.Object
- workbench.util.SystemUtilX

```
public class SystemUtilX
extends Object
```
Version:

$Id: SystemUtilX.java 8020 2012-07-03 01:37:06Z brutzman $

Constructor Summary

Constructors
Constructor and Description

SystemUtilX()

Constructors
Constructor and Description
`SystemUtilX()`

Method Summary

Methods
Modifier and Type	Method and Description
`static ArrayList`	`decodeXMLFileToData(String srcXml)` read in XML data from a file and search for a particular tag & base64 decode XML string and save as a file.
`static ArrayList`	`decodeXMLFileToData(String srcXml, String destFile)` read in XML data from a file and search for a particular tag & base64 decode XML string and save as a file.
`static ArrayList`	`decodeXMLStringToData(String srcXml)` read in XML data from a string and search for a particular tag & base64 decode XML string and save as a file.
`static ArrayList`	`decodeXMLStringToData(String srcXml, String destFile)` read in XML data from a string and search for a particular tag & base64 decode XML string and save as a file.
`static ArrayList`	`decodeXMLToData(String srcXml, String destFile, String sTagName, boolean bFile)` read in XML data from a file or a string and search for a particular tag, base-64 decode XML string and save as a file.
`static Document`	`encodeDataToXML(String sTagName, ArrayList lstAP, boolean flagZip)` base64 encode data from a file and create XML Document perform zipping based on file formats (see SystemUtilities.fileCanZip)
`static Document`	`encodeDataToXML(String sTagName, String[] arrFiles, String[] arrDescs, String[] arrURL, boolean flagZip)` package multiple file encode data from a file and create XML Document perform zipping based on file formats (see SystemUtilities.fileCanZip)
`static Document`	`encodeDataToXML(String sTagName, String srcFile, String sDesc, String[] arrURL, boolean flagZip)` package a single file encode data from a file and create XML Document perform zipping based on file formats (see SystemUtilities.fileCanZip)
`static boolean`	`encodeDataToXMLFile(ArrayList lstAP, String destXmlFile)` base64 encode data from a file and save under a XML tag <AgentJabber> in a XML document file, GZIP turned on
`static boolean`	`encodeDataToXMLFile(String srcFile, String destXmlFile)` base64 encode data from a file and save under a XML tag <AgentJabber> in a XML document file, GZIP turned on
`static boolean`	`encodeDataToXMLFile(String destXmlFile, String sTagName, ArrayList lstAP, boolean flagZip)` base64 encode data from a file and create XML Document perform zipping based on file formats (see SystemUtilities.fileCanZip) save onto a file
`static boolean`	`encodeDataToXMLFile(String srcFile, String destXmlFile, String[] arrURL)` base64 encode data from a file and save under a XML tag <AgentJabber> in a XML document file, GZIP turned on
`static boolean`	`encodeDataToXMLFile(String srcFile, String destXmlFile, String sTagName, String[] arrURL, boolean flagZip)` base64 encode data from a file and save under a XML tag in a XML document file within CDATA section perform zipping based on file formats (see SystemUtilities.fileCanZip)
`static String`	`encodeDataToXMLString(ArrayList lstAP)` base64 encode data from one or more files, save as <AgentPayload> elements under a XML tag <AgentJabber> and return a XML string, GZIP is turned on
`static String`	`encodeDataToXMLString(String srcFile)` base64 encode data from a file and save under a XML tag <AgentJabber> in a XML document file, GZIP turned on
`static String`	`encodeDataToXMLString(String sTagName, ArrayList lstAP, boolean flagZip)` base64 encode data from one or more files, save as <AgentPayload> elements under a XML tag <AgentJabber> and return a XML string, GZIP is turned on
`static String`	`encodeDataToXMLString(String srcFile, String[] arrURL)` base64 encode data from a file and save under a XML tag <AgentJabber> in a XML document file, GZIP turned on
`static String`	`encodeDataToXMLString(String srcFile, String sTagName, String[] arrURL, boolean flagZip)` base64 encode data from a file and save under a XML tag and return an XML string perform zipping based on file formats (see SystemUtilities.fileCanZip)
`static String`	`getDestDir()` get destination directory to store decoded binary data invoke from decodeXMLToDat()
`static List<Node>`	`getTargetChildNodes(Node root, String[] requiredAttrs)` get a list of nodes that matches the list of child node names e.g.
`static Document`	`getXMLDoc(String srcXML, boolean fFile)` get XML Document object from a XML file or string
`static Document`	`getXMLDocFromFile(String srcXML)` get XML Document object from a XML file
`static Document`	`getXMLDocFromString(String srcXML)` get XML Document object from a XML string
`static String`	`getXMLString(String filename)` get XML string from a XML file
`static String`	`getXMLStringFromDoc(Document xmlDoc)` get XML string from a XML Document, pretty print option turned off
`static String`	`getXMLStringFromDoc(Document xmlDoc, boolean fOmitXMLDeclare, boolean fPrettyPrint)` get XML string from a XML Document (with pretty print option)
`static String`	`getXMLStringPrettyPrint(String filename)` get XML string from a XML file
`static void`	`setDestDir(String sDir)` set destination directory to store decoded binary data invoke from decodeXMLToDat()
`static String`	`urlGetFile(String sURL, String sSaveAs, String strReferrer)` get file from HTTP server for better responsiveness during downloading of file, spawn a new thread sample code: String sURL = "http://www.iconfactory.com/graphics/previews/kong_prv.jpg"; SystemUtilX.urlGetFile(sURL, "..
`static boolean`	`urlPost(String sURL, String[] htmlName, String[] htmlData, String[] fileName, String[] fileData)` HTTP post files and data (multiple HTML/FILE objects) Each form field is sent within a boundary delimiter e.g.
`static boolean`	`urlPostData(String sURL, String[] manyName, String[] manyData)` HTTP post data (multiple HTML object) Each form field is sent within a boundary delimiter e.g.
`static boolean`	`urlPostData(String sURL, String oneName, String oneData)` HTTP post data (one HTML object) Each form field is sent within a boundary delimiter e.g. urlPostData("http://<servername>/<servlet>", "txtBox", "The quick brown fox"); e.g. in HTML form <input TYPE="text" NAME="formField2" VALUE="value_of_field2">
`static boolean`	`urlPostFile(String sURL, String[] manyFName, String[] manyFData)` HTTP post files (multiple FILE objects) Each form field is sent within a boundary delimiter e.g. urlPostFile("http://<servername>/<servlet>", new String[]{ "edtFile1", "edtFile2" }, // file tags new String[]{ "C:\\1.txt", "C:\\2.txt"} ); e.g. in HTML form <input TYPE="file" NAME="edtFile1"> <input TYPE="file" NAME="edtFile2">
`static boolean`	`urlPostFile(String sURL, String oneFName, String oneFData)` HTTP post files (multiple FILE objects) Each form field is sent within a boundary delimiter e.g. urlPostFile("http://<servername>/<servlet>", "edtFile1", "C:\\1.txt"); e.g. in HTML form <input TYPE="file" NAME="edtFile1">
`static void`	`writeErr(String aStr)` write a error messgae to console
`static void`	`writeLn()` write a line to console
`static void`	`writeLn(String aStr)` write a line to console

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - SystemUtilX
```
public SystemUtilX()
```
- Method Detail
  - getDestDir
```
public static String getDestDir()
```
    get destination directory to store decoded binary data invoke from decodeXMLToDat()
    
    Returns:
    String value
  - setDestDir
```
public static void setDestDir(String sDir)
```
    set destination directory to store decoded binary data invoke from decodeXMLToDat()
    
    Parameters:
    sDir - String value
  - decodeXMLFileToData
```
public static ArrayList decodeXMLFileToData(String srcXml)
```
    read in XML data from a file and search for a particular tag & base64 decode XML string and save as a file. Note: if destination filename is specified, the filename in the tag attribute is used <AgentJabber filename="hello.bmp">
    
    Parameters:
    srcXml - source XML file
    
    Returns:
    list of destination filenames saved to
  - decodeXMLFileToData
```
public static ArrayList decodeXMLFileToData(String srcXml,
                            String destFile)
```
    read in XML data from a file and search for a particular tag & base64 decode XML string and save as a file. Note: if destination filename is specified, the filename in the tag attribute is used <AgentJabber filename="hello.bmp">
    
    Parameters:
    srcXml - source XML file
    destFile - destination output file, attribute value used if empty
    
    Returns:
    list of destination filenames saved to
  - decodeXMLStringToData
```
public static ArrayList decodeXMLStringToData(String srcXml)
```
    read in XML data from a string and search for a particular tag & base64 decode XML string and save as a file. Note: if destination filename is specified, the filename in the tag attribute is used <AgentJabber filename="hello.bmp">
    
    Parameters:
    srcXml - source XML file
    
    Returns:
    list of destination filenames saved to
  - decodeXMLStringToData
```
public static ArrayList decodeXMLStringToData(String srcXml,
                              String destFile)
```
    read in XML data from a string and search for a particular tag & base64 decode XML string and save as a file. Note: if destination filename is specified, the filename in the tag attribute is used <AgentJabber filename="hello.bmp">
    
    Parameters:
    srcXml - source XML file
    destFile - destination output file, attribute value used if empty
    
    Returns:
    list of destination filenames saved to
  - decodeXMLToData
```
public static ArrayList decodeXMLToData(String srcXml,
                        String destFile,
                        String sTagName,
                        boolean bFile)
                                 throws IOException
```
    read in XML data from a file or a string and search for a particular tag, base-64 decode XML string and save as a file. Note: if destination filename is specified, the filename in the tag attribute is used <AgentJabber filename="hello.bmp"> CDATA maybe kept empty if the file size is too big. To retrieve the file from a storage location, parse through list of URLs and perform HTTP GET or FTP GET. FTP GET is not implemented yet.
    
    Parameters:
    srcXml - source XML file or string
    destFile - destination output file, attribute value used if empty
    sTagName - tag name to be used
    bFile - true if read from file, otherwise it is a string
    
    Returns:
    list of destination filenames saved to
    
    Throws:
    
    IOException - XML exception error
  - encodeDataToXML
```
public static Document encodeDataToXML(String sTagName,
                       ArrayList lstAP,
                       boolean flagZip)
```
    base64 encode data from a file and create XML Document perform zipping based on file formats (see SystemUtilities.fileCanZip)
    
    Parameters:
    sTagName - tag name to be used
    lstAP - list of AgentPayload objects (file name, description & URLs)
    flagZip - whether to gzip zippable files
    
    Returns:
    created XML document
  - encodeDataToXML
```
public static Document encodeDataToXML(String sTagName,
                       String srcFile,
                       String sDesc,
                       String[] arrURL,
                       boolean flagZip)
```
    package a single file encode data from a file and create XML Document perform zipping based on file formats (see SystemUtilities.fileCanZip)
    
    Parameters:
    sTagName - tag name to be used
    srcFile - binary data source file
    sDesc - description of binary data
    arrURL - list of URLs
    flagZip - whether to gzip zippable files
    
    Returns:
    created XML document
  - encodeDataToXML
```
public static Document encodeDataToXML(String sTagName,
                       String[] arrFiles,
                       String[] arrDescs,
                       String[] arrURL,
                       boolean flagZip)
```
    package multiple file encode data from a file and create XML Document perform zipping based on file formats (see SystemUtilities.fileCanZip)
    
    Parameters:
    sTagName - tag name to be used
    arrFiles - list of source file
    arrDescs - list of description
    arrURL - list of URLs (same URLs for all the files)
    flagZip - whether to gzip zippable files
    
    Returns:
    created XML document
  - encodeDataToXMLFile
```
public static boolean encodeDataToXMLFile(String srcFile,
                          String destXmlFile)
```
    base64 encode data from a file and save under a XML tag <AgentJabber> in a XML document file, GZIP turned on
    
    Parameters:
    srcFile - binary data source file
    destXmlFile - XML output file
    
    Returns:
    true for success, otherwise false
  - encodeDataToXMLFile
```
public static boolean encodeDataToXMLFile(String srcFile,
                          String destXmlFile,
                          String[] arrURL)
```
    base64 encode data from a file and save under a XML tag <AgentJabber> in a XML document file, GZIP turned on
    
    Parameters:
    srcFile - binary data source file
    destXmlFile - XML output file
    arrURL - list of URLs
    
    Returns:
    true for success, otherwise false
  - encodeDataToXMLFile
```
public static boolean encodeDataToXMLFile(String srcFile,
                          String destXmlFile,
                          String sTagName,
                          String[] arrURL,
                          boolean flagZip)
```
    base64 encode data from a file and save under a XML tag in a XML document file within CDATA section perform zipping based on file formats (see SystemUtilities.fileCanZip)
    
    Parameters:
    srcFile - binary data source file
    destXmlFile - XML output file
    sTagName - tag name to be used
    arrURL - list of URLs
    flagZip - whether to gzip zippable files
    
    Returns:
    true for success, otherwise false
  - encodeDataToXMLFile
```
public static boolean encodeDataToXMLFile(ArrayList lstAP,
                          String destXmlFile)
```
    base64 encode data from a file and save under a XML tag <AgentJabber> in a XML document file, GZIP turned on
    
    Parameters:
    lstAP - list of AgentPayload objects
    destXmlFile - XML output file
    
    Returns:
    true for success, otherwise false
  - encodeDataToXMLFile
```
public static boolean encodeDataToXMLFile(String destXmlFile,
                          String sTagName,
                          ArrayList lstAP,
                          boolean flagZip)
```
    base64 encode data from a file and create XML Document perform zipping based on file formats (see SystemUtilities.fileCanZip) save onto a file
    
    Parameters:
    destXmlFile - XML output file
    sTagName - tag name to be used
    lstAP - list of AgentPayload objects (file name, description & URLs)
    flagZip - whether to gzip zippable files
    
    Returns:
    created XML document
  - encodeDataToXMLString
```
public static String encodeDataToXMLString(String srcFile)
```
    base64 encode data from a file and save under a XML tag <AgentJabber> in a XML document file, GZIP turned on
    
    Parameters:
    srcFile - binary data source file
    
    Returns:
    XML string
  - encodeDataToXMLString
```
public static String encodeDataToXMLString(String srcFile,
                           String[] arrURL)
```
    base64 encode data from a file and save under a XML tag <AgentJabber> in a XML document file, GZIP turned on
    
    Parameters:
    srcFile - binary data source file
    arrURL - list of URLs
    
    Returns:
    XML string
  - encodeDataToXMLString
```
public static String encodeDataToXMLString(String srcFile,
                           String sTagName,
                           String[] arrURL,
                           boolean flagZip)
```
    base64 encode data from a file and save under a XML tag and return an XML string perform zipping based on file formats (see SystemUtilities.fileCanZip)
    
    Parameters:
    srcFile - binary data source file
    sTagName - tag name to be used
    arrURL - list of URLs
    flagZip - whether to gzip zippable files
    
    Returns:
    XML string
  - encodeDataToXMLString
```
public static String encodeDataToXMLString(ArrayList lstAP)
```
    base64 encode data from one or more files, save as <AgentPayload> elements under a XML tag <AgentJabber> and return a XML string, GZIP is turned on
    
    Parameters:
    lstAP - list of AgentPayload objects
    
    Returns:
    XML string
  - encodeDataToXMLString
```
public static String encodeDataToXMLString(String sTagName,
                           ArrayList lstAP,
                           boolean flagZip)
```
    base64 encode data from one or more files, save as <AgentPayload> elements under a XML tag <AgentJabber> and return a XML string, GZIP is turned on
    
    Parameters:
    sTagName - tag name to be used
    lstAP - list of AgentPayload objects
    flagZip - whether to gzip zippable files
    
    Returns:
    XML string
  - getTargetChildNodes
```
public static List<Node> getTargetChildNodes(Node root,
                             String[] requiredAttrs)
```
    get a list of nodes that matches the list of child node names e.g. private static final String[] TAG_AUVWORKBENCH_CHILD = {TAG_GENERAL, TAG_EXECUTION, TAG_HYDRODYNAMICS};
    
    Parameters:
    root - start node
    requiredAttrs - set of child node names
    
    Returns:
    list of Nodes
  - getXMLDoc
```
public static Document getXMLDoc(String srcXML,
                 boolean fFile)
```
    get XML Document object from a XML file or string
    
    Parameters:
    srcXML - XML file
    fFile - getting from a file?
    
    Returns:
    XML Document
  - getXMLString
```
public static String getXMLString(String filename)
```
    get XML string from a XML file
    
    Parameters:
    filename - XML file
    
    Returns:
    XML Document
  - getXMLStringFromDoc
```
public static String getXMLStringFromDoc(Document xmlDoc)
```
    get XML string from a XML Document, pretty print option turned off
    
    Parameters:
    xmlDoc - XML Document
    
    Returns:
    XML Document
  - getXMLStringFromDoc
```
public static String getXMLStringFromDoc(Document xmlDoc,
                         boolean fOmitXMLDeclare,
                         boolean fPrettyPrint)
```
    get XML string from a XML Document (with pretty print option)
    
    Parameters:
    xmlDoc - XML Document
    fOmitXMLDeclare - sets XML declaration omitting on and off.
    fPrettyPrint - allow indentation, include line feeds and carriage returns
    
    Returns:
    XML Document
  - getXMLDocFromFile
```
public static Document getXMLDocFromFile(String srcXML)
```
    get XML Document object from a XML file
    
    Parameters:
    srcXML - XML file
    
    Returns:
    XML Document
  - getXMLDocFromString
```
public static Document getXMLDocFromString(String srcXML)
```
    get XML Document object from a XML string
    
    Parameters:
    srcXML - XML file
    
    Returns:
    XML Document
  - getXMLStringPrettyPrint
```
public static String getXMLStringPrettyPrint(String filename)
```
    get XML string from a XML file
    
    Parameters:
    filename - XML file
    
    Returns:
    XML Document
  - urlGetFile
```
public static String urlGetFile(String sURL,
                String sSaveAs,
                String strReferrer)
```
    get file from HTTP server for better responsiveness during downloading of file, spawn a new thread sample code: String sURL = "http://www.iconfactory.com/graphics/previews/kong_prv.jpg"; SystemUtilX.urlGetFile(sURL, "../test-data", ""); future enhancement - optimise to request server to return a list of files
    
    Parameters:
    sURL - server URL path
    sSaveAs - directory or full path to save to
    strReferrer - who is the referrer of this link e.g. "http://www.nps.navy.mil/"
    
    Returns:
    file path
  - urlPostData
```
public static boolean urlPostData(String sURL,
                  String oneName,
                  String oneData)
                           throws Exception
```
    HTTP post data (one HTML object) Each form field is sent within a boundary delimiter e.g. urlPostData("http://<servername>/<servlet>", "txtBox", "The quick brown fox"); e.g. in HTML form <input TYPE="text" NAME="formField2" VALUE="value_of_field2">
    
    Parameters:
    sURL - URL to post to
    oneName - FORM tag name e.g formField2
    oneData - FORM data e.g. value_of_field2
    
    Returns:
    status
    
    Throws:
    
    Exception - failure
  - urlPostData
```
public static boolean urlPostData(String sURL,
                  String[] manyName,
                  String[] manyData)
                           throws Exception
```
    HTTP post data (multiple HTML object) Each form field is sent within a boundary delimiter e.g. SystemUtilX.urlPostData(sURL, new String[]{ "edtChatroom", "edtSubject", "edtBody", "edtFileUpDesc1", "edtFileUpDesc2" }, // html tags new String[]{ "savage@conference.xchat.movesinstitute.org", "Message Subject", "Message Body", "File Description 1", "File Description 2" } // html values ); e.g. in HTML form <input TYPE="text" NAME="formField2" VALUE="value_of_field2">
    
    Parameters:
    sURL - URL to post to
    manyName - FORM tag name e.g formField2
    manyData - FORM data e.g. value_of_field2
    
    Returns:
    status
    
    Throws:
    
    Exception - failure
  - urlPostFile
```
public static boolean urlPostFile(String sURL,
                  String oneFName,
                  String oneFData)
                           throws Exception
```
    HTTP post files (multiple FILE objects) Each form field is sent within a boundary delimiter e.g. urlPostFile("http://<servername>/<servlet>", "edtFile1", "C:\\1.txt"); e.g. in HTML form <input TYPE="file" NAME="edtFile1">
    
    Parameters:
    sURL - URL to post to
    oneFName - FORM tag name e.g edtFile1
    oneFData - file path e.g. C:\\1.txt
    
    Returns:
    status true if success, otherwise false
    
    Throws:
    
    Exception - failure
  - urlPostFile
```
public static boolean urlPostFile(String sURL,
                  String[] manyFName,
                  String[] manyFData)
                           throws Exception
```
    HTTP post files (multiple FILE objects) Each form field is sent within a boundary delimiter e.g. urlPostFile("http://<servername>/<servlet>", new String[]{ "edtFile1", "edtFile2" }, // file tags new String[]{ "C:\\1.txt", "C:\\2.txt"} ); e.g. in HTML form <input TYPE="file" NAME="edtFile1"> <input TYPE="file" NAME="edtFile2">
    
    Parameters:
    sURL - URL to post to
    manyFName - FORM tag name e.g edtFile1
    manyFData - file path e.g. C:\\1.txt
    
    Returns:
    status true if success, otherwise false
    
    Throws:
    
    Exception - failure
  - urlPost
```
public static boolean urlPost(String sURL,
              String[] htmlName,
              String[] htmlData,
              String[] fileName,
              String[] fileData)
                       throws Exception
```
    HTTP post files and data (multiple HTML/FILE objects) Each form field is sent within a boundary delimiter e.g. SystemUtilX.urlPost(sURL, new String[]{ "edtChatroom", "edtSubject", "edtBody", "edtFileUpDesc1", "edtFileUpDesc2" }, // html tags new String[]{ "savage@conference.xchat.movesinstitute.org", "Message Subject", "Message Body", "File Description 1", "File Description 2" }, // html values new String[]{ "edtFileUp1", "edtFileUp2" }, // file tags new String[]{ "C:\\My Documents\\NPS_100.bmp", "C:\\My Documents\\1.txt" } ); e.g. in HTML form/FILE <input TYPE="text" NAME="formField2" VALUE="value_of_field2"> <input type="FILE" name="edtFileUpName3">
    
    Parameters:
    sURL - URL to post to
    htmlName - list of FORM tag name e.g. formField2
    htmlData - list of FORM data e.g. value_of_field2
    fileName - list of FORM tag for file e.g. "edtFileUpload1"
    fileData - list of file paths e.g. "C:\\1.txt"
    
    Returns:
    status true if success, otherwise false
    
    Throws:
    
    Exception - failure
  - writeErr
```
public static void writeErr(String aStr)
```
    write a error messgae to console
    
    Parameters:
    aStr - line to be written to console
  - writeLn
```
public static void writeLn(String aStr)
```
    write a line to console
    
    Parameters:
    aStr - line to be written to console
  - writeLn
```
public static void writeLn()
```
    write a line to console

Class SystemUtilX

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SystemUtilX

Method Detail

getDestDir

setDestDir

decodeXMLFileToData

decodeXMLFileToData

decodeXMLStringToData

decodeXMLStringToData

decodeXMLToData

encodeDataToXML

encodeDataToXML

encodeDataToXML

encodeDataToXMLFile

encodeDataToXMLFile

encodeDataToXMLFile

encodeDataToXMLFile

encodeDataToXMLFile

encodeDataToXMLString

encodeDataToXMLString

encodeDataToXMLString

encodeDataToXMLString

encodeDataToXMLString

getTargetChildNodes

getXMLDoc

getXMLString

getXMLStringFromDoc

getXMLStringFromDoc

getXMLDocFromFile

getXMLDocFromString

getXMLStringPrettyPrint

urlGetFile

urlPostData

urlPostData

urlPostFile

urlPostFile

urlPost

writeErr

writeLn

writeLn