Quadcap Embeddable Server

com.quadcap.server.ServerConfigParser Class Reference

Inheritance diagram for com.quadcap.server.ServerConfigParser:

DocumentHandler ErrorHandler List of all members.

Detailed Description

Parser the server.xml file to determine which services should be loaded on startup.

Author:
Stan Bailes

Definition at line 114 of file ServerConfigParser.java.

Public Member Functions

 ServerConfigParser (ServiceContainer c) throws Exception
 No-argument constructor.

void parse (String fileName) throws Exception
 Parse the specified file.

 SAX parser callback to handle XML Parser errors.

 SAX parser callback to handle XML Parser fatal errors.

 SAX parser callback to handle XML Parser fatal errors.

void characters (char[] ch, int start, int length) throws SAXException
 SAX parser callback to handle character data found in the parsed document.

void endDocument ()
 SAX parser callback function that is called when the end of the document is reached.

void endElement (String name) throws SAXException
 SAX parser callback function called for the end of an element.

void ignorableWhitespace (char[] ch, int start, int length)
 SAX parser callback for ignorable whitespace.

void processingInstruction (String target, String data)
 SAX parser callback for processing instructions.

void setDocumentLocator (Locator locator)
 SAX parser callback used to receive a document locator.

void startDocument ()
 SAX parser callback for document start.

 SAX parser callback for the start of an element.


Static Public Member Functions

final Properties parseProps (String fileName) throws IOException

Package Functions

final String consume ()
 Get and return all of the accumulated character data as a String.

final void addServices () throws SAXException
 At the end of the file, add the services in the specified order.


Static Package Functions

 [static initializer]
final int mapElement (String name)

Package Attributes

ServiceContainer container
Parser parser
Locator locator
StringBuffer data = new StringBuffer()
ArrayList services = new ArrayList()
ServiceWrapper service = null
Properties props = null
String paramName = null
String paramValue = null

Static Package Attributes

final int INIT = 0
final int SERVER = 1
final int SERVICE = 2
final int SERVICE_NAME = 3
final int SERVICE_CLASS = 4
final int SERVICE_CONFIG = 5
final int LOAD_ON_STARTUP = 6
final int INIT_PARAMETER = 7
final int PARAM_NAME = 8
final int PARAM_VALUE = 9
HashMap elemMap = new HashMap()

Private Member Functions

final Properties getProps ()


Constructor & Destructor Documentation

com.quadcap.server.ServerConfigParser.ServerConfigParser ServiceContainer  c  )  throws Exception
 

No-argument constructor.

The new object needs a database connection before it can do anything useful.

Exceptions:
Exception may be thrown if there's a problem constructing the XML parser.

Definition at line 163 of file ServerConfigParser.java.

References com.quadcap.server.ServerConfigParser.parser, and com.quadcap.util.ConfigString.toString().


Member Function Documentation

com.quadcap.server.ServerConfigParser.[static initializer]  )  [static, package]
 

final void com.quadcap.server.ServerConfigParser.addServices  ) 
 

At the end of the file, add the services in the specified order.

Definition at line 414 of file ServerConfigParser.java.

References com.quadcap.server.ServerConfigParser.services.

Referenced by com.quadcap.server.ServerConfigParser.endElement().

void com.quadcap.server.ServerConfigParser.characters char[]  ch,
int  start,
int  length
 

SAX parser callback to handle character data found in the parsed document.

Parameters:
ch the buffer containing the parsed characters.
star the buffer position of the first character
length the number of characters
Exceptions:
SAXException may be thrown if this data represents a database value and there's a SQL exception thrown while trying to update the underlying resultset object with this data.

Definition at line 244 of file ServerConfigParser.java.

References com.quadcap.server.ServerConfigParser.characters(), and com.quadcap.server.ServerConfigParser.data.

Referenced by com.quadcap.server.ServerConfigParser.characters().

final String com.quadcap.server.ServerConfigParser.consume  )  [package]
 

Get and return all of the accumulated character data as a String.

