org.apache.xerces.impl

Class XMLEntityManager

Implemented Interfaces:
org.apache.xerces.xni.parser.XMLComponent, org.apache.xerces.xni.parser.XMLEntityResolver

public class XMLEntityManager
extends java.lang.Object
implements org.apache.xerces.xni.parser.XMLComponent, org.apache.xerces.xni.parser.XMLEntityResolver

The entity manager handles the registration of general and parameter entities; resolves entities; and starts entities. The entity manager is a central component in a standard parser configuration and this class works directly with the entity scanner to manage the underlying xni.

This component requires the following features and properties from the component manager that uses it:

Version:
$Id: XMLEntityManager.java 443118 2006-09-13 20:52:53Z mrglavas $
Authors:
Andy Clark, IBM
Arnaud Le Hors, IBM

Nested Class Summary

static class
XMLEntityManager.Entity
Entity information.
protected static class
XMLEntityManager.ExternalEntity
External entity.
protected static class
XMLEntityManager.InternalEntity
Internal entity.
protected class
XMLEntityManager.RewindableInputStream
This class wraps the byte inputstreams we're presented with.
class
XMLEntityManager.ScannedEntity
Entity state.

Field Summary

protected static String
ALLOW_JAVA_ENCODINGS
Feature identifier: allow Java encodings.
protected static String
BUFFER_SIZE
property identifier: buffer size.
static int
DEFAULT_BUFFER_SIZE
Default buffer size (2048).
static int
DEFAULT_INTERNAL_BUFFER_SIZE
Default internal entity buffer size (512).
static int
DEFAULT_XMLDECL_BUFFER_SIZE
Default buffer size before we've finished with the XMLDecl:
protected static String
ENTITY_RESOLVER
Property identifier: entity resolver.
protected static String
ERROR_REPORTER
Property identifier: error reporter.
protected static String
EXTERNAL_GENERAL_ENTITIES
Feature identifier: external general entities.
protected static String
EXTERNAL_PARAMETER_ENTITIES
Feature identifier: external parameter entities.
protected static String
PARSER_SETTINGS
protected static String
SECURITY_MANAGER
property identifier: security manager.
protected static String
STANDARD_URI_CONFORMANT
Feature identifier: standard uri conformant
protected static String
SYMBOL_TABLE
Property identifier: symbol table.
protected static String
VALIDATION
Feature identifier: validation.
protected static String
VALIDATION_MANAGER
protected static String
WARN_ON_DUPLICATE_ENTITYDEF
Feature identifier: warn on duplicate EntityDef
protected boolean
fAllowJavaEncodings
Allow Java encoding names.
protected int
fBufferSize
Buffer size.
protected XMLEntityManager.ScannedEntity
fCurrentEntity
Current entity.
protected Hashtable
fDeclaredEntities
Shared declared entities.
protected Hashtable
fEntities
Entities.
protected int
fEntityExpansionCount
protected int
fEntityExpansionLimit
protected XMLEntityHandler
fEntityHandler
Entity handler.
protected org.apache.xerces.xni.parser.XMLEntityResolver
fEntityResolver
Entity resolver.
protected XMLEntityScanner
fEntityScanner
Current entity scanner.
protected Stack
fEntityStack
Entity stack.
protected XMLErrorReporter
fErrorReporter
Error reporter.
protected boolean
fExternalGeneralEntities
External general entities.
protected boolean
fExternalParameterEntities
External parameter entities.
protected boolean
fInExternalSubset
protected Stack
fReaderStack
protected SecurityManager
fSecurityManager
protected boolean
fStandalone
True if the document entity is standalone.
protected boolean
fStrictURI
standard uri conformant (strict uri).
protected SymbolTable
fSymbolTable
Symbol table.
protected boolean
fValidation
Validation.
protected ValidationManager
fValidationManager
Validation manager.
protected boolean
fWarnDuplicateEntityDef
warn on duplicate Entity declaration.
protected XMLEntityScanner
fXML10EntityScanner
XML 1.0 entity scanner.
protected XMLEntityScanner
fXML11EntityScanner
XML 1.1 entity scanner.

Constructor Summary

