com.helger.jaxb

Class GenericJAXBMarshaller<JAXBTYPE>

java.lang.Object

com.helger.jaxb.GenericJAXBMarshaller<JAXBTYPE>

Type Parameters:

JAXBTYPE - The JAXB type to be marshaled

All Implemented Interfaces:

com.helger.commons.lang.IHasClassLoader, IJAXBReader<JAXBTYPE>, IJAXBWriter<JAXBTYPE>

@NotThreadSafe
public class GenericJAXBMarshaller<JAXBTYPE>
extends Object
implements com.helger.commons.lang.IHasClassLoader, IJAXBReader<JAXBTYPE>, IJAXBWriter<JAXBTYPE>

This is the generic reader and writer base class for JAXB enabled document types.

Author:

Philip Helger

Nested Class Summary

Nested classes/interfaces inherited from interface com.helger.jaxb.IJAXBReader

IJAXBReader.IJAXBUnmarshaller<JAXBTYPE>

Nested classes/interfaces inherited from interface com.helger.jaxb.IJAXBWriter

IJAXBWriter.IJAXBMarshaller<JAXBTYPE>

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	DEFAULT_READ_SECURE

Fields inherited from interface com.helger.jaxb.IJAXBWriter

USE_JAXB_CHARSET_FIX

Constructor Summary

Constructors

Constructor and Description
GenericJAXBMarshaller(Class<JAXBTYPE> aType, com.helger.commons.functional.IFunction<? super JAXBTYPE,? extends JAXBElement<JAXBTYPE>> aWrapper) Constructor without XSD paths.
GenericJAXBMarshaller(Class<JAXBTYPE> aType, List<? extends com.helger.commons.io.resource.ClassPathResource> aXSDs, com.helger.commons.functional.IFunction<? super JAXBTYPE,? extends JAXBElement<JAXBTYPE>> aJAXBElementWrapper) Constructor with XSD paths.

Method Summary

Modifier and Type	Method and Description
protected Schema	createValidationSchema()
protected void	customizeMarshaller(Marshaller aMarshaller) Customize the passed marshaller before marshalling something.
protected void	customizeUnmarshaller(Unmarshaller aUnmarshaller) Customize the passed unmarshaller before unmarshalling (reading) something.
Charset	getCharset()
ClassLoader	getClassLoader()
String	getIndentString()
com.helger.xml.namespace.INamespaceContext	getNamespaceContext()
String	getNoNamespaceSchemaLocation()
com.helger.commons.collection.impl.ICommonsList<com.helger.commons.io.resource.ClassPathResource>	getOriginalXSDs()
String	getSchemaLocation()
IValidationEventHandlerFactory	getValidationEventHandlerFactory()
protected void	handleReadException(JAXBException ex)
protected void	handleWriteException(JAXBException ex)
boolean	isFormattedOutput()
boolean	isReadSecure() Check if secure reading is enabled.
boolean	isUseContextCache()
JAXBTYPE	read(IJAXBReader.IJAXBUnmarshaller<JAXBTYPE> aHandler) Read a document using the passed handler.
com.helger.commons.state.EChange	setCharset(Charset aCharset) Set the charset to be used for writing JAXB objects.
void	setClassLoader(ClassLoader aClassLoader) Deprecated.
com.helger.commons.state.EChange	setFormattedOutput(boolean bWriteFormatted) Change the way formatting happens when calling write.
com.helger.commons.state.EChange	setIndentString(String sIndentString) Set the indent string to be used for writing JAXB objects.
com.helger.commons.state.EChange	setNamespaceContext(com.helger.xml.namespace.INamespaceContext aNSContext) Set the namespace context (prefix to namespace URL mapping) to be used.
com.helger.commons.state.EChange	setNoNamespaceSchemaLocation(String sNoNamespaceSchemaLocation) Set the no namespace schema location to be used for writing JAXB objects.
com.helger.commons.state.EChange	setReadSecure(boolean bReadSecure) Enable or disable secure reading.
com.helger.commons.state.EChange	setSchemaLocation(String sSchemaLocation) Set the schema location to be used for writing JAXB objects.
com.helger.commons.state.EChange	setUseContextCache(boolean bUseContextCache) Change whether the context cache should be used or not.
void	setValidationEventHandlerFactory(IValidationEventHandlerFactory aVEHFactory) Set a factory to be used to create ValidationEventHandler objects.
String	toString()
com.helger.commons.state.ESuccess	write(JAXBTYPE aObject, IJAXBWriter.IJAXBMarshaller<JAXBTYPE> aMarshallerFunc) Convert the passed object to XML.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.helger.commons.lang.IHasClassLoader

hasClassLoader

Methods inherited from interface com.helger.jaxb.IJAXBReader

read, read, read, read, read, read, read, read, read, read, read, read, read, read, read, read

