* This component sets up the pipeline as follows: * * *
* __ __ * / |==> XNI2SAX --> Validator --> SAX2XNI ==>| * / | | * ==>| Tee| | next * \ | | component * \ |============other XNI events============>| * ~~ ~~ **
* only those events that need to go through Validator will go the 1st route, * and other events go the 2nd direct route. * * @author * Kohsuke Kawaguchi (kohsuke.kawaguchi@sun.com) */ public class JAXPValidatorComponent extends TeeXMLDocumentFilterImpl implements XMLComponent { // pipeline parts private final ValidatorHandler validator; private final XNI2SAX xni2sax = new XNI2SAX(); private final SAX2XNI sax2xni = new SAX2XNI(); // never be null private final TypeInfoProvider typeInfoProvider; /** * Used to store the {@link Augmentations} associated with the * current event, so that we can pick it up again * when the event is forwarded by the {@link ValidatorHandler}. * * UGLY HACK. */ private Augmentations fCurrentAug; /** * {@link XMLAttributes} version of {@link #fCurrentAug}. */ private XMLAttributes fCurrentAttributes; // components obtained from a manager / property private SymbolTable fSymbolTable; private XMLErrorReporter fErrorReporter; private XMLEntityResolver fEntityResolver; /** * @param validatorHandler * may not be null. */ public JAXPValidatorComponent( ValidatorHandler validatorHandler ) { this.validator = validatorHandler; TypeInfoProvider tip = validatorHandler.getTypeInfoProvider();; if(tip==null) tip = noInfoProvider; this.typeInfoProvider = tip; // configure wiring between internal components. xni2sax.setContentHandler(validator); validator.setContentHandler(sax2xni); this.setSide(xni2sax); // configure validator with proper EntityResolver/ErrorHandler. validator.setErrorHandler(new ErrorHandlerProxy() { protected XMLErrorHandler getErrorHandler() { XMLErrorHandler handler = fErrorReporter.getErrorHandler(); if(handler!=null) return handler; return new ErrorHandlerWrapper(DraconianErrorHandler.theInstance); } }); validator.setResourceResolver(new LSResourceResolver() { public LSInput resolveResource(String type,String ns, String publicId, String systemId, String baseUri) { if(fEntityResolver==null) return null; try { XMLInputSource is = fEntityResolver.resolveEntity( new XMLResourceIdentifierImpl(publicId,systemId,baseUri,systemId)); if(is==null) return null; LSInput di = new DOMInputImpl(); di.setBaseURI(is.getBaseSystemId()); di.setByteStream(is.getByteStream()); di.setCharacterStream(is.getCharacterStream()); di.setEncoding(is.getEncoding()); di.setPublicId(is.getPublicId()); di.setSystemId(is.getSystemId()); return di; } catch( IOException e ) { // erors thrown by the callback is not supposed to be // reported to users. throw new XNIException(e); } } }); } public void startElement(QName element, XMLAttributes attributes, Augmentations augs) throws XNIException { fCurrentAttributes = attributes; fCurrentAug = augs; xni2sax.startElement(element,attributes,null); fCurrentAttributes = null; // mostly to make it easy to find any bug. } public void endElement(QName element, Augmentations augs) throws XNIException { fCurrentAug = augs; xni2sax.endElement(element,null); } public void emptyElement(QName element, XMLAttributes attributes, Augmentations augs) throws XNIException { startElement(element,attributes,augs); endElement(element,augs); } public void characters(XMLString text, Augmentations augs) throws XNIException { // since a validator may change the contents, // let this one go through a validator fCurrentAug = augs; xni2sax.characters(text,null); } public void ignorableWhitespace(XMLString text, Augmentations augs) throws XNIException { // since a validator may change the contents, // let this one go through a validator fCurrentAug = augs; xni2sax.ignorableWhitespace(text,null); } public void reset(XMLComponentManager componentManager) throws XMLConfigurationException { // obtain references from the manager fSymbolTable = (SymbolTable)componentManager.getProperty( Constants.XERCES_PROPERTY_PREFIX + Constants.SYMBOL_TABLE_PROPERTY); fErrorReporter = (XMLErrorReporter)componentManager.getProperty( Constants.XERCES_PROPERTY_PREFIX + Constants.ERROR_REPORTER_PROPERTY); } /** * * Uses {@link DefaultHandler} as a default implementation of * {@link ContentHandler}. * *
* We only forward certain events from a {@link ValidatorHandler}. * Other events should go "the 2nd direct route". */ private final class SAX2XNI extends DefaultHandler { /** * {@link Augmentations} to send along with events. * We reuse one object for efficiency. */ private final Augmentations fAugmentations = new AugmentationsImpl(); /** * {@link QName} to send along events. * we reuse one QName for efficiency. */ private final QName fQName = new QName(); public void characters(char[] ch, int start, int len) throws SAXException { try { handler().characters(new XMLString(ch,start,len),aug()); } catch( XNIException e ) { throw toSAXException(e); } } public void ignorableWhitespace(char[] ch, int start, int len) throws SAXException { try { handler().ignorableWhitespace(new XMLString(ch,start,len),aug()); } catch( XNIException e ) { throw toSAXException(e); } } public void startElement(String uri, String localName, String qname, Attributes atts) throws SAXException { try { updateAttributes(atts); handler().startElement(toQName(uri,localName,qname), fCurrentAttributes, elementAug()); } catch( XNIException e ) { throw toSAXException(e); } } public void endElement(String uri, String localName, String qname) throws SAXException { try { handler().endElement(toQName(uri,localName,qname),aug()); } catch( XNIException e ) { throw toSAXException(e); } } private Augmentations elementAug() { Augmentations aug = aug(); aug.putItem(Constants.TYPEINFO,typeInfoProvider.getElementTypeInfo()); return aug; } /** * Gets the {@link Augmentations} that should be associated with * the current event. */ private Augmentations aug() { if( fCurrentAug!=null ) { Augmentations r = fCurrentAug; fCurrentAug = null; // we "consumed" this augmentation. return r; } fAugmentations.removeAllItems(); return fAugmentations; } /** * Get the handler to which we should send events. */ private XMLDocumentHandler handler() { return JAXPValidatorComponent.this.getDocumentHandler(); } /** * Converts the {@link XNIException} received from a downstream * component to a {@link SAXException}. */ private SAXException toSAXException( XNIException xe ) { Exception e = xe.getException(); if( e==null ) e = xe; if( e instanceof SAXException ) return (SAXException)e; return new SAXException(e); } /** * Creates a proper {@link QName} object from 3 parts. *
* This method does the symbolization.
*/
private QName toQName( String uri, String localName, String qname ) {
String prefix = null;
int idx = qname.indexOf(':');
if( idx>0 )
prefix = symbolize(qname.substring(0,idx));
localName = symbolize(localName);
qname = symbolize(qname);
uri = symbolize(uri);
// notify handlers
fQName.setValues(prefix, localName, qname, uri);
return fQName;
}
}
/**
* Compares the given {@link Attributes} with {@link #fCurrentAttributes}
* and update the latter accordingly.
*/
private void updateAttributes( Attributes atts ) {
int len = atts.getLength();
for( int i=0; i