Spring Framework 6.1.4 · org.springframework.oxm.jaxb.Jaxb2Marshaller

Modifier and Type	Class and Description
private static class	Jaxb2Marshaller.ByteArrayDataSource DataSource that wraps around a byte array.
private static class	Jaxb2Marshaller.Jaxb2AttachmentMarshaller
private static class	Jaxb2Marshaller.Jaxb2AttachmentUnmarshaller

Modifier and Type	Field and Description
private XmlAdapter<?, ?>[]	adapters
private ClassLoader	beanClassLoader
private boolean	checkForXmlRootElement
private static final String	CID
private Class<?>[]	classesToBeBound
private String	contextPath
private volatile JAXBContext	jaxbContext
private final Object	jaxbContextMonitor
private Map<String, ?>	jaxbContextProperties
private boolean	lazyInit
protected final Log	logger Logger available to subclasses.
private Class<?>	mappedClass
private Marshaller.Listener	marshallerListener
private Map<String, ?>	marshallerProperties
private boolean	mtomEnabled
private static final EntityResolver	NO_OP_ENTITY_RESOLVER
private String[]	packagesToScan
private boolean	processExternalEntities
private Schema	schema
private String	schemaLanguage
private LSResourceResolver	schemaResourceResolver
private Resource[]	schemaResources
private boolean	supportDtd
private boolean	supportJaxbElementClass
private Unmarshaller.Listener	unmarshallerListener
private Map<String, ?>	unmarshallerProperties
private ValidationEventHandler	validationEventHandler

Access	Constructor and Description
public	Jaxb2Marshaller()

Method Summary