Reset the character data buffer to be empty.

Definition at line 405 of file ServerConfigParser.java.

References com.quadcap.server.ServerConfigParser.data.

Referenced by com.quadcap.server.ServerConfigParser.endElement().

void com.quadcap.server.ServerConfigParser.endDocument  ) 
 

SAX parser callback function that is called when the end of the document is reached.

This implementation does nothing.

Definition at line 254 of file ServerConfigParser.java.

void com.quadcap.server.ServerConfigParser.endElement String  name  ) 
 

SAX parser callback function called for the end of an element.

If this element represents the <database> element, we finish up by closing the active statement. If this element represents a table row element, we insert the current row. Otherwise, we do nothing.

Parameters:
name the name of this element
Exceptions:
SAXException may be thrown to wrap any underlying database exception.

Definition at line 268 of file ServerConfigParser.java.

References com.quadcap.server.ServerConfigParser.addServices(), com.quadcap.server.ServerConfigParser.consume(), com.quadcap.server.ServerConfigParser.endElement(), com.quadcap.server.ServerConfigParser.getProps(), com.quadcap.server.ServerConfigParser.INIT_PARAMETER, com.quadcap.server.ServerConfigParser.LOAD_ON_STARTUP, com.quadcap.server.ServerConfigParser.PARAM_NAME, com.quadcap.server.ServerConfigParser.PARAM_VALUE, com.quadcap.server.ServerConfigParser.paramName, com.quadcap.server.ServerConfigParser.paramValue, com.quadcap.server.ServerConfigParser.parseProps(), com.quadcap.server.ServerConfigParser.props, com.quadcap.server.ServerConfigParser.SERVER, com.quadcap.server.ServerConfigParser.service, com.quadcap.server.ServerConfigParser.SERVICE, com.quadcap.server.ServerConfigParser.SERVICE_CLASS, com.quadcap.server.ServerConfigParser.SERVICE_CONFIG, com.quadcap.server.ServerConfigParser.SERVICE_NAME, com.quadcap.server.ServerConfigParser.services, com.quadcap.server.ServiceWrapper.setLoadOnStartup(), com.quadcap.server.ServiceWrapper.setServiceClass(), com.quadcap.server.ServiceWrapper.setServiceName(), and com.quadcap.server.ServiceWrapper.setServiceProperties().

Referenced by com.quadcap.server.ServerConfigParser.endElement().

void com.quadcap.server.ServerConfigParser.error exception  ) 
 

SAX parser callback to handle XML Parser errors.

This implementation just prints them to System.err.

Parameters:
exception the exception generated by the parser.

Definition at line 202 of file ServerConfigParser.java.

References com.quadcap.server.ServerConfigParser.error().

Referenced by com.quadcap.server.ServerConfigParser.error().

void com.quadcap.server.ServerConfigParser.fatalError exception  ) 
 

SAX parser callback to handle XML Parser fatal errors.

This implementation just prints them to System.err.

Parameters:
exception the exception generated by the parser.

Definition at line 214 of file ServerConfigParser.java.

References com.quadcap.server.ServerConfigParser.fatalError().

Referenced by com.quadcap.server.ServerConfigParser.fatalError().

final Properties com.quadcap.server.ServerConfigParser.getProps  )  [private]
 

Definition at line 317 of file ServerConfigParser.java.

References com.quadcap.server.ServerConfigParser.props.

Referenced by com.quadcap.server.ServerConfigParser.endElement().

void com.quadcap.server.ServerConfigParser.ignorableWhitespace char[]  ch,
int  start,
int  length
 

SAX parser callback for ignorable whitespace.

We just ignore it

Parameters:
ch the buffer containing the parsed characters.
star the buffer position of the first character
length the number of characters

Definition at line 343 of file ServerConfigParser.java.

References com.quadcap.server.ServerConfigParser.ignorableWhitespace().

Referenced by com.quadcap.server.ServerConfigParser.ignorableWhitespace().

