- /*
- * The Apache Software License, Version 1.1
- *
- *
- * Copyright (c) 2001-2003 The Apache Software Foundation. All rights
- * reserved.
- *
- * Redistribution and use in source and binary forms, with or without
- * modification, are permitted provided that the following conditions
- * are met:
- *
- * 1. Redistributions of source code must retain the above copyright
- * notice, this list of conditions and the following disclaimer.
- *
- * 2. Redistributions in binary form must reproduce the above copyright
- * notice, this list of conditions and the following disclaimer in
- * the documentation and/or other materials provided with the
- * distribution.
- *
- * 3. The end-user documentation included with the redistribution,
- * if any, must include the following acknowledgment:
- * "This product includes software developed by the
- * Apache Software Foundation (http://www.apache.org/)."
- * Alternately, this acknowledgment may appear in the software itself,
- * if and wherever such third-party acknowledgments normally appear.
- *
- * 4. The names "Xerces" and "Apache Software Foundation" must
- * not be used to endorse or promote products derived from this
- * software without prior written permission. For written
- * permission, please contact apache@apache.org.
- *
- * 5. Products derived from this software may not be called "Apache",
- * nor may "Apache" appear in their name, without prior written
- * permission of the Apache Software Foundation.
- *
- * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
- * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
- * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
- * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
- * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
- * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
- * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
- * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
- * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
- * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
- * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
- * SUCH DAMAGE.
- * ====================================================================
- *
- * This software consists of voluntary contributions made by many
- * individuals on behalf of the Apache Software Foundation and was
- * originally based on software copyright (c) 2003, International
- * Business Machines, Inc., http://www.apache.org. For more
- * information on the Apache Software Foundation, please see
- * <http://www.apache.org/>.
- */
- package com.sun.org.apache.xerces.internal.parsers;
-
- import com.sun.org.apache.xerces.internal.impl.Constants;
- import com.sun.org.apache.xerces.internal.util.SymbolTable;
- import com.sun.org.apache.xerces.internal.xinclude.XIncludeHandler;
- import com.sun.org.apache.xerces.internal.xinclude.XIncludeNamespaceSupport;
- import com.sun.org.apache.xerces.internal.xni.XMLDocumentHandler;
- import com.sun.org.apache.xerces.internal.xni.grammars.XMLGrammarPool;
- import com.sun.org.apache.xerces.internal.xni.parser.XMLComponentManager;
- import com.sun.org.apache.xerces.internal.xni.parser.XMLConfigurationException;
- import com.sun.org.apache.xerces.internal.xni.parser.XMLDocumentSource;
-
- /**
- * This parser configuration includes an <code>XIncludeHandler</code> in the pipeline
- * before the schema validator, or as the last component in the pipeline if there is
- * no schema validator. Using this pipeline will enable processing according to the
- * XML Inclusions specification, to the conformance level described in
- * <code>XIncludeHandler</code>.
- *
- * @author Peter McCracken, IBM
- * @author Arun Yadav, Sun Microsystem
- * @see com.sun.org.apache.xerces.internal.xinclude.XIncludeHandler
- */
- public class XIncludeParserConfiguration extends XML11Configuration {
-
- private XIncludeHandler fXIncludeHandler;
-
- /** Feature identifier: allow notation and unparsed entity events to be sent out of order. */
- protected static final String ALLOW_UE_AND_NOTATION_EVENTS =
- Constants.SAX_FEATURE_PREFIX + Constants.ALLOW_DTD_EVENTS_AFTER_ENDDTD_FEATURE;
-
- /** Feature identifier: XInclude Aware */
- protected static final String XINCLUDE_AWARE =
- Constants.XERCES_FEATURE_PREFIX + Constants.XINCLUDE_AWARE ;
-
-
- /** Property identifier: error reporter. */
- protected static final String XINCLUDE_HANDLER =
- Constants.XERCES_PROPERTY_PREFIX + Constants.XINCLUDE_HANDLER_PROPERTY;
-
- /** Property identifier: error reporter. */
- protected static final String NAMESPACE_CONTEXT =
- Constants.XERCES_PROPERTY_PREFIX + Constants.NAMESPACE_CONTEXT_PROPERTY;
-
-
- private boolean enableXInclude = false;
-
- /** Default constructor. */
- public XIncludeParserConfiguration() {
- this(null, null, null);
- } // <init>()
-
- /**
- * Constructs a parser configuration using the specified symbol table.
- *
- * @param symbolTable The symbol table to use.
- */
- public XIncludeParserConfiguration(SymbolTable symbolTable) {
- this(symbolTable, null, null);
- } // <init>(SymbolTable)
-
- /**
- * Constructs a parser configuration using the specified symbol table and
- * grammar pool.
- * <p>
- *
- * @param symbolTable The symbol table to use.
- * @param grammarPool The grammar pool to use.
- */
- public XIncludeParserConfiguration(
- SymbolTable symbolTable,
- XMLGrammarPool grammarPool) {
- this(symbolTable, grammarPool, null);
- } // <init>(SymbolTable,XMLGrammarPool)
-
- /**
- * Constructs a parser configuration using the specified symbol table,
- * grammar pool, and parent settings.
- * <p>
- *
- * @param symbolTable The symbol table to use.
- * @param grammarPool The grammar pool to use.
- * @param parentSettings The parent settings.
- */
- public XIncludeParserConfiguration(
- SymbolTable symbolTable,
- XMLGrammarPool grammarPool,
- XMLComponentManager parentSettings) {
- super(symbolTable, grammarPool, parentSettings);
-
-
- //add default recognized features
- final String[] recognizedFeatures = {
- ALLOW_UE_AND_NOTATION_EVENTS,
- XINCLUDE_AWARE
- };
- addRecognizedFeatures(recognizedFeatures);
- // add default recognized properties
- fXIncludeHandler = new XIncludeHandler();
- addComponent(fXIncludeHandler);
- final String[] recognizedProperties = {
- XINCLUDE_HANDLER,
- NAMESPACE_CONTEXT
- };
-
- addRecognizedProperties(recognizedProperties);
- setProperty(XINCLUDE_HANDLER, fXIncludeHandler);
- setProperty(NAMESPACE_CONTEXT, new XIncludeNamespaceSupport());
- setFeature(ALLOW_UE_AND_NOTATION_EVENTS, true);
- setFeature(XINCLUDE_AWARE, false);
- } // <init>(SymbolTable,XMLGrammarPool)
-
-
- /** Configures the pipeline. */
- protected void configurePipeline() {
- super.configurePipeline();
- if(enableXInclude){
- //configure DTD pipeline
- fDTDScanner.setDTDHandler(fDTDProcessor);
- fDTDProcessor.setDTDSource(fDTDScanner);
- fDTDProcessor.setDTDHandler(fXIncludeHandler);
- fXIncludeHandler.setDTDSource(fDTDProcessor);
- fXIncludeHandler.setDTDHandler(fDTDHandler);
- if (fDTDHandler != null) {
- fDTDHandler.setDTDSource(fXIncludeHandler);
- }
-
- // configure XML document pipeline: insert after DTDValidator and
- // before XML Schema validator
- XMLDocumentSource prev = null;
- if (fFeatures.get(XMLSCHEMA_VALIDATION) == Boolean.TRUE) {
- // we don't have to worry about fSchemaValidator being null, since
- // super.configurePipeline() instantiated it if the feature was set
- prev = fSchemaValidator.getDocumentSource();
- }
- // Otherwise, insert after the last component in the pipeline
- else {
- prev = fLastComponent;
- fLastComponent = fXIncludeHandler;
- }
-
- if (prev != null) {
- XMLDocumentHandler next = prev.getDocumentHandler();
- if (next != null) {
- fXIncludeHandler.setDocumentHandler(next);
- next.setDocumentSource(fXIncludeHandler);
- }
- prev.setDocumentHandler(fXIncludeHandler);
- fXIncludeHandler.setDocumentSource(prev);
- }
- else {
- setDocumentHandler(fXIncludeHandler);
- }
- }
- } // configurePipeline()
-
- protected void configureXML11Pipeline() {
- super.configureXML11Pipeline();
- if(enableXInclude){
- addXML11Component(fXIncludeHandler);
- // configure XML 1.1. DTD pipeline
- fXML11DTDScanner.setDTDHandler(fXML11DTDProcessor);
- fXML11DTDProcessor.setDTDSource(fXML11DTDScanner);
- fXML11DTDProcessor.setDTDHandler(fXIncludeHandler);
- fXIncludeHandler.setDTDSource(fXML11DTDProcessor);
- fXIncludeHandler.setDTDHandler(fDTDHandler);
- if (fDTDHandler != null) {
- fDTDHandler.setDTDSource(fXIncludeHandler);
- }
-
- // configure XML document pipeline: insert after DTDValidator and
- // before XML Schema validator
- XMLDocumentSource prev = null;
- if (fFeatures.get(XMLSCHEMA_VALIDATION) == Boolean.TRUE) {
- // we don't have to worry about fSchemaValidator being null, since
- // super.configurePipeline() instantiated it if the feature was set
- prev = fSchemaValidator.getDocumentSource();
- }
- // Otherwise, insert after the last component in the pipeline
- else {
- prev = fLastComponent;
- fLastComponent = fXIncludeHandler;
- }
-
- XMLDocumentHandler next = prev.getDocumentHandler();
- prev.setDocumentHandler(fXIncludeHandler);
- fXIncludeHandler.setDocumentSource(prev);
- if (next != null) {
- fXIncludeHandler.setDocumentHandler(next);
- next.setDocumentSource(fXIncludeHandler);
- }
- }
- } // configureXML11Pipeline()
-
- public void setProperty(String propertyId, Object value)
- throws XMLConfigurationException {
-
- if (propertyId.equals(XINCLUDE_HANDLER)) {
- }
-
- super.setProperty(propertyId, value);
- } // setProperty(String,Object)
-
- public void setFeature(String featureId, boolean state)
- throws XMLConfigurationException {
- if(featureId.equals(Constants.XERCES_FEATURE_PREFIX + Constants.XINCLUDE_AWARE)){
- enableXInclude = state;
- }
- super.setFeature(featureId,state);
- }
- }