Package org.cibseven.spin.impl.xml.dom.format

Class DomXmlDataFormat

java.lang.Object

org.cibseven.spin.impl.xml.dom.format.DomXmlDataFormat

All Implemented Interfaces:

DataFormat<SpinXmlElement>

public class DomXmlDataFormat
extends Object
implements DataFormat<SpinXmlElement>

Author:

Daniel Meyer

Field Summary

Fields

Modifier and Type	Field	Description
protected static final String	DISALLOW_DOCTYPE_DECL
protected DocumentBuilderFactory	documentBuilderFactory	the DocumentBuilderFactory used by the reader
protected static final String	EXTERNAL_GENERAL_ENTITIES
protected static final String	EXTERNAL_PARAMETER_ENTITIES
protected InputStream	formattingConfiguration
protected JaxBContextProvider	jaxBContextProvider	the JaxBContextProvider instance used by this writer.
protected static final String	JAXP_ACCESS_EXTERNAL_SCHEMA
protected static final String	JAXP_ACCESS_EXTERNAL_SCHEMA_ALL
protected static final String	JAXP_ACCESS_EXTERNAL_SCHEMA_SYSTEM_PROPERTY
protected static final String	LOAD_EXTERNAL_DTD
protected static final DomXmlLogger	LOG
protected DomXmlDataFormatMapper	mapper
protected final String	name
protected boolean	prettyPrint
protected DomXmlDataFormatReader	reader
static final String	SP_PROPERTY
protected TransformerFactory	transformerFactory	the TransformerFactory instance used by the writer
protected DomXmlDataFormatWriter	writer
static final String	XXE_PROPERTY

Constructor Summary

Constructors

Constructor	Description
DomXmlDataFormat(String name)
DomXmlDataFormat(String name, Map<String,Object> configurationProperties)
DomXmlDataFormat(String name, DocumentBuilderFactory documentBuilderFactory)
DomXmlDataFormat(String name, DocumentBuilderFactory documentBuilderFactory, TransformerFactory transformerFactory, JaxBContextProvider contextProvider)
DomXmlDataFormat(String name, DocumentBuilderFactory documentBuilderFactory, JaxBContextProvider contextProvider)
DomXmlDataFormat(String name, JaxBContextProvider contextProvider)

Method Summary

Modifier and Type	Method	Description
static DocumentBuilderFactory	configurableDocumentBuilderFactory(Map<String,Object> configurationProperties)
SpinXmlAttribute	createAttributeWrapper(Attr attr)
SpinXmlElement	createElementWrapper(Element element)
SpinXmlElement	createWrapperInstance(Object parameter)
static DocumentBuilderFactory	defaultDocumentBuilderFactory()
static JaxBContextProvider	defaultJaxBContextProvider()
static TransformerFactory	defaultTransformerFactory()
protected static void	disableXxeProcessing(DocumentBuilderFactory dbf)
protected static void	enableSecureProcessing(DocumentBuilderFactory dbf)
DocumentBuilderFactory	getDocumentBuilderFactory()
InputStream	getFormattingConfiguration()
JaxBContextProvider	getJaxBContextProvider()
DomXmlDataFormatMapper	getMapper()
String	getName()
DomXmlDataFormatReader	getReader()
TransformerFactory	getTransformerFactory()
Class<? extends SpinXmlElement>	getWrapperType()
DomXmlDataFormatWriter	getWriter()
protected void	init()
boolean	isPrettyPrint()
protected static String	resolveAccessExternalSchemaProperty()
void	setDocumentBuilderFactory(DocumentBuilderFactory documentBuilderFactory)
void	setFormattingConfiguration(InputStream formattingConfiguration)
void	setJaxBContextProvider(JaxBContextProvider jaxBContextProvider)
void	setPrettyPrint(boolean prettyPrint)
void	setTransformerFactory(TransformerFactory transformerFactory)

Methods inherited from class java.lang.Object

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

Field Details

LOG

protected static final DomXmlLogger LOG

EXTERNAL_GENERAL_ENTITIES

protected static final String EXTERNAL_GENERAL_ENTITIES

See Also:

• Constant Field Values

DISALLOW_DOCTYPE_DECL

protected static final String DISALLOW_DOCTYPE_DECL

See Also:

• Constant Field Values

LOAD_EXTERNAL_DTD

protected static final String LOAD_EXTERNAL_DTD

See Also:

• Constant Field Values

EXTERNAL_PARAMETER_ENTITIES

protected static final String EXTERNAL_PARAMETER_ENTITIES

See Also:

• Constant Field Values

JAXP_ACCESS_EXTERNAL_SCHEMA

protected static final String JAXP_ACCESS_EXTERNAL_SCHEMA

See Also:

• Constant Field Values