XMLEntityManager()
Default constructor.
XMLEntityManager(XMLEntityManager entityManager)
Constructs an entity manager that shares the specified entity declarations during each parse.

Method Summary

static void
absolutizeAgainstUserDir(URI uri)
Absolutizes a URI using the current value of the "user.dir" property as the base URI.
void
addExternalEntity(String name, String publicId, String literalSystemId, String baseSystemId)
Adds an external entity declaration.
void
addInternalEntity(String name, String text)
Adds an internal entity declaration.
void
addUnparsedEntity(String name, String publicId, String systemId, String baseSystemId, String notation)
Adds an unparsed entity declaration.
void
closeReaders()
Close all opened InputStreams and Readers opened by this parser.
protected Reader
createReader(InputStream inputStream, String encoding, Boolean isBigEndian)
Creates a reader capable of reading the given input stream in the specified encoding.
void
endExternalSubset()
static String
expandSystemId(String systemId, String baseSystemId, boolean strict)
Expands a system id and returns the system id as a URI, if it can be expanded.
protected static String
fixURI(String str)
Fixes a platform dependent filename to standard URI form.
XMLEntityManager.ScannedEntity
getCurrentEntity()
org.apache.xerces.xni.XMLResourceIdentifier
getCurrentResourceIdentifier()
protected Object[]
getEncodingName(byte[] b4, int count)
Returns the IANA encoding name that is auto-detected from the bytes specified, with the endian-ness of that encoding where appropriate.
XMLEntityScanner
getEntityScanner()
Returns the entity scanner.
Boolean
getFeatureDefault(String featureId)
Returns the default state for a feature, or null if this component does not want to report a default value for this feature.
Object
getPropertyDefault(String propertyId)
Returns the default state for a property, or null if this component does not want to report a default value for this property.
String[]
getRecognizedFeatures()
Returns a list of feature identifiers that are recognized by this component.
String[]
getRecognizedProperties()
Returns a list of property identifiers that are recognized by this component.
boolean
isDeclaredEntity(String entityName)
Checks whether an entity given by name is declared.
boolean
isEntityDeclInExternalSubset(String entityName)
Checks whether the declaration of an entity given by name is // in the external subset.
boolean
isExternalEntity(String entityName)
Checks whether an entity given by name is external.
boolean
isStandalone()
Returns true if the document entity is standalone.
boolean
isUnparsedEntity(String entityName)
Checks whether an entity given by name is unparsed.
void
reset()
void
reset(org.apache.xerces.xni.parser.XMLComponentManager componentManager)
Resets the component.
org.apache.xerces.xni.parser.XMLInputSource
resolveEntity(org.apache.xerces.xni.XMLResourceIdentifier resourceIdentifier)
Resolves the specified public and system identifiers.
void
setEntityHandler(XMLEntityHandler entityHandler)
Sets the entity handler.
void
setFeature(String featureId, boolean state)
Sets the state of a feature.
static void
setInstanceFollowRedirects(HttpURLConnection urlCon, boolean followRedirects)
Attempt to set whether redirects will be followed for an HttpURLConnection.
void
setProperty(String propertyId, Object value)
Sets the value of a property.
void
setScannerVersion(short version)
void
setStandalone(boolean standalone)
Sets whether the document entity is standalone.
String
setupCurrentEntity(String name, org.apache.xerces.xni.parser.XMLInputSource xmlInputSource, boolean literal, boolean isExternal)
This method uses the passed-in XMLInputSource to make fCurrentEntity usable for reading.
void
startDTDEntity(org.apache.xerces.xni.parser.XMLInputSource xmlInputSource)
Starts the DTD entity.
void
startDocumentEntity(org.apache.xerces.xni.parser.XMLInputSource xmlInputSource)
Starts the document entity.
void
startEntity(String entityName, boolean literal)
Starts a named entity.
void
startEntity(String name, org.apache.xerces.xni.parser.XMLInputSource xmlInputSource, boolean literal, boolean isExternal)
Starts an entity.
void
startExternalSubset()

Field Details

ALLOW_JAVA_ENCODINGS

protected static final String ALLOW_JAVA_ENCODINGS
Feature identifier: allow Java encodings.