Modifier and Type	Method and Description
public void	afterPropertiesSet() Implements org.springframework.beans.factory.InitializingBean.afterPropertiesSet. Invoked by the containing `BeanFactory` after it has set all bean properties and satisfied `BeanFactoryAware`, `ApplicationContextAware` etc. This method allows the bean instance to perform validation of its overall configuration and final initialization when all bean properties have been set.
protected XmlMappingException	Returns: the corresponding `XmlMappingException` convertJaxbException(JAXBException `JAXBException` that occurred ex) Convert the given `JAXBException` to an appropriate exception from the `org.springframework.oxm` hierarchy.
private JAXBContext	createJaxbContextFromClasses(Class<?>... classesToBeBound)
private JAXBContext	createJaxbContextFromContextPath(String contextPath)
private JAXBContext	createJaxbContextFromPackages(String... packagesToScan)
public Marshaller	createMarshaller() Return a newly created JAXB marshaller.
public Unmarshaller	createUnmarshaller() Return a newly created JAXB unmarshaller.
public Class<?>[]	getClassesToBeBound() Return the list of Java classes to be recognized by a newly created JAXBContext.
public String	getContextPath() Return the JAXB context path.
public JAXBContext	getJaxbContext() Return the JAXBContext used by this marshaller, lazily building it if necessary.
public String[]	getPackagesToScan() Return the packages to search for JAXB2 annotations.
protected void	initJaxbMarshaller(Marshaller marshaller) Template method that can be overridden by concrete JAXB marshallers for custom initialization behavior.
protected void	initJaxbUnmarshaller(Unmarshaller unmarshaller) Template method that can be overridden by concrete JAXB marshallers for custom initialization behavior.
private boolean	isPrimitiveWrapper(Class<?> clazz) Checks whether the given type is a primitive wrapper type.
public boolean	isProcessExternalEntities() Return whether XML external entities are allowed.
private boolean	isStandardClass(Class<?> clazz) Checks whether the given type is a standard class.
public boolean	isSupportDtd() Return whether DTD parsing is supported.
private Schema	loadSchema(Resource[] resources, String schemaLanguage)
public void	marshal(Object the root of the object graph to marshal graph, Result the result to marshal to result) Implements org.springframework.oxm.Marshaller.marshal. Marshal the object graph with the given root into the provided `Result`.
public void	marshal(Object the root of the object graph to marshal graph, Result the result to marshal to result, MimeContainer the MIME container to write extracted binary content to mimeContainer) Implements org.springframework.oxm.mime.MimeMarshaller.marshal. Marshals the object graph with the given root into the provided `Result`, writing binary data to a `MimeContainer`.
private void	marshalStaxResult(Marshaller jaxbMarshaller, Object graph, Result staxResult)
private Source	processSource(Source source)
public void	setAdapters(XmlAdapter<?, ?>... adapters) Specify the `XmlAdapter`s to be registered with the JAXB `Marshaller` and `Unmarshaller`.
public void	setBeanClassLoader(ClassLoader the owning class loader classLoader) Implements org.springframework.beans.factory.BeanClassLoaderAware.setBeanClassLoader. Callback that supplies the bean `class loader` to a bean instance.
public void	setCheckForXmlRootElement(boolean checkForXmlRootElement) Specify whether the `supports(Class)` should check for `@XmlRootElement` annotations.
public void	setClassesToBeBound(Class<?>... classesToBeBound) Set the list of Java classes to be recognized by a newly created JAXBContext.
public void	setContextPath(String contextPath) Set a JAXB context path.
public void	setContextPaths(String... contextPaths) Set multiple JAXB context paths.
public void	setJaxbContextProperties(Map<String, ?> jaxbContextProperties) Set the `JAXBContext` properties.
public void	setLazyInit(boolean lazyInit) Set whether to lazily initialize the `JAXBContext` for this marshaller.
public void	setMappedClass(Class<?> mappedClass) Specify a JAXB mapped class for partial unmarshalling.
public void	setMarshallerListener(Marshaller.Listener marshallerListener) Specify the `Marshaller.Listener` to be registered with the JAXB `Marshaller`.
public void	setMarshallerProperties(Map<String, ?> the properties properties) Set the JAXB `Marshaller` properties.
public void	setMtomEnabled(boolean mtomEnabled) Specify whether MTOM support should be enabled or not.
public void	setPackagesToScan(String... packagesToScan) Set the packages to search for classes with JAXB2 annotations in the classpath.
public void	setProcessExternalEntities(boolean processExternalEntities) Indicate whether external XML entities are processed when unmarshalling.
public void	setSchema(Resource schemaResource) Set the schema resource to use for validation.
public void	setSchemaLanguage(String schemaLanguage) Set the schema language.
public void	setSchemaResourceResolver(LSResourceResolver schemaResourceResolver) Set the resource resolver, as used to load the schema resources.
public void	setSchemas(Resource... schemaResources) Set the schema resources to use for validation.
public void	setSupportDtd(boolean supportDtd) Indicate whether DTD parsing should be supported.
public void	setSupportJaxbElementClass(boolean supportJaxbElementClass) Specify whether the `supports(Class)` returns `true` for the `JAXBElement` class.
public void	setUnmarshallerListener(Unmarshaller.Listener unmarshallerListener) Set the `Unmarshaller.Listener` to be registered with the JAXB `Unmarshaller`.
public void	setUnmarshallerProperties(Map<String, ?> the properties properties) Set the JAXB `Unmarshaller` properties.
public void	setValidationEventHandler(ValidationEventHandler validationEventHandler) Set the JAXB validation event handler.
public boolean	supports(Class<?> the class that this marshaller is being asked if it can marshal clazz) Implements org.springframework.oxm.Marshaller.supports, org.springframework.oxm.Unmarshaller.supports. Indicate whether this marshaller can marshal instances of the supplied type.
public boolean	supports(Type the type that this marshaller is being asked if it can marshal genericType) Implements org.springframework.oxm.GenericMarshaller.supports, org.springframework.oxm.GenericUnmarshaller.supports. Indicates whether this marshaller can marshal instances of the supplied generic type.
private boolean	supportsInternal(Class<?> clazz, boolean checkForXmlRootElement)
public Object	unmarshal(Source the source to marshal from source) Implements org.springframework.oxm.Unmarshaller.unmarshal. Unmarshal the given `Source` into an object graph.
public Object	unmarshal(Source the source to marshal from source, MimeContainer the MIME container to read extracted binary content from mimeContainer) Implements org.springframework.oxm.mime.MimeUnmarshaller.unmarshal. Unmarshals the given provided `Source` into an object graph, reading binary attachments from a `MimeContainer`.
protected Object	unmarshalStaxSource(Unmarshaller jaxbUnmarshaller, Source staxSource)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

public Class Jaxb2Marshaller

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary