Package com.verisign.epp.util

Class EPPSchemaCachingParser

java.lang.Object
javax.xml.parsers.DocumentBuilder
com.verisign.epp.util.EPPSchemaCachingParser
All Implemented Interfaces:
EPPSchemaCacher
Direct Known Subclasses:
EPPStrictContactParser, EPPXMLSignatureSchemaCachingParser
public class EPPSchemaCachingParser extends DocumentBuilder implements EPPSchemaCacher
XML Parser that pre-caches the XML schemas from the XML schemas registered in the EPPFactory for improved XML parsing performance.

  • Field Details

    • POOL

      public static final String POOL
      Name of the EPP XML Parser Pool managed by GenericPoolManager
      See Also:

    • BIG_PRIME

      public static final int BIG_PRIME
      A default prime number to use for the SymbolTable size. Some other sample big primes: 1299709 1299721 1299743 1299763 1299791 1299811 1299817 1299821 1299827
      See Also:

    • NAMESPACES_FEATURE_ID

      public static final String NAMESPACES_FEATURE_ID
      Namespaces feature id (http://xml.org/sax/features/namespaces). \
      See Also:

    • VALIDATION_FEATURE_ID

      public static final String VALIDATION_FEATURE_ID
      Validation feature id (http://xml.org/sax/features/validation).
      See Also:

    • SCHEMA_VALIDATION_FEATURE_ID

      public static final String SCHEMA_VALIDATION_FEATURE_ID
      Schema validation feature id (http://apache.org/xml/features/validation/schema).
      See Also:

    • SCHEMA_FULL_CHECKING_FEATURE_ID

      public static final String SCHEMA_FULL_CHECKING_FEATURE_ID
      Schema full checking feature id (http://apache.org/xml/features/validation/schema-full-checking). Enable full schema grammar constraint checking, including checking which may be time-consuming or memory intensive. Currently, particle unique attribution constraint checking and particle derivation resriction checking are controlled by this option.
      See Also:

    • XMLGRAMMAR_POOL

      public static final String XMLGRAMMAR_POOL
      Property identifier: The XML Grammar pool feature
      See Also:

    • SYMBOL_TABLE

      protected static final String SYMBOL_TABLE
      Property identifier: The symbol table feature
      See Also:

    • DEFER_NODE_EXPANSION

      public static final String DEFER_NODE_EXPANSION
      Constant for setting the defer node expansion parser feature. The recommendation is to set this to false for EPP packets since the are not large documents.
      See Also:

    • LOAD_EXTERNAL_DTD

      public static final String LOAD_EXTERNAL_DTD
      Apache constant for loading external DTD's when they are seen in the instance document
      See Also:

    • LOAD_DTD_GRAMMAR

      public static final String LOAD_DTD_GRAMMAR
      Load the DTD and use it to add default attributes and set attribute types when parsing. False: Build the grammar but do not use the default attributes and attribute types information it contains.
      See Also:

    • CREATE_ENTITY_REF_NODES

      public static final String CREATE_ENTITY_REF_NODES
      Create EntityReference nodes in the DOM tree. The EntityReference nodes and their child nodes will be read-only. False: Do not create EntityReference nodes in the DOM tree. No EntityReference nodes will be created, only the nodes corresponding to their fully expanded substitution text will be created
      See Also:

    • INCLUDE_IGNORABLE_WHITE_SPACE

      public static final String INCLUDE_IGNORABLE_WHITE_SPACE
      Include text nodes that can be considered "ignorable whitespace" in the DOM tree. False: Do not include ignorable whitespace in the DOM tree.
      See Also:

    • EXTERNAL_GENERAL_ENTITIES

      public static final String EXTERNAL_GENERAL_ENTITIES
      If DTDs (doctypes) are disallowed, almost all XML entity attacks are prevented
      See Also:

    • EXTERNAL_PARAMETER_ENTITIES

      public static final String EXTERNAL_PARAMETER_ENTITIES
      Include external parameter entities and the external DTD subset. False: Do not include external parameter entities or the external DTD subset.
      See Also:

    • NORMALIZE_DATA

      public static final String NORMALIZE_DATA
      attempt to normalize data in an entity reference or CDATA section. To preserve character data within entity references and CDATA sections, turn off http://apache.org/xml/features/validation/schema/normalized-value feature.
      See Also:

    • DISALLOW_DOCTYPE_DECL

      public static final String DISALLOW_DOCTYPE_DECL
      If DTDs (doctypes) are disallowed, almost all XML entity attacks are prevented
      See Also:

  • Constructor Details

    • EPPSchemaCachingParser

      public EPPSchemaCachingParser()
      Create a new instance of EPPSchemaCachingParser. Defaults are: Namespace aware: true Validation: true Schema Validation: true Full Schema checking: true

    • EPPSchemaCachingParser

      public EPPSchemaCachingParser(int aSymbolTableSize)
      Creates an EPPSchemaCachingParser instance with the specified symbol table size.
      Parameters:
      aSymbolTableSize - Size of the symbol table

  • Method Details

    • init

      protected void init() throws EPPParserException
      Helper method to initialize this instance of EPPSchemaCachingParser.
      Throws:
      EPPParserException - Error initializing EPPSchemaCachingParser

    • getXmlSchemas

      protected Set<String> getXmlSchemas()
      Gets the XML schemas to pre-load into the XML parser. Derived classes can override this method to pre-load a custom set of XML schemas.
      Returns:
      XML schema names to pre-load

    • preloadSchemas

      protected void preloadSchemas() throws EPPParserException
      Pre-load the XML schemas into the parser based on the EPPFactory XML schemas. A derived class can customize what XML schemas to pre-load.
      Throws:
      EPPParserException - Error loading the XML schemas into the parser

    • setLockSchemaCache

      public void setLockSchemaCache(boolean aBoolean)
      Lock the schema cache. True param locks it, false unlocks it
      Specified by:
      setLockSchemaCache in interface EPPSchemaCacher
      Parameters:
      aBoolean - True param locks it, false unlocks it

    • addSchemaToCache

      public void addSchemaToCache(org.apache.xerces.xni.parser.XMLInputSource aSchema) throws EPPParserException
      Addes the XMLInputSource instance to the current cache of schemas. Only addes the schema to the cache if it isn't already in the cache.
      Specified by:
      addSchemaToCache in interface EPPSchemaCacher
      Parameters:
      aSchema - The schema instance to be cached
      Throws:
      EPPParserException - Error adding schema to the cache

    • isNamespaceAware

      public boolean isNamespaceAware()
      Returns true if the parser is setup to be Namespace aware, false otherwise.
      Specified by:
      isNamespaceAware in class DocumentBuilder
      Returns:
      true if the parser is setup to be Namespace aware, false otherwise.
      Throws:
      IllegalStateException - Parser is not in a state to query it's properties

    • setEntityResolver

      public void setEntityResolver(EntityResolver aEntityResolver)
      Sets the EntityResolver of this DocumentBuilder
      Specified by:
      setEntityResolver in class DocumentBuilder
      Parameters:
      aEntityResolver - The EntityResolver instance that this DocumentBuilder will use when parsing.

    • getDOMImplementation

      public DOMImplementation getDOMImplementation()
      Returns the DOM implementation
      Specified by:
      getDOMImplementation in class DocumentBuilder
      Returns:
      the DOM implementation

    • newDocument

      public Document newDocument()
      Non-preferred: use the getDOMImplementation() method instead of this one to get a DOM Level 2 DOMImplementation object and then use DOM Level 2 methods to create a DOM Document object.
      Specified by:
      newDocument in class DocumentBuilder
      Returns:
      DOM Document

    • parse

      public Document parse(InputSource aXmlInstance) throws SAXException, IOException
      Parses the InputSource passed in which should be an XML instance. Returns a DOM document.
      Specified by:
      parse in class DocumentBuilder
      Parameters:
      aXmlInstance - The XML instance to parse
      Returns:
      The DOM Document that represents the XML instance
      Throws:
      SAXException - Thrown if any errors occur
      IOException - Thrown if any errors occur
      IllegalArgumentException - DOCUMENT ME!

    • parse

      public Document parse(InputStream aInputStream, String aSystemId) throws SAXException, IOException
      Implemented as part of standard Document Builder API. Delegates to DOMParser
      Overrides:
      parse in class DocumentBuilder
      Parameters:
      aInputStream - The InputStream instance to parse
      aSystemId - XML System Id
      Returns:
      The DOM Document created after the parsing episode
      Throws:
      SAXException - Error parsing XML
      IOException - Error processing input

    • parse

      public Document parse(String aUri) throws SAXException, IOException
      Implemented as part of standard Document Builder API. Delegates to DOMParser
      Overrides:
      parse in class DocumentBuilder
      Parameters:
      aUri - The URI to parse
      Returns:
      The DOM Document created after the parsing episode
      Throws:
      SAXException - Error parsing XML
      IOException - Error processing input

    • parse

      public Document parse(InputStream aInputStream) throws SAXException, IOException
      Implemented as part of standard Document Builder API. Delegates to DOMParser
      Overrides:
      parse in class DocumentBuilder
      Parameters:
      aInputStream - The InputStream to parse
      Returns:
      The DOM Document created after parsing the stream
      Throws:
      SAXException - Error parsing XML
      IOException - Error processing input

    • parse

      public Document parse(File aFile) throws SAXException, IOException
      Parse a file to a DOM Document.
      Overrides:
      parse in class DocumentBuilder
      Parameters:
      aFile - XML file to parse to a DOM Document
      Returns:
      The DOM Document created after parsing the file
      Throws:
      IOException - Error opening XML file
      SAXException - Error parsing XML file

    • setErrorHandler

      public void setErrorHandler(ErrorHandler aErrorHandler)
      Sets the ErrorHandler this DocumentBuilder instance.
      Specified by:
      setErrorHandler in class DocumentBuilder
      Parameters:
      aErrorHandler - The ErrorHandler instance to use

    • isValidating

      public boolean isValidating()
      Returns true if this parser is setup to validate XML instances, false otherwise
      Specified by:
      isValidating in class DocumentBuilder
      Returns:
      Returns true if this parser is setup to validate XML instances, false otherwise
      Throws:
      IllegalStateException - Error setting the validation feature

    • getSymbolTableSize

      public int getSymbolTableSize()
      Gets the symbol table size
      Returns:
      the symbol table size

    • setSymbolTableSize

      public void setSymbolTableSize(int aSymbolTableSize) throws EPPParserException
      Sets the symbol table size. If set to 0 then the symbol table size will use the default provided with the ParserConfiguration.
      Parameters:
      aSymbolTableSize - The new value of the symbol table size
      Throws:
      EPPParserException - Error setting the symbol table size

    • setFeature

      public void setFeature(String aFeatureId, boolean aBoolean) throws SAXNotSupportedException, SAXNotRecognizedException
      Set the state of any feature in a SAX2 parser. The parser might not recognize the feature, and if it does recognize it, it might not be able to fulfill the request.
      Parameters:
      aFeatureId - The unique identifier (URI) of the feature.
      aBoolean - The requested state of the feature (true or false).
      Throws:
      SAXNotSupportedException - If the requested feature is known, but the requested state is not supported.
      SAXNotRecognizedException - If the requested feature is not known.

    • setProperty

      public void setProperty(String aProperty, Object aObject) throws SAXNotSupportedException, SAXNotRecognizedException
      Set the state of any property in a SAX2 parser. The parser might not recognize the feature, and if it does recognize it, it might not be able to fulfill the request.
      Parameters:
      aProperty - The unique identifier (URI) of the feature.
      aObject - The requested state of the feature (true or false).
      Throws:
      SAXNotSupportedException - If the requested feature is known, but the requested state is not supported.
      SAXNotRecognizedException - If the requested feature is not known.

    • getFeature

      public boolean getFeature(String aFeatureId) throws SAXNotSupportedException, SAXNotRecognizedException
      Query the state of a feature. Query the current state of any feature in a SAX2 parser. The parser might not recognize the feature.
      Parameters:
      aFeatureId - The unique identifier (URI) of the feature being set.
      Returns:
      The current state of the feature.
      Throws:
      SAXNotSupportedException - If the requested feature is known but not supported.
      SAXNotRecognizedException - If the requested feature is not known.

    • getProperty

      public Object getProperty(String aPropertyId) throws SAXNotSupportedException, SAXNotRecognizedException
      Query the value of a property. Return the current value of a property in a SAX2 parser. The parser might not recognize the property.
      Parameters:
      aPropertyId - The unique identifier (URI) of the property being set.
      Returns:
      The current value of the property.
      Throws:
      SAXNotSupportedException - If the requested property is known but not supported.
      SAXNotRecognizedException - If the requested property is not known.