cms/util/XMLPacketMaker.java

//---PACKAGE DECLARATION---
package uk.org.iscream.cms.server.util;

//---IMPORTS---
import java.io.*;
import org.xml.sax.*;
import javax.xml.parsers.*;

/**
 * XMLPacketMaker - Creates an XMLPacket object.
 *
 * @author  $Author: tdb1 $
 * @version $Id: XMLPacketMaker.java,v 1.15 2001/03/16 00:39:42 tdb1 Exp $
 */
public class XMLPacketMaker {

//---FINAL ATTRIBUTES---

    /**
     * The current CVS revision of this class
     */
    public final String REVISION = "$Revision: 1.15 $";

    /** 
     * A reference to the system saxParser factory
     */ 
    private final SAXParserFactory _factory = SAXParserFactory.newInstance();
     
//---STATIC METHODS---

//---CONSTRUCTORS---

//---PUBLIC METHODS---

    /**
     * Method to create an XML packet from the data this
     * class was constructed with.
     *
     * @param xml the XML String to parse
     * @return an XMLPacket representing the XML String given
     * @throws InvalidXMLException if the XML cannot be parsed
     */
    public XMLPacket createXMLPacket(String xml) throws InvalidXMLException {

        // Create the XMLPacket to store values in.
        XMLPacket packet = new XMLPacket();
        
        try {
            // Parse the input
            InputSource inputSource = new InputSource(new StringReader(xml));
            _factory.newSAXParser().parse(inputSource, new XMLStringParser(packet));
        }
        catch (Exception e) {
            // couldn't parse the XML for some reason
            throw new InvalidXMLException("Could not parse the XML: "+xml);
        }
        
        // parsed successfully, return the packet
        return packet;
    }

    /**
     * Overrides the {@link java.lang.Object#toString() Object.toString()}
     * method to provide clean logging (every class should have this).
     *
     * This uses the uk.org.iscream.cms.server.util.NameFormat class
     * to format the toString()
     *
     * @return the name of this class and its CVS revision
     */
    public String toString() {
        return FormatName.getName(
            _name,
            getClass().getName(),
            REVISION);
    }

//---PRIVATE METHODS---

//---ACCESSOR/MUTATOR METHODS---

//---ATTRIBUTES---
    
    /**
     * This is the friendly identifier of the
     * component this class is running in.
     * eg, a Filter may be called "filter1",
     * If this class does not have an owning
     * component,  a name from the configuration
     * can be placed here.  This name could also
     * be changed to null for utility classes.
     */
    private String _name = null;

//---STATIC ATTRIBUTES---

}
Revision:	1.16
Committed:	Tue May 29 17:02:35 2001 UTC (22 years, 11 months ago) by tdb
Branch:	MAIN
Branch point for:	SERVER_PIRCBOT
Changes since 1.15:	+4 -4 lines
Log Message:	Major change in the java package naming. This has been held off for some time now, but it really needed doing. The future packaging of all i-scream products will be; uk.org.iscream.<product>.<subpart>.* In the case of the central monitoring system server this will be; uk.org.iscream.cms.server.* The whole server has been changed to follow this structure, and tested to a smallish extent. Further changes in other parts of the CMS will follow.
#	User	Rev	Content
1	ajm	1.7	//---PACKAGE DECLARATION---
2	tdb	1.16	package uk.org.iscream.cms.server.util;
3	ajm	1.7
4			//---IMPORTS---
5			import java.io.*;
6			import org.xml.sax.*;
7	tdb	1.13	import javax.xml.parsers.*;
8	ajm	1.7
9			/**
10			* XMLPacketMaker - Creates an XMLPacket object.
11			*
12	tdb	1.9	* @author $Author: tdb1 $
13	tdb	1.16	* @version $Id: XMLPacketMaker.java,v 1.15 2001/03/16 00:39:42 tdb1 Exp $
14	ajm	1.7	*/
15	tdb	1.13	public class XMLPacketMaker {
16	ajm	1.7
17			//---FINAL ATTRIBUTES---
18
19			/**
20			* The current CVS revision of this class
21			*/
22	tdb	1.16	public final String REVISION = "$Revision: 1.15 $";
23	tdb	1.15
24			/**
25			* A reference to the system saxParser factory
26			*/
27			private final SAXParserFactory _factory = SAXParserFactory.newInstance();
28	tdb	1.11
29	ajm	1.7	//---STATIC METHODS---
30
31			//---CONSTRUCTORS---
32
33			//---PUBLIC METHODS---
34
35	tdb	1.9	/**
36			* Method to create an XML packet from the data this
37			* class was constructed with.
38			*
39	tdb	1.13	* @param xml the XML String to parse
40	tdb	1.9	* @return an XMLPacket representing the XML String given
41	tdb	1.10	* @throws InvalidXMLException if the XML cannot be parsed
42	tdb	1.9	*/
43	tdb	1.13	public XMLPacket createXMLPacket(String xml) throws InvalidXMLException {
44	ajm	1.7
45			// Create the XMLPacket to store values in.
46			XMLPacket packet = new XMLPacket();
47	tdb	1.11
48	ajm	1.7	try {
49			// Parse the input
50	tdb	1.13	InputSource inputSource = new InputSource(new StringReader(xml));
51			_factory.newSAXParser().parse(inputSource, new XMLStringParser(packet));
52	ajm	1.7	}
53			catch (Exception e) {
54	tdb	1.10	// couldn't parse the XML for some reason
55	tdb	1.13	throw new InvalidXMLException("Could not parse the XML: "+xml);
56	ajm	1.7	}
57	tdb	1.13
58	tdb	1.10	// parsed successfully, return the packet
59	ajm	1.7	return packet;
60			}
61
62			/**
63			* Overrides the {@link java.lang.Object#toString() Object.toString()}
64			* method to provide clean logging (every class should have this).
65			*
66	tdb	1.16	* This uses the uk.org.iscream.cms.server.util.NameFormat class
67	ajm	1.7	* to format the toString()
68			*
69			* @return the name of this class and its CVS revision
70			*/
71			public String toString() {
72			return FormatName.getName(
73			_name,
74			getClass().getName(),
75			REVISION);
76			}
77
78			//---PRIVATE METHODS---
79
80			//---ACCESSOR/MUTATOR METHODS---
81
82			//---ATTRIBUTES---
83
84			/**
85			* This is the friendly identifier of the
86			* component this class is running in.
87			* eg, a Filter may be called "filter1",
88			* If this class does not have an owning
89			* component, a name from the configuration
90			* can be placed here. This name could also
91			* be changed to null for utility classes.
92			*/
93			private String _name = null;
94
95			//---STATIC ATTRIBUTES---
96
97			}