JAXP_ACCESS_EXTERNAL_SCHEMA_SYSTEM_PROPERTY

protected static final String JAXP_ACCESS_EXTERNAL_SCHEMA_SYSTEM_PROPERTY

See Also:

• Constant Field Values

JAXP_ACCESS_EXTERNAL_SCHEMA_ALL

protected static final String JAXP_ACCESS_EXTERNAL_SCHEMA_ALL

See Also:

• Constant Field Values

XXE_PROPERTY

public static final String XXE_PROPERTY

See Also:

• Constant Field Values

SP_PROPERTY

public static final String SP_PROPERTY

See Also:

• Constant Field Values

documentBuilderFactory

protected DocumentBuilderFactory documentBuilderFactory

the DocumentBuilderFactory used by the reader

transformerFactory

protected TransformerFactory transformerFactory

the TransformerFactory instance used by the writer

jaxBContextProvider

protected JaxBContextProvider jaxBContextProvider

the JaxBContextProvider instance used by this writer.

reader

protected DomXmlDataFormatReader reader

writer

protected DomXmlDataFormatWriter writer

mapper

protected DomXmlDataFormatMapper mapper

name

protected final String name

prettyPrint

protected boolean prettyPrint

formattingConfiguration

protected InputStream formattingConfiguration

Constructor Details

DomXmlDataFormat

public DomXmlDataFormat(String name)

DomXmlDataFormat

public DomXmlDataFormat(String name,
 Map<String,Object> configurationProperties)

DomXmlDataFormat

public DomXmlDataFormat(String name,
 JaxBContextProvider contextProvider)

DomXmlDataFormat

public DomXmlDataFormat(String name,
 DocumentBuilderFactory documentBuilderFactory,
 JaxBContextProvider contextProvider)

DomXmlDataFormat

public DomXmlDataFormat(String name,
 DocumentBuilderFactory documentBuilderFactory)

DomXmlDataFormat

public DomXmlDataFormat(String name,
 DocumentBuilderFactory documentBuilderFactory,
 TransformerFactory transformerFactory,
 JaxBContextProvider contextProvider)

Method Details

init

protected void init()

getWrapperType

public Class<? extends SpinXmlElement> getWrapperType()

Specified by:

getWrapperType in interface DataFormat<SpinXmlElement>

createWrapperInstance

public SpinXmlElement createWrapperInstance(Object parameter)

Specified by:

createWrapperInstance in interface DataFormat<SpinXmlElement>

getName

public String getName()

Specified by:

getName in interface DataFormat<SpinXmlElement>

createElementWrapper

public SpinXmlElement createElementWrapper(Element element)

createAttributeWrapper

public SpinXmlAttribute createAttributeWrapper(Attr attr)

getReader

public DomXmlDataFormatReader getReader()

Specified by:

getReader in interface DataFormat<SpinXmlElement>

getWriter

public DomXmlDataFormatWriter getWriter()

Specified by:

getWriter in interface DataFormat<SpinXmlElement>

getMapper

public DomXmlDataFormatMapper getMapper()

Specified by:

getMapper in interface DataFormat<SpinXmlElement>

Returns:

the DataFormatMapper used by this data format

getDocumentBuilderFactory

public DocumentBuilderFactory getDocumentBuilderFactory()

getTransformerFactory

public TransformerFactory getTransformerFactory()

getJaxBContextProvider

public JaxBContextProvider getJaxBContextProvider()

setDocumentBuilderFactory

public void setDocumentBuilderFactory(DocumentBuilderFactory documentBuilderFactory)

setTransformerFactory

public void setTransformerFactory(TransformerFactory transformerFactory)

setJaxBContextProvider

public void setJaxBContextProvider(JaxBContextProvider jaxBContextProvider)

isPrettyPrint

public boolean isPrettyPrint()

setPrettyPrint

public void setPrettyPrint(boolean prettyPrint)

getFormattingConfiguration

public InputStream getFormattingConfiguration()

setFormattingConfiguration

public void setFormattingConfiguration(InputStream formattingConfiguration)

defaultTransformerFactory

public static TransformerFactory defaultTransformerFactory()

defaultDocumentBuilderFactory

public static DocumentBuilderFactory defaultDocumentBuilderFactory()

configurableDocumentBuilderFactory

public static DocumentBuilderFactory configurableDocumentBuilderFactory(Map<String,Object> configurationProperties)

defaultJaxBContextProvider

public static JaxBContextProvider defaultJaxBContextProvider()

disableXxeProcessing

protected static void disableXxeProcessing(DocumentBuilderFactory dbf)

enableSecureProcessing

protected static void enableSecureProcessing(DocumentBuilderFactory dbf)

resolveAccessExternalSchemaProperty

protected static String resolveAccessExternalSchemaProperty()