public class XMLEntityManager extends Object implements XMLComponent, XMLEntityResolver
This component requires the following features and properties from the component manager that uses it:
Modifier and Type | Class and Description |
---|---|
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.
|
Modifier and Type | Field and Description |
---|---|
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 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 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 |
fHasPEReferences
True if the current document contains parameter entity references.
|
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.
|
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
|
Constructor and Description |
---|
XMLEntityManager()
Default constructor.
|
XMLEntityManager(XMLEntityManager entityManager)
Constructs an entity manager that shares the specified entity
declarations during each parse.
|
Modifier and Type | Method and Description |
---|---|
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 |
addInternalEntity(String name,
String text,
int paramEntityRefs)
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.
|
static OutputStream |
createOutputStream(String uri) |
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() |
XMLResourceIdentifier |
getCurrentResourceIdentifier() |
protected org.apache.xerces.impl.XMLEntityManager.EncodingInfo |
getEncodingInfo(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.
|
int |
getParamEntityRefCount(String entityName)
Returns the number of direct and indirect references to parameter
entities in the value of the entity.
|
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(XMLComponentManager componentManager)
Resets the component.
|
XMLInputSource |
resolveEntity(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.
|
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,
XMLInputSource xmlInputSource,
boolean literal,
boolean isExternal)
This method uses the passed-in XMLInputSource to make
fCurrentEntity usable for reading.
|
void |
startDocumentEntity(XMLInputSource xmlInputSource)
Starts the document entity.
|
void |
startDTDEntity(XMLInputSource xmlInputSource)
Starts the DTD entity.
|
void |
startEntity(String entityName,
boolean literal)
Starts a named entity.
|
void |
startEntity(String name,
XMLInputSource xmlInputSource,
boolean literal,
boolean isExternal)
Starts an entity.
|
void |
startExternalSubset() |
public static final int DEFAULT_BUFFER_SIZE
public static final int DEFAULT_XMLDECL_BUFFER_SIZE
public static final int DEFAULT_INTERNAL_BUFFER_SIZE
protected static final String VALIDATION
protected static final String EXTERNAL_GENERAL_ENTITIES
protected static final String EXTERNAL_PARAMETER_ENTITIES
protected static final String ALLOW_JAVA_ENCODINGS
protected static final String WARN_ON_DUPLICATE_ENTITYDEF
protected static final String STANDARD_URI_CONFORMANT
protected static final String PARSER_SETTINGS
protected static final String SYMBOL_TABLE
protected static final String ERROR_REPORTER
protected static final String ENTITY_RESOLVER
protected static final String VALIDATION_MANAGER
protected static final String BUFFER_SIZE
protected static final String SECURITY_MANAGER
protected boolean fValidation
protected boolean fExternalGeneralEntities
protected boolean fExternalParameterEntities
protected boolean fAllowJavaEncodings
protected boolean fWarnDuplicateEntityDef
protected boolean fStrictURI
protected SymbolTable fSymbolTable
protected XMLErrorReporter fErrorReporter
protected XMLEntityResolver fEntityResolver
protected ValidationManager fValidationManager
protected int fBufferSize
protected SecurityManager fSecurityManager
protected boolean fStandalone
protected boolean fHasPEReferences
protected boolean fInExternalSubset
protected XMLEntityHandler fEntityHandler
protected XMLEntityScanner fEntityScanner
protected XMLEntityScanner fXML10EntityScanner
protected XMLEntityScanner fXML11EntityScanner
protected int fEntityExpansionLimit
protected int fEntityExpansionCount
protected final Hashtable fEntities
protected final Stack fEntityStack
protected XMLEntityManager.ScannedEntity fCurrentEntity
protected Hashtable fDeclaredEntities
protected Stack fReaderStack
public XMLEntityManager()
public XMLEntityManager(XMLEntityManager entityManager)
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.
public void setStandalone(boolean standalone)
standalone
- True if document entity is standalone.public boolean isStandalone()
public void setEntityHandler(XMLEntityHandler entityHandler)
entityHandler
- The new entity handler.public XMLResourceIdentifier getCurrentResourceIdentifier()
public XMLEntityManager.ScannedEntity getCurrentEntity()
public void addInternalEntity(String name, String text, int paramEntityRefs)
Note: This method ignores subsequent entity declarations.
Note: The name should be a unique symbol. The SymbolTable can be used for this purpose.
name
- The name of the entity.text
- The text of the entity.paramEntityRefs
- Count of direct and indirect references to parameter entities in the value of the entity.SymbolTable
public void addInternalEntity(String name, String text)
Note: This method ignores subsequent entity declarations.
Note: The name should be a unique symbol. The SymbolTable can be used for this purpose.
name
- The name of the entity.text
- The text of the entity.SymbolTable
public int getParamEntityRefCount(String entityName)
entityName
- The name of the entity to check.public void addExternalEntity(String name, String publicId, String literalSystemId, String baseSystemId) throws IOException
Note: This method ignores subsequent entity declarations.
Note: The name should be a unique symbol. The SymbolTable can be used for this purpose.
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.IOException
SymbolTable
public boolean isExternalEntity(String entityName)
entityName
- The name of the entity to check.public boolean isEntityDeclInExternalSubset(String entityName)
entityName
- The name of the entity to check.public void addUnparsedEntity(String name, String publicId, String systemId, String baseSystemId, String notation)
Note: This method ignores subsequent entity declarations.
Note: The name should be a unique symbol. The SymbolTable can be used for this purpose.
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.SymbolTable
public boolean isUnparsedEntity(String entityName)
entityName
- The name of the entity to check.public boolean isDeclaredEntity(String entityName)
entityName
- The name of the entity to check.public XMLInputSource resolveEntity(XMLResourceIdentifier resourceIdentifier) throws IOException, XNIException
resolveEntity
in interface XMLEntityResolver
resourceIdentifier
- The XMLResourceIdentifier for the resource to resolve.IOException
- Thrown on i/o error.XNIException
- Thrown by entity resolver to signal an error.XMLResourceIdentifier
public void startEntity(String entityName, boolean literal) throws IOException, XNIException
entityName
- The name of the entity to start.literal
- True if this entity is started within a literal
value.IOException
- Thrown on i/o error.XNIException
- Thrown by entity handler to signal an error.public void startDocumentEntity(XMLInputSource xmlInputSource) throws IOException, XNIException
xmlInputSource
- The input source of the document entity.IOException
- Thrown on i/o error.XNIException
- Thrown by entity handler to signal an error.public void startDTDEntity(XMLInputSource xmlInputSource) throws IOException, XNIException
xmlInputSource
- The input source of the DTD entity.IOException
- Thrown on i/o error.XNIException
- Thrown by entity handler to signal an error.public void startExternalSubset()
public void endExternalSubset()
public void startEntity(String name, XMLInputSource xmlInputSource, boolean literal, boolean isExternal) throws IOException, XNIException
This method can be used to insert an application defined XML entity stream into the parsing stream.
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.IOException
- Thrown on i/o error.XNIException
- Thrown by entity handler to signal an error.public String setupCurrentEntity(String name, XMLInputSource xmlInputSource, boolean literal, boolean isExternal) throws IOException, XNIException
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.IOException
- if anything can't be read
XNIException If any parser-specific goes wrong.XNIException
public void setScannerVersion(short version)
public XMLEntityScanner getEntityScanner()
public void closeReaders()
public void reset(XMLComponentManager componentManager) throws XMLConfigurationException
reset
in interface XMLComponent
componentManager
- The component manager.SAXException
- Thrown by component on initialization error.
For example, if a feature or property is
required for the operation of the component, the
component manager may throw a
SAXNotRecognizedException or a
SAXNotSupportedException.XMLConfigurationException
public void reset()
public String[] getRecognizedFeatures()
getRecognizedFeatures
in interface XMLComponent
public void setFeature(String featureId, boolean state) throws XMLConfigurationException
Note: Components should silently ignore features that do not affect the operation of the component.
setFeature
in interface XMLComponent
featureId
- The feature identifier.state
- The state of the feature.SAXNotRecognizedException
- The component should not throw
this exception.SAXNotSupportedException
- The component should not throw
this exception.XMLConfigurationException
- Thrown for configuration error.
In general, components should
only throw this exception if
it is really
a critical error.public String[] getRecognizedProperties()
getRecognizedProperties
in interface XMLComponent
public void setProperty(String propertyId, Object value) throws XMLConfigurationException
Note: Components should silently ignore properties that do not affect the operation of the component.
setProperty
in interface XMLComponent
propertyId
- The property identifier.value
- The value of the property.SAXNotRecognizedException
- The component should not throw
this exception.SAXNotSupportedException
- The component should not throw
this exception.XMLConfigurationException
- Thrown for configuration error.
In general, components should
only throw this exception if
it is really
a critical error.public Boolean getFeatureDefault(String featureId)
getFeatureDefault
in interface XMLComponent
featureId
- The feature identifier.public Object getPropertyDefault(String propertyId)
getPropertyDefault
in interface XMLComponent
propertyId
- The property identifier.public static void absolutizeAgainstUserDir(URI uri) throws URI.MalformedURIException
uri
- the URI to absolutizeURI.MalformedURIException
public static String expandSystemId(String systemId, String baseSystemId, boolean strict) throws URI.MalformedURIException
systemId
- The systemId to be expanded.URI.MalformedURIException
public static OutputStream createOutputStream(String uri) throws IOException
IOException
protected org.apache.xerces.impl.XMLEntityManager.EncodingInfo getEncodingInfo(byte[] b4, int count)
b4
- The first four bytes of the input.count
- The number of bytes actually read.protected Reader createReader(InputStream inputStream, String encoding, Boolean isBigEndian) throws IOException
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 means
unknown or not relevant.IOException
Copyright © 2021 JBoss by Red Hat. All rights reserved.