Methods inherited from interface com.helger.jaxb.IJAXBWriter

getAsByteBuffer, getAsBytes, getAsDocument, getAsMicroDocument, getAsMicroElement, getAsString, getXMLWriterSettings, hasCharset, hasIndentString, hasNoNamespaceSchemaLocation, hasSchemaLocation, write, write, write, write, write, write, write, write, write

Field Detail

DEFAULT_READ_SECURE

public static final boolean DEFAULT_READ_SECURE

See Also:

Constant Field Values

Constructor Detail

GenericJAXBMarshaller

public GenericJAXBMarshaller(@Nonnull
                             Class<JAXBTYPE> aType,
                             @Nonnull
                             com.helger.commons.functional.IFunction<? super JAXBTYPE,? extends JAXBElement<JAXBTYPE>> aWrapper)

Constructor without XSD paths.

Parameters:

aType - The class of the JAXB document implementation type. May not be null.

aWrapper - Wrap the passed domain object into a JAXBElement for marshalling (writing). This can usually be done using the respective's package ObjectFactory implementation. May not be null.

GenericJAXBMarshaller

public GenericJAXBMarshaller(@Nonnull
                             Class<JAXBTYPE> aType,
                             @Nullable
                             List<? extends com.helger.commons.io.resource.ClassPathResource> aXSDs,
                             @Nonnull
                             com.helger.commons.functional.IFunction<? super JAXBTYPE,? extends JAXBElement<JAXBTYPE>> aJAXBElementWrapper)

Constructor with XSD paths.

Parameters:

aType - The class of the JAXB document implementation type. May not be null.

aXSDs - The XSDs used to validate document. May be null or empty indicating, that no XSD check is needed.

aJAXBElementWrapper - Wrap the passed domain object into a JAXBElement for marshalling (writing). This can usually be done using the respective's package ObjectFactory implementation. May not be null.

Method Detail

setClassLoader

@Deprecated
 @DevelopersNote(value="Deprecated since v9.0.0")
public final void setClassLoader(@Nullable
                                                                                                 ClassLoader aClassLoader)

Deprecated.

Set the class loader to be used for XSD schema validation. This method is optional. Since v9.0.0 a class loader is set by default, so this method is most likely not needed anymore!

Parameters:

aClassLoader - The class loader to be used. May be null.

getClassLoader

@Nullable
public final ClassLoader getClassLoader()

Specified by:

getClassLoader in interface com.helger.commons.lang.IHasClassLoader

setValidationEventHandlerFactory

public final void setValidationEventHandlerFactory(@Nullable
                                                   IValidationEventHandlerFactory aVEHFactory)

Set a factory to be used to create ValidationEventHandler objects. By default none is present.

Parameters:

aVEHFactory - The new factory to be used. May be null.

getValidationEventHandlerFactory

@Nullable
public final IValidationEventHandlerFactory getValidationEventHandlerFactory()

Returns:

The currently used validation event handler factory. By default none is used. May be null if explicitly set.

isReadSecure

public final boolean isReadSecure()

Description copied from interface: IJAXBReader

Check if secure reading is enabled. Secure reading means that documents are checked for XXE and XML bombs (infinite entity expansions). By default secure reading is enabled.

Specified by:

isReadSecure in interface IJAXBReader<JAXBTYPE>

Returns:

true if secure reading is enabled.

setReadSecure

@Nonnull
public final com.helger.commons.state.EChange setReadSecure(boolean bReadSecure)

Enable or disable secure reading. Secure reading means that documents are checked for XXE and XML bombs (infinite entity expansions). By default secure reading is enabled.

Parameters:

bReadSecure - true to read secure, false to disable secure reading.

Returns:

EChange

getNamespaceContext

@Nullable
public final com.helger.xml.namespace.INamespaceContext getNamespaceContext()

Specified by:

getNamespaceContext in interface IJAXBWriter<JAXBTYPE>

Returns:

The special JAXB namespace context to be used. May be null.

setNamespaceContext

@Nonnull
public com.helger.commons.state.EChange setNamespaceContext(@Nullable
                                                                      com.helger.xml.namespace.INamespaceContext aNSContext)

Set the namespace context (prefix to namespace URL mapping) to be used.

Parameters:

aNSContext - The namespace context to be used. May be null.

Returns:

EChange

Since:

8.5.3

isFormattedOutput

public final boolean isFormattedOutput()

Specified by:

isFormattedOutput in interface IJAXBWriter<JAXBTYPE>

Returns:

true if the JAXB output should be formatted. Default is false.

setFormattedOutput

@Nonnull
public final com.helger.commons.state.EChange setFormattedOutput(boolean bWriteFormatted)

Change the way formatting happens when calling write.

Parameters:

bWriteFormatted - true to write formatted output.

Returns:

EChange

Since:

8.5.3

getCharset

