org.apache.axiom.util.stax.dialect

Class BEADialect

java.lang.Object

org.apache.axiom.util.stax.dialect.AbstractStAXDialect

org.apache.axiom.util.stax.dialect.BEADialect

All Implemented Interfaces:

StAXDialect

class BEADialect
extends AbstractStAXDialect

Field Summary

Fields

Modifier and Type	Field and Description
static StAXDialect	INSTANCE

Constructor Summary

Constructors

Constructor and Description
BEADialect()

Method Summary

Modifier and Type	Method and Description
javax.xml.stream.XMLInputFactory	disallowDoctypeDecl(javax.xml.stream.XMLInputFactory factory) Configure the given factory to disallow DOCTYPE declarations.
javax.xml.stream.XMLInputFactory	enableCDataReporting(javax.xml.stream.XMLInputFactory factory) Configure the given factory to enable reporting of CDATA sections by stream readers created from it.
java.lang.String	getName() Get the name of this dialect.
javax.xml.stream.XMLInputFactory	makeThreadSafe(javax.xml.stream.XMLInputFactory factory) Make an XMLInputFactory object thread safe.
javax.xml.stream.XMLOutputFactory	makeThreadSafe(javax.xml.stream.XMLOutputFactory factory) Make an XMLOutputFactory object thread safe.
javax.xml.stream.XMLInputFactory	normalize(javax.xml.stream.XMLInputFactory factory) Normalize an XMLInputFactory.
javax.xml.stream.XMLOutputFactory	normalize(javax.xml.stream.XMLOutputFactory factory) Normalize an XMLOutputFactory.
javax.xml.stream.XMLStreamReader	normalize(javax.xml.stream.XMLStreamReader reader)
javax.xml.stream.XMLStreamWriter	normalize(javax.xml.stream.XMLStreamWriter writer)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

INSTANCE

public static final StAXDialect INSTANCE

Constructor Detail

BEADialect

BEADialect()

Method Detail

getName

public java.lang.String getName()

Description copied from interface: StAXDialect

Get the name of this dialect.

Returns:

the name of the dialect

enableCDataReporting

public javax.xml.stream.XMLInputFactory enableCDataReporting(javax.xml.stream.XMLInputFactory factory)

Description copied from interface: StAXDialect

Configure the given factory to enable reporting of CDATA sections by stream readers created from it. The example in the documentation of the XMLStreamReader.next() method suggests that even if the parser is non coalescing, CDATA sections should be reported as CHARACTERS events. Some implementations strictly follow the example, while for others it is sufficient to make the parser non coalescing.

Parameters:

factory - the factory to configure; this may be an already normalized factory or a "raw" factory object

Returns:

the factory with CDATA reporting enabled; this may be the original factory instance or a wrapper

disallowDoctypeDecl

public javax.xml.stream.XMLInputFactory disallowDoctypeDecl(javax.xml.stream.XMLInputFactory factory)

Description copied from interface: StAXDialect

Configure the given factory to disallow DOCTYPE declarations. The effect of this is similar to the http://apache.org/xml/features/disallow-doctype-decl feature in Xerces. The factory instance returned by this method MUST satisfy the following requirements:

• The factory or the reader implementation MUST throw an exception when requested to parse a document containing a DOCTYPE declaration. If the exception is not thrown by the factory, it MUST be thrown by the reader before the first XMLStreamConstants.START_ELEMENT event.
• The parser MUST NOT attempt to load the external DTD subset or any other external entity.
• The parser MUST protect itself against denial of service attacks based on deeply nested entity definitions present in the internal DTD subset. Ideally, the parser SHOULD NOT process the internal subset at all and throw an exception immediately when encountering the DOCTYPE declaration.

This method is typically useful in the context of SOAP processing since a SOAP message must not contain a Document Type Declaration.

Parameters:

factory - the factory to configure; this may be an already normalized factory or a "raw" factory object

Returns:

the factory that disallows DOCTYPE declarations; this may be the original factory instance or a wrapper

makeThreadSafe

public javax.xml.stream.XMLInputFactory makeThreadSafe(javax.xml.stream.XMLInputFactory factory)

Description copied from interface: StAXDialect

Make an XMLInputFactory object thread safe. The implementation may do this either by configuring the factory or by creating a thread safe wrapper. The returned factory must be thread safe for all method calls that don't change the (visible) state of the factory. This means that thread safety is not required for XMLInputFactory.setEventAllocator(javax.xml.stream.util.XMLEventAllocator), XMLInputFactory.setProperty(String, Object), XMLInputFactory.setXMLReporter(javax.xml.stream.XMLReporter) and XMLInputFactory.setXMLResolver(javax.xml.stream.XMLResolver).

Parameters:

factory - the factory to make thread safe

Returns:

the thread safe factory

makeThreadSafe

public javax.xml.stream.XMLOutputFactory makeThreadSafe(javax.xml.stream.XMLOutputFactory factory)

Description copied from interface: StAXDialect

Make an XMLOutputFactory object thread safe. The implementation may do this either by configuring the factory or by creating a thread safe wrapper. The returned factory must be thread safe for all method calls that don't change the (visible) state, i.e. the properties, of the factory.

Parameters:

factory - the factory to make thread safe

Returns:

the thread safe factory

normalize

public javax.xml.stream.XMLStreamReader normalize(javax.xml.stream.XMLStreamReader reader)

Specified by:

normalize in class AbstractStAXDialect

normalize

public javax.xml.stream.XMLStreamWriter normalize(javax.xml.stream.XMLStreamWriter writer)

Specified by:

normalize in class AbstractStAXDialect

normalize

public javax.xml.stream.XMLInputFactory normalize(javax.xml.stream.XMLInputFactory factory)

Description copied from interface: StAXDialect

Normalize an XMLInputFactory. This will make sure that the readers created from the factory conform to the StAX specifications.

Parameters:

factory - the factory to normalize

Returns:

the normalized factory

normalize

public javax.xml.stream.XMLOutputFactory normalize(javax.xml.stream.XMLOutputFactory factory)

Description copied from interface: StAXDialect

Normalize an XMLOutputFactory. This will make sure that the writers created from the factory conform to the StAX specifications.

Parameters:

factory - the factory to normalize

Returns:

the normalized factory