BUFFER_SIZE

protected static final String BUFFER_SIZE
property identifier: buffer size.

DEFAULT_BUFFER_SIZE

public static final int DEFAULT_BUFFER_SIZE
Default buffer size (2048).
Field Value:
2048

DEFAULT_INTERNAL_BUFFER_SIZE

public static final int DEFAULT_INTERNAL_BUFFER_SIZE
Default internal entity buffer size (512).
Field Value:
512

DEFAULT_XMLDECL_BUFFER_SIZE

public static final int DEFAULT_XMLDECL_BUFFER_SIZE
Default buffer size before we've finished with the XMLDecl:
Field Value:
64

ENTITY_RESOLVER

protected static final String ENTITY_RESOLVER
Property identifier: entity resolver.

ERROR_REPORTER

protected static final String ERROR_REPORTER
Property identifier: error reporter.

EXTERNAL_GENERAL_ENTITIES

protected static final String EXTERNAL_GENERAL_ENTITIES
Feature identifier: external general entities.

EXTERNAL_PARAMETER_ENTITIES

protected static final String EXTERNAL_PARAMETER_ENTITIES
Feature identifier: external parameter entities.

PARSER_SETTINGS

protected static final String PARSER_SETTINGS

SECURITY_MANAGER

protected static final String SECURITY_MANAGER
property identifier: security manager.

STANDARD_URI_CONFORMANT

protected static final String STANDARD_URI_CONFORMANT
Feature identifier: standard uri conformant

SYMBOL_TABLE

protected static final String SYMBOL_TABLE
Property identifier: symbol table.

VALIDATION

protected static final String VALIDATION
Feature identifier: validation.

VALIDATION_MANAGER

protected static final String VALIDATION_MANAGER

WARN_ON_DUPLICATE_ENTITYDEF

protected static final String WARN_ON_DUPLICATE_ENTITYDEF
Feature identifier: warn on duplicate EntityDef

fAllowJavaEncodings

protected boolean fAllowJavaEncodings
Allow Java encoding names. This feature identifier is: http://apache.org/xml/features/allow-java-encodings

fBufferSize

protected int fBufferSize
Buffer size. We get this value from a property. The default size is used if the input buffer size property is not specified. REVISIT: do we need a property for internal entity buffer size?

fCurrentEntity

protected XMLEntityManager.ScannedEntity fCurrentEntity
Current entity.

fDeclaredEntities

protected Hashtable fDeclaredEntities
Shared declared entities.

fEntities

protected Hashtable fEntities
Entities.

fEntityExpansionCount

protected int fEntityExpansionCount

fEntityExpansionLimit

protected int fEntityExpansionLimit

fEntityHandler

protected XMLEntityHandler fEntityHandler
Entity handler.

fEntityResolver

protected org.apache.xerces.xni.parser.XMLEntityResolver fEntityResolver
Entity resolver. This property identifier is: http://apache.org/xml/properties/internal/entity-resolver

fEntityScanner

protected XMLEntityScanner fEntityScanner
Current entity scanner.

fEntityStack

protected Stack fEntityStack
Entity stack.

fErrorReporter

protected XMLErrorReporter fErrorReporter
Error reporter. This property identifier is: http://apache.org/xml/properties/internal/error-reporter

fExternalGeneralEntities

protected boolean fExternalGeneralEntities
External general entities. This feature identifier is: http://xml.org/sax/features/external-general-entities

fExternalParameterEntities

protected boolean fExternalParameterEntities
External parameter entities. This feature identifier is: http://xml.org/sax/features/external-parameter-entities

fInExternalSubset

protected boolean fInExternalSubset

fReaderStack

protected Stack fReaderStack

fSecurityManager

protected SecurityManager fSecurityManager

fStandalone

protected boolean fStandalone
True if the document entity is standalone. This should really only be set by the document source (e.g. XMLDocumentScanner).

fStrictURI

protected boolean fStrictURI
standard uri conformant (strict uri). http://apache.org/xml/features/standard-uri-conformant

fSymbolTable

protected SymbolTable fSymbolTable
Symbol table. This property identifier is: http://apache.org/xml/properties/internal/symbol-table

fValidation

protected boolean fValidation
Validation. This feature identifier is: http://xml.org/sax/features/validation

fValidationManager

protected ValidationManager fValidationManager
Validation manager. This property identifier is: http://apache.org/xml/properties/internal/validation-manager

fWarnDuplicateEntityDef

protected boolean fWarnDuplicateEntityDef
warn on duplicate Entity declaration. http://apache.org/xml/features/warn-on-duplicate-entitydef

fXML10EntityScanner

protected XMLEntityScanner fXML10EntityScanner
XML 1.0 entity scanner.

fXML11EntityScanner

protected XMLEntityScanner fXML11EntityScanner
XML 1.1 entity scanner.

Constructor Details

XMLEntityManager

public XMLEntityManager()
Default constructor.

XMLEntityManager

public XMLEntityManager(XMLEntityManager entityManager)
Constructs an entity manager that shares the specified entity declarations during each parse.

REVISIT: We might want to think about the "right" way to expose the list of declared entities. For now, the knowledge how to access the entity declarations is implicit.

Method Details

absolutizeAgainstUserDir

public static void absolutizeAgainstUserDir(URI uri)
            throws URI.MalformedURIException
Absolutizes a URI using the current value of the "user.dir" property as the base URI. If the URI is already absolute, this is a no-op.
Parameters:
uri - the URI to absolutize

addExternalEntity

public void addExternalEntity(String name,
                              String publicId,
                              String literalSystemId,
                              String baseSystemId)
            throws IOException
Adds an external entity declaration.

Note: This method ignores subsequent entity declarations.

Note: The name should be a unique symbol. The SymbolTable can be used for this purpose.

Parameters:
name - The name of the entity.
publicId - The public identifier of the entity.
literalSystemId - The system identifier of the entity.
baseSystemId - The base system identifier of the entity. This is the system identifier of the entity where the entity being added and is used to expand the system identifier when the system identifier is a relative URI. When null the system identifier of the first external entity on the stack is used instead.

addInternalEntity

public void addInternalEntity(String name,
                              String text)
Adds an internal entity declaration.

Note: This method ignores subsequent entity declarations.

Note: The name should be a unique symbol. The SymbolTable can be used for this purpose.

Parameters:
name - The name of the entity.
text - The text of the entity.

addUnparsedEntity

public void addUnparsedEntity(String name,
                              String publicId,
                              String systemId,
                              String baseSystemId,
                              String notation)
Adds an unparsed entity declaration.

Note: This method ignores subsequent entity declarations.

Note: The name should be a unique symbol. The SymbolTable can be used for this purpose.

Parameters:
name - The name of the entity.
publicId - The public identifier of the entity.
systemId - The system identifier of the entity.
notation - The name of the notation.

closeReaders

public void closeReaders()
Close all opened InputStreams and Readers opened by this parser.

createReader

protected Reader createReader(InputStream inputStream,
                              String encoding,
                              Boolean isBigEndian)
            throws IOException
Creates a reader capable of reading the given input stream in the specified encoding.
Parameters:
inputStream - The input stream.
encoding - The encoding name that the input stream is encoded using. If the user has specified that Java encoding names are allowed, then the encoding name may be a Java encoding name; otherwise, it is an ianaEncoding name.
isBigEndian - For encodings (like uCS-4), whose names cannot specify a byte order, this tells whether the order is bigEndian. null menas unknown or not relevant.
Returns:
Returns a reader.

endExternalSubset

public void endExternalSubset()

expandSystemId

public static String expandSystemId(String systemId,
                                    String baseSystemId,
                                    boolean strict)
            throws URI.MalformedURIException
Expands a system id and returns the system id as a URI, if it can be expanded. A return value of null means that the identifier is already expanded. An exception thrown indicates a failure to expand the id.
Parameters:
systemId - The systemId to be expanded.
Returns:
Returns the URI string representing the expanded system identifier. A null value indicates that the given system identifier is already expanded.

fixURI

protected static String fixURI(String str)
Fixes a platform dependent filename to standard URI form.
Parameters:
str - The string to fix.
Returns:
Returns the fixed URI string.

getCurrentEntity

public XMLEntityManager.ScannedEntity getCurrentEntity()

getCurrentResourceIdentifier

public org.apache.xerces.xni.XMLResourceIdentifier getCurrentResourceIdentifier()

getEncodingName

protected Object[] getEncodingName(byte[] b4,
                                   int count)
Returns the IANA encoding name that is auto-detected from the bytes specified, with the endian-ness of that encoding where appropriate.
Parameters:
b4 - The first four bytes of the input.
count - The number of bytes actually read.
Returns:
a 2-element array: the first element, an IANA-encoding string, the second element a Boolean which is true iff the document is big endian, false if it's little-endian, and null if the distinction isn't relevant.

getEntityScanner

public XMLEntityScanner getEntityScanner()
Returns the entity scanner.

getFeatureDefault

public Boolean getFeatureDefault(String featureId)
Returns the default state for a feature, or null if this component does not want to report a default value for this feature.
Specified by:
getFeatureDefault in interface org.apache.xerces.xni.parser.XMLComponent
Parameters:
featureId - The feature identifier.
Since:
Xerces 2.2.0

getPropertyDefault

public Object getPropertyDefault(String propertyId)
Returns the default state for a property, or null if this component does not want to report a default value for this property.
Specified by:
getPropertyDefault in interface org.apache.xerces.xni.parser.XMLComponent
Parameters:
propertyId - The property identifier.
Since:
Xerces 2.2.0

getRecognizedFeatures

public String[] getRecognizedFeatures()
Returns a list of feature identifiers that are recognized by this component. This method may return null if no features are recognized by this component.
Specified by:
getRecognizedFeatures in interface org.apache.xerces.xni.parser.XMLComponent

getRecognizedProperties

public String[] getRecognizedProperties()
Returns a list of property identifiers that are recognized by this component. This method may return null if no properties are recognized by this component.
Specified by:
getRecognizedProperties in interface org.apache.xerces.xni.parser.XMLComponent

isDeclaredEntity

public boolean isDeclaredEntity(String entityName)
Checks whether an entity given by name is declared.
Parameters:
entityName - The name of the entity to check.
Returns:
True if the entity is declared, false otherwise.

isEntityDeclInExternalSubset

public boolean isEntityDeclInExternalSubset(String entityName)
Checks whether the declaration of an entity given by name is // in the external subset.
Parameters:
entityName - The name of the entity to check.
Returns:
True if the entity was declared in the external subset, false otherwise (including when the entity is not declared).

isExternalEntity

public boolean isExternalEntity(String entityName)
Checks whether an entity given by name is external.
Parameters:
entityName - The name of the entity to check.
Returns:
True if the entity is external, false otherwise (including when the entity is not declared).

isStandalone

public boolean isStandalone()
Returns true if the document entity is standalone.

isUnparsedEntity

public boolean isUnparsedEntity(String entityName)
Checks whether an entity given by name is unparsed.
Parameters:
entityName - The name of the entity to check.
Returns:
True if the entity is unparsed, false otherwise (including when the entity is not declared).

reset

public void reset()

reset

public void reset(org.apache.xerces.xni.parser.XMLComponentManager componentManager)
            throws org.apache.xerces.xni.parser.XMLConfigurationException
Resets the component. The component can query the component manager about any features and properties that affect the operation of the component.
Specified by:
reset in interface org.apache.xerces.xni.parser.XMLComponent
Parameters:
componentManager - The component manager.

resolveEntity

public org.apache.xerces.xni.parser.XMLInputSource resolveEntity(org.apache.xerces.xni.XMLResourceIdentifier resourceIdentifier)
            throws IOException,
                   org.apache.xerces.xni.XNIException
Resolves the specified public and system identifiers. This method first attempts to resolve the entity based on the EntityResolver registered by the application. If no entity resolver is registered or if the registered entity handler is unable to resolve the entity, then default entity resolution will occur.
Specified by:
resolveEntity in interface org.apache.xerces.xni.parser.XMLEntityResolver
Parameters:
Returns:
Returns an input source that wraps the resolved entity. This method will never return null.
Throws:
org.apache.xerces.xni.XNIException - Thrown by entity resolver to signal an error.

setEntityHandler