@Nullable
public Charset getCharset()

Specified by:

getCharset in interface IJAXBWriter<JAXBTYPE>

Returns:

The special JAXB Charset to be used for writing. null by default.

setCharset

@Nonnull
public com.helger.commons.state.EChange setCharset(@Nullable
                                                             Charset aCharset)

Set the charset to be used for writing JAXB objects.

Parameters:

aCharset - The charset to be used by default. May be null.

Returns:

EChange

Since:

8.5.3

getIndentString

@Nullable
public String getIndentString()

Specified by:

getIndentString in interface IJAXBWriter<JAXBTYPE>

Returns:

The JAXB indentation string to be used for writing. null by default. Only used when formatted output is used.

setIndentString

@Nonnull
public com.helger.commons.state.EChange setIndentString(@Nullable
                                                                  String sIndentString)

Set the indent string to be used for writing JAXB objects.

Parameters:

sIndentString - The indent string to be used. May be null.

Returns:

EChange

Since:

8.5.3

getSchemaLocation

@Nullable
public String getSchemaLocation()

Specified by:

getSchemaLocation in interface IJAXBWriter<JAXBTYPE>

Returns:

The schema location to be used for writing. null by default.

setSchemaLocation

@Nonnull
public com.helger.commons.state.EChange setSchemaLocation(@Nullable
                                                                    String sSchemaLocation)

Set the schema location to be used for writing JAXB objects.

Parameters:

sSchemaLocation - The schema location to be used. May be null.

Returns:

EChange

Since:

8.6.0

getNoNamespaceSchemaLocation

@Nullable
public String getNoNamespaceSchemaLocation()

Specified by:

getNoNamespaceSchemaLocation in interface IJAXBWriter<JAXBTYPE>

Returns:

The no namespace schema location to be used for writing. null by default.

setNoNamespaceSchemaLocation

@Nonnull
public com.helger.commons.state.EChange setNoNamespaceSchemaLocation(@Nullable
                                                                               String sNoNamespaceSchemaLocation)

Set the no namespace schema location to be used for writing JAXB objects.

Parameters:

sNoNamespaceSchemaLocation - The no namespace schema location to be used. May be null.

Returns:

EChange

Since:

9.0.0

setUseContextCache

@Nonnull
public final com.helger.commons.state.EChange setUseContextCache(boolean bUseContextCache)

Change whether the context cache should be used or not. Since creating the JAXB context is quite cost intensive it is recommended to leave it enabled.

Parameters:

bUseContextCache - true to use it (default), false if not.

Returns:

EChange

isUseContextCache

public final boolean isUseContextCache()

getOriginalXSDs

@Nonnull
 @Nonempty
 @ReturnsMutableCopy
public final com.helger.commons.collection.impl.ICommonsList<com.helger.commons.io.resource.ClassPathResource> getOriginalXSDs()

Returns:

A list of all XSD resources used for validation. Never null.

createValidationSchema

@Nullable
protected Schema createValidationSchema()

Returns:

The validation schema to be used. May be null indicating that no validation is required.

customizeUnmarshaller

@OverrideOnDemand
protected void customizeUnmarshaller(@Nonnull
                                                        Unmarshaller aUnmarshaller)

Customize the passed unmarshaller before unmarshalling (reading) something.

Parameters:

aUnmarshaller - The object to customize. Never null.

handleReadException

@OverrideOnDemand
protected void handleReadException(@Nonnull
                                                      JAXBException ex)

read

@Nullable
public final JAXBTYPE read(@Nonnull
                                      IJAXBReader.IJAXBUnmarshaller<JAXBTYPE> aHandler)

Description copied from interface: IJAXBReader

Read a document using the passed handler.

Specified by:

read in interface IJAXBReader<JAXBTYPE>

Parameters:

aHandler - The unmarshalling handler. May not be null.

Returns:

null in case reading fails.

customizeMarshaller

@OverrideOnDemand
protected void customizeMarshaller(@Nonnull
                                                      Marshaller aMarshaller)

Customize the passed marshaller before marshalling something.

Parameters:

aMarshaller - The object to customize. Never null.

handleWriteException

@OverrideOnDemand
protected void handleWriteException(@Nonnull
                                                       JAXBException ex)

write

@Nonnull
public final com.helger.commons.state.ESuccess write(@Nonnull
                                                               JAXBTYPE aObject,
                                                               @Nonnull
                                                               IJAXBWriter.IJAXBMarshaller<JAXBTYPE> aMarshallerFunc)

Description copied from interface: IJAXBWriter

Convert the passed object to XML.

Specified by:

write in interface IJAXBWriter<JAXBTYPE>

Parameters:

aObject - The object to be converted. May not be null.

aMarshallerFunc - The marshalling function. May not be null.

Returns:

ESuccess

toString

public String toString()

Overrides:

toString in class Object