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, Function<? super JAXBTYPE,? extends JAXBElement<JAXBTYPE>> aWrapper) Constructor without XSD paths.
GenericJAXBMarshaller(Class<JAXBTYPE> aType, List<? extends com.helger.commons.io.resource.ClassPathResource> aXSDs, Function<? super JAXBTYPE,? extends JAXBElement<JAXBTYPE>> aJAXBElementWrapper) Constructor with XSD paths.
GenericJAXBMarshaller(Class<JAXBTYPE> aType, QName aQName) Constructor without XSD paths.

Method Summary

Modifier and Type	Method and Description
static <T> Function<T,JAXBElement<T>>	createSimpleJAXBElement(QName aQName, Class<T> aClass) Helper function to create a supplier for JAXBElement objects.
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()
protected JAXBContext	getJAXBContext(ClassLoader aClassLoader) Create the JAXBContext - cached or uncached.
NamespaceContext	getNamespaceContext()
String	getNoNamespaceSchemaLocation()
com.helger.commons.collection.impl.ICommonsList<com.helger.commons.io.resource.ClassPathResource>	getOriginalXSDs()
String	getSchemaLocation()
protected Class<JAXBTYPE>	getType()
IValidationEventHandlerFactory	getValidationEventHandlerFactory()
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.callback.CallbackList<com.helger.commons.callback.exception.IExceptionCallback<JAXBException>>	readExceptionCallbacks()
GenericJAXBMarshaller<JAXBTYPE>	setCharset(Charset aCharset) Set the charset to be used for writing JAXB objects.
GenericJAXBMarshaller<JAXBTYPE>	setFormattedOutput(boolean bWriteFormatted) Change the way formatting happens when calling write.
GenericJAXBMarshaller<JAXBTYPE>	setIndentString(String sIndentString) Set the indent string to be used for writing JAXB objects.
GenericJAXBMarshaller<JAXBTYPE>	setNamespaceContext(NamespaceContext aNSContext) Set the namespace context (prefix to namespace URL mapping) to be used.
GenericJAXBMarshaller<JAXBTYPE>	setNoNamespaceSchemaLocation(String sNoNamespaceSchemaLocation) Set the no namespace schema location to be used for writing JAXB objects.
GenericJAXBMarshaller<JAXBTYPE>	setReadSecure(boolean bReadSecure) Enable or disable secure reading.
GenericJAXBMarshaller<JAXBTYPE>	setSchemaLocation(String sSchemaLocation) Set the schema location to be used for writing JAXB objects.
GenericJAXBMarshaller<JAXBTYPE>	setUseContextCache(boolean bUseContextCache) Change whether the context cache should be used or not.
GenericJAXBMarshaller<JAXBTYPE>	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.
com.helger.commons.callback.CallbackList<com.helger.commons.callback.exception.IExceptionCallback<JAXBException>>	writeExceptionCallbacks()

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, read

Methods inherited from interface com.helger.jaxb.IJAXBWriter

getAsByteBuffer, getAsBytes, getAsDocument, getAsInputStream, 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
                             QName aQName)

Constructor without XSD paths.

Parameters:

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

aQName - The qualified name in which the object should be wrapped. May not be null.

Since:

9.1.5

See Also:

createSimpleJAXBElement(QName, Class)

GenericJAXBMarshaller

public GenericJAXBMarshaller(@Nonnull
                             Class<JAXBTYPE> aType,
                             @Nonnull
                             Function<? 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
                             Function<? 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

getType

@Nonnull
protected final Class<JAXBTYPE> getType()

Returns:

The type as passed in the constructor. Never null.

Since:

v9.4.2

getClassLoader

@Nullable
public final ClassLoader getClassLoader()

Specified by:

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

setValidationEventHandlerFactory

@Nonnull
public final GenericJAXBMarshaller<JAXBTYPE> 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.

Returns:

this for chaining

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 GenericJAXBMarshaller<JAXBTYPE> 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:

this for chaining

getNamespaceContext

@Nullable
public final NamespaceContext getNamespaceContext()

Specified by:

getNamespaceContext in interface IJAXBWriter<JAXBTYPE>

Returns:

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

setNamespaceContext

@Nonnull
public final GenericJAXBMarshaller<JAXBTYPE> setNamespaceContext(@Nullable
                                                                           NamespaceContext 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:

this for chaining

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 GenericJAXBMarshaller<JAXBTYPE> setFormattedOutput(boolean bWriteFormatted)

Change the way formatting happens when calling write.

Parameters:

bWriteFormatted - true to write formatted output.

Returns:

this for chaining

Since:

8.5.3

getCharset

@Nullable
public final 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 final GenericJAXBMarshaller<JAXBTYPE> 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:

this for chaining

Since:

8.5.3

getIndentString

@Nullable
public final 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 final GenericJAXBMarshaller<JAXBTYPE> 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:

this for chaining

Since:

8.5.3

getSchemaLocation

@Nullable
public final String getSchemaLocation()

Specified by:

getSchemaLocation in interface IJAXBWriter<JAXBTYPE>

Returns:

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

setSchemaLocation

@Nonnull
public final GenericJAXBMarshaller<JAXBTYPE> 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:

this for chaining

Since:

8.6.0

getNoNamespaceSchemaLocation

@Nullable
public final 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 final GenericJAXBMarshaller<JAXBTYPE> 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:

this for chaining

Since:

9.0.0

isUseContextCache

public final boolean isUseContextCache()

setUseContextCache

@Nonnull
public final GenericJAXBMarshaller<JAXBTYPE> 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:

this for chaining

readExceptionCallbacks

@Nonnull
 @ReturnsMutableObject
public final com.helger.commons.callback.CallbackList<com.helger.commons.callback.exception.IExceptionCallback<JAXBException>> readExceptionCallbacks()

Returns:

Read exception callbacks. Never null.

Since:

9.2.2

writeExceptionCallbacks

@Nonnull
 @ReturnsMutableObject
public final com.helger.commons.callback.CallbackList<com.helger.commons.callback.exception.IExceptionCallback<JAXBException>> writeExceptionCallbacks()

Returns:

Write exception callbacks. Never null.

Since:

9.2.2

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.

getJAXBContext

@Nonnull
 @OverrideOnDemand
protected JAXBContext getJAXBContext(@Nullable
                                                                   ClassLoader aClassLoader)
                                                            throws JAXBException

Create the JAXBContext - cached or uncached.

Parameters:

aClassLoader - The class loader to be used for XML schema resolving. May be null.

Returns:

The created JAXBContext and never null.

Throws:

JAXBException - In case creation fails

Since:

9.4.2

customizeUnmarshaller

@OverrideOnDemand
protected void customizeUnmarshaller(@Nonnull
                                                        Unmarshaller aUnmarshaller)

Customize the passed unmarshaller before unmarshalling (reading) something.

Parameters:

aUnmarshaller - The object to customize. Never null.

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.

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

createSimpleJAXBElement

@Nonnull
public static <T> Function<T,JAXBElement<T>> createSimpleJAXBElement(@Nonnull
                                                                               QName aQName,
                                                                               @Nonnull
                                                                               Class<T> aClass)

Helper function to create a supplier for JAXBElement objects.

Type Parameters:

T - the type to wrap

Parameters:

aQName - QName to use. May not be null.

aClass - The implementation class to use.

Returns:

Never null.

Since:

9.1.5

See Also:

GenericJAXBMarshaller(Class, QName)