public void setEntityHandler(XMLEntityHandler entityHandler)
Sets the entity handler. When an entity starts and ends, the entity handler is notified of the change.
Parameters:
entityHandler - The new entity handler.

setFeature

public void setFeature(String featureId,
                       boolean state)
            throws org.apache.xerces.xni.parser.XMLConfigurationException
Sets the state of a feature. This method is called by the component manager any time after reset when a feature changes state.

Note: Components should silently ignore features that do not affect the operation of the component.

Specified by:
setFeature in interface org.apache.xerces.xni.parser.XMLComponent
Parameters:
featureId - The feature identifier.
state - The state of the feature.

setInstanceFollowRedirects

public static void setInstanceFollowRedirects(HttpURLConnection urlCon,
                                              boolean followRedirects)
Attempt to set whether redirects will be followed for an HttpURLConnection. This may fail on earlier JDKs which do not support setting this preference.

setProperty

public void setProperty(String propertyId,
                        Object value)
            throws org.apache.xerces.xni.parser.XMLConfigurationException
Sets the value of a property. This method is called by the component manager any time after reset when a property changes value.

Note: Components should silently ignore properties that do not affect the operation of the component.

Specified by:
setProperty in interface org.apache.xerces.xni.parser.XMLComponent
Parameters:
propertyId - The property identifier.
value - The value of the property.

setScannerVersion

public void setScannerVersion(short version)

setStandalone

public void setStandalone(boolean standalone)
Sets whether the document entity is standalone.
Parameters:
standalone - True if document entity is standalone.

setupCurrentEntity

public String setupCurrentEntity(String name,
                                 org.apache.xerces.xni.parser.XMLInputSource xmlInputSource,
                                 boolean literal,
                                 boolean isExternal)
            throws IOException,
                   org.apache.xerces.xni.XNIException
This method uses the passed-in XMLInputSource to make fCurrentEntity usable for reading.
Parameters:
name - name of the entity (XML is it's the document entity)
xmlInputSource - the input source, with sufficient information to begin scanning characters.
literal - True if this entity is started within a literal value.
isExternal - whether this entity should be treated as an internal or external entity.
Returns:
the encoding of the new entity or null if a character stream was employed

startDTDEntity

public void startDTDEntity(org.apache.xerces.xni.parser.XMLInputSource xmlInputSource)
            throws IOException,
                   org.apache.xerces.xni.XNIException
Starts the DTD entity. The DTD entity has the "[dtd]" pseudo-name.
Parameters:
xmlInputSource - The input source of the DTD entity.
Throws:
org.apache.xerces.xni.XNIException - Thrown by entity handler to signal an error.

startDocumentEntity

public void startDocumentEntity(org.apache.xerces.xni.parser.XMLInputSource xmlInputSource)
            throws IOException,
                   org.apache.xerces.xni.XNIException
Starts the document entity. The document entity has the "[xml]" pseudo-name.
Parameters:
xmlInputSource - The input source of the document entity.
Throws:
org.apache.xerces.xni.XNIException - Thrown by entity handler to signal an error.

startEntity

public void startEntity(String entityName,
                        boolean literal)
            throws IOException,
                   org.apache.xerces.xni.XNIException
Starts a named entity.
Parameters:
entityName - The name of the entity to start.
literal - True if this entity is started within a literal value.
Throws:
org.apache.xerces.xni.XNIException - Thrown by entity handler to signal an error.

startEntity

public void startEntity(String name,
                        org.apache.xerces.xni.parser.XMLInputSource xmlInputSource,
                        boolean literal,
                        boolean isExternal)
            throws IOException,
                   org.apache.xerces.xni.XNIException
Starts an entity.

This method can be used to insert an application defined XML entity stream into the parsing stream.

Parameters:
name - The name of the entity.
xmlInputSource - The input source of the entity.
literal - True if this entity is started within a literal value.
isExternal - whether this entity should be treated as an internal or external entity.
Throws:
org.apache.xerces.xni.XNIException - Thrown by entity handler to signal an error.

startExternalSubset

public void startExternalSubset()

Copyright B) 1999-2006 The Apache Software Foundation. All Rights Reserved.