final int com.quadcap.server.ServerConfigParser.mapElement String  name  )  [static, package]
 

Definition at line 150 of file ServerConfigParser.java.

References com.quadcap.server.ServerConfigParser.elemMap, and com.quadcap.server.ServerConfigParser.mapElement().

Referenced by com.quadcap.server.ServerConfigParser.mapElement().

void com.quadcap.server.ServerConfigParser.parse String  fileName  )  throws Exception
 

Parse the specified file.

Exceptions:
may be thrown

Definition at line 184 of file ServerConfigParser.java.

References com.quadcap.server.ServerConfigParser.parse(), and com.quadcap.server.ServerConfigParser.parser.

Referenced by com.quadcap.server.ServiceContainer.init(), and com.quadcap.server.ServerConfigParser.parse().

final Properties com.quadcap.server.ServerConfigParser.parseProps String  fileName  )  throws IOException [static]
 

Definition at line 322 of file ServerConfigParser.java.

References com.quadcap.server.ServerConfigParser.parseProps().

Referenced by com.quadcap.server.ServerConfigParser.endElement(), and com.quadcap.server.ServerConfigParser.parseProps().

void com.quadcap.server.ServerConfigParser.processingInstruction String  target,
String  data
 

SAX parser callback for processing instructions.

This implementation does nothing.

Parameters:
target the processing instruction target.
data the processing instruction data.

Definition at line 353 of file ServerConfigParser.java.

References com.quadcap.server.ServerConfigParser.processingInstruction().

Referenced by com.quadcap.server.ServerConfigParser.processingInstruction().

void com.quadcap.server.ServerConfigParser.setDocumentLocator Locator  locator  ) 
 

SAX parser callback used to receive a document locator.

Parameters:
locator the parser's locator object.

Definition at line 361 of file ServerConfigParser.java.

References com.quadcap.server.ServerConfigParser.setDocumentLocator().

Referenced by com.quadcap.server.ServerConfigParser.setDocumentLocator().

void com.quadcap.server.ServerConfigParser.startDocument  ) 
 

SAX parser callback for document start.

This implementation does nothing.

Definition at line 369 of file ServerConfigParser.java.

void com.quadcap.server.ServerConfigParser.startElement String  name,
attrs
 

SAX parser callback for the start of an element.

If this element represents a table row, and the table is different from the last table seen, we establish an updatable ResultSet for the new table which can be used to insert new rows into the table. If this element represents a table row, we move to the insert row. If this element represents a column, we remember the column name.

Parameters:
name the element name
attrs the element's attributes
Exceptions:
SAXException may be thrown to wrap an underlying database error, or if there is a problem with the XML document itself.

Definition at line 386 of file ServerConfigParser.java.

References com.quadcap.server.ServerConfigParser.data, com.quadcap.server.ServerConfigParser.service, com.quadcap.server.ServerConfigParser.SERVICE, and com.quadcap.server.ServerConfigParser.startElement().

Referenced by com.quadcap.server.ServerConfigParser.startElement().

void com.quadcap.server.ServerConfigParser.warning exception  ) 
 

SAX parser callback to handle XML Parser fatal errors.

This implementation just prints them to System.err.

Parameters:
exception the exception generated by the parser.

Definition at line 226 of file ServerConfigParser.java.

References com.quadcap.server.ServerConfigParser.warning().

Referenced by com.quadcap.server.ServerConfigParser.warning().


Member Data Documentation

ServiceContainer com.quadcap.server.ServerConfigParser.container [package]
 

Definition at line 115 of file ServerConfigParser.java.

StringBuffer com.quadcap.server.ServerConfigParser.data = new StringBuffer() [package]
 

Definition at line 118 of file ServerConfigParser.java.

Referenced by com.quadcap.server.ServerConfigParser.characters(), com.quadcap.server.ServerConfigParser.consume(), and com.quadcap.server.ServerConfigParser.startElement().

HashMap com.quadcap.server.ServerConfigParser.elemMap = new HashMap() [static, package]
 

Definition at line 137 of file ServerConfigParser.java.

Referenced by com.quadcap.server.ServerConfigParser.mapElement().

final int com.quadcap.server.ServerConfigParser.INIT = 0 [static, package]
 

Definition at line 125 of file ServerConfigParser.java.

final int com.quadcap.server.ServerConfigParser.INIT_PARAMETER = 7 [static, package]
 

Definition at line 132 of file ServerConfigParser.java.

Referenced by com.quadcap.server.ServerConfigParser.endElement().

final int com.quadcap.server.ServerConfigParser.LOAD_ON_STARTUP = 6 [static, package]
 

Definition at line 131 of file ServerConfigParser.java.

Referenced by com.quadcap.server.ServerConfigParser.endElement().

Locator com.quadcap.server.ServerConfigParser.locator [package]
 

Definition at line 117 of file ServerConfigParser.java.

final int com.quadcap.server.ServerConfigParser.PARAM_NAME = 8 [static, package]
 

Definition at line 133 of file ServerConfigParser.java.

Referenced by com.quadcap.server.ServerConfigParser.endElement().

final int com.quadcap.server.ServerConfigParser.PARAM_VALUE = 9 [static, package]
 

Definition at line 134 of file ServerConfigParser.java.

Referenced by com.quadcap.server.ServerConfigParser.endElement().

String com.quadcap.server.ServerConfigParser.paramName = null [package]
 

Definition at line 122 of file ServerConfigParser.java.

Referenced by com.quadcap.server.ServerConfigParser.endElement().

String com.quadcap.server.ServerConfigParser.paramValue = null [package]
 

Definition at line 123 of file ServerConfigParser.java.

Referenced by com.quadcap.server.ServerConfigParser.endElement().

Parser com.quadcap.server.ServerConfigParser.parser [package]
 

Definition at line 116 of file ServerConfigParser.java.

Referenced by com.quadcap.server.ServerConfigParser.parse(), and com.quadcap.server.ServerConfigParser.ServerConfigParser().

Properties com.quadcap.server.ServerConfigParser.props = null [package]
 

Definition at line 121 of file ServerConfigParser.java.

Referenced by com.quadcap.server.ServerConfigParser.endElement(), and com.quadcap.server.ServerConfigParser.getProps().

final int com.quadcap.server.ServerConfigParser.SERVER = 1 [static, package]
 

Definition at line 126 of file ServerConfigParser.java.

Referenced by com.quadcap.server.ServerConfigParser.endElement().

final int com.quadcap.server.ServerConfigParser.SERVICE = 2 [static, package]
 

Definition at line 127 of file ServerConfigParser.java.

Referenced by com.quadcap.server.ServerConfigParser.endElement(), and com.quadcap.server.ServerConfigParser.startElement().

ServiceWrapper com.quadcap.server.ServerConfigParser.service = null [package]
 

Definition at line 120 of file ServerConfigParser.java.

Referenced by com.quadcap.server.ServerConfigParser.endElement(), and com.quadcap.server.ServerConfigParser.startElement().

final int com.quadcap.server.ServerConfigParser.SERVICE_CLASS = 4 [static, package]
 

Definition at line 129 of file ServerConfigParser.java.

Referenced by com.quadcap.server.ServerConfigParser.endElement().

final int com.quadcap.server.ServerConfigParser.SERVICE_CONFIG = 5 [static, package]
 

Definition at line 130 of file ServerConfigParser.java.

Referenced by com.quadcap.server.ServerConfigParser.endElement().

final int com.quadcap.server.ServerConfigParser.SERVICE_NAME = 3 [static, package]
 

Definition at line 128 of file ServerConfigParser.java.

Referenced by com.quadcap.server.ServerConfigParser.endElement().

ArrayList com.quadcap.server.ServerConfigParser.services = new ArrayList() [package]
 

Definition at line 119 of file ServerConfigParser.java.

Referenced by com.quadcap.server.ServerConfigParser.addServices(), and com.quadcap.server.ServerConfigParser.endElement().