Package org.jboss.resteasy.plugins.providers.jaxb

Class SecureUnmarshaller

java.lang.Object

org.jboss.resteasy.plugins.providers.jaxb.SecureUnmarshaller

All Implemented Interfaces:

Unmarshaller

public class SecureUnmarshaller
extends Object
implements Unmarshaller

Version:

$Revision: 1.1 $ Created Feb 1, 2012

Author:

Ron Sigal

Nested Class Summary

Nested classes/interfaces inherited from interface jakarta.xml.bind.Unmarshaller

Unmarshaller.Listener

Constructor Summary

Constructors

Constructor	Description
SecureUnmarshaller(Unmarshaller delegate, boolean disableExternalEntities, boolean enableSecureProcessingFeature, boolean disableDTDs)

Method Summary

Modifier and Type	Method	Description
protected static void	configureParserFactory(SAXParserFactory factory, boolean disableExternalEntities, boolean enableSecureProcessingFeature, boolean disableDTDs)
<A extends XmlAdapter> A	getAdapter(Class<A> type)
AttachmentUnmarshaller	getAttachmentUnmarshaller()
Unmarshaller	getDelegate()
ValidationEventHandler	getEventHandler()	Return the current event handler or the default event handler if one hasn't been set.
Unmarshaller.Listener	getListener()	Return Unmarshaller.Listener registered with this Unmarshaller.
Object	getProperty(String name)	Get the particular property in the underlying implementation of Unmarshaller.
Schema	getSchema()	Get the JAXP Schema object being used to perform unmarshal-time validation.
UnmarshallerHandler	getUnmarshallerHandler()	Get an unmarshaller handler object that can be used as a component in an XML pipeline.
boolean	isValidating()	Deprecated. This method is deprecated as of JAXB 2.0 - please use the new getSchema() API.
void	setAdapter(XmlAdapter adapter)	Associates a configured instance of XmlAdapter with this unmarshaller.
<A extends XmlAdapter> void	setAdapter(Class<A> type, A adapter)
void	setAttachmentUnmarshaller(AttachmentUnmarshaller au)	Associate a context that resolves cid's, content-id URIs, to binary data passed as attachments.
void	setDelegate(Unmarshaller delegate)
void	setEventHandler(ValidationEventHandler handler)	Allow an application to register a ValidationEventHandler.
void	setListener(Unmarshaller.Listener listener)	Register unmarshal event callback Unmarshaller.Listener with this Unmarshaller.
void	setProperty(String name, Object value)	Set the particular property in the underlying implementation of Unmarshaller.
void	setSchema(Schema schema)	Specify the JAXP Schema object that should be used to validate subsequent unmarshal operations against.
void	setValidating(boolean validating)	Deprecated. since JAXB2.0, please see getSchema()
Object	unmarshal(File f)	Unmarshal XML data from the specified file and return the resulting content tree.
Object	unmarshal(InputStream is)	Turns off expansion of external entities.
Object	unmarshal(Reader reader)	Unmarshal XML data from the specified Reader and return the resulting content tree.
Object	unmarshal(URL url)	Unmarshal XML data from the specified URL and return the resulting content tree.
Object	unmarshal(XMLEventReader reader)	Unmarshal XML data from the specified pull parser and return the resulting content tree.
<T> JAXBElement<T>	unmarshal(XMLEventReader reader, Class<T> declaredType)	Unmarshal root element to Jakarta XML Binding mapped declaredType and return the resulting content tree.
Object	unmarshal(XMLStreamReader reader)	Unmarshal XML data from the specified pull parser and return the resulting content tree.
<T> JAXBElement<T>	unmarshal(XMLStreamReader reader, Class<T> declaredType)	Unmarshal root element to Jakarta XML Binding mapped declaredType and return the resulting content tree.
Object	unmarshal(Source source)	Unmarshal XML data from the specified XML Source and return the resulting content tree.
<T> JAXBElement<T>	unmarshal(Source source, Class<T> declaredType)	Unmarshal XML data from the specified XML Source by declaredType and return the resulting content tree.
Object	unmarshal(Node node)	Unmarshal global XML data from the specified DOM tree and return the resulting content tree.
<T> JAXBElement<T>	unmarshal(Node node, Class<T> declaredType)	Unmarshal XML data by Jakarta XML Binding mapped declaredType and return the resulting content tree.
Object	unmarshal(InputSource source)	Turns off expansion of external entities.

Methods inherited from class java.lang.Object

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

Methods inherited from interface jakarta.xml.bind.Unmarshaller

getAdapter, setAdapter

Constructor Details

SecureUnmarshaller

public SecureUnmarshaller(Unmarshaller delegate,
 boolean disableExternalEntities,
 boolean enableSecureProcessingFeature,
 boolean disableDTDs)

Method Details

getAdapter

public <A extends XmlAdapter> A getAdapter(Class<A> type)

getAttachmentUnmarshaller

public AttachmentUnmarshaller getAttachmentUnmarshaller()

Specified by:

getAttachmentUnmarshaller in interface Unmarshaller

getEventHandler

public ValidationEventHandler getEventHandler()
                                       throws JAXBException

Description copied from interface: Unmarshaller

Return the current event handler or the default event handler if one hasn't been set.

Specified by:

getEventHandler in interface Unmarshaller

Returns:

the current ValidationEventHandler or the default event handler if it hasn't been set

Throws:

JAXBException - if an error was encountered while getting the current event handler

getListener

public Unmarshaller.Listener getListener()

Description copied from interface: Unmarshaller

Return Unmarshaller.Listener registered with this Unmarshaller.

Specified by:

getListener in interface Unmarshaller

Returns:

registered Unmarshaller.Listener or null if no Listener is registered with this Unmarshaller.

getProperty

public Object getProperty(String name)
                   throws PropertyException

Description copied from interface: Unmarshaller

Get the particular property in the underlying implementation of Unmarshaller. This method can only be used to get one of the standard Jakarta XML Binding defined properties above or a provider specific property. Attempting to get an undefined property will result in a PropertyException being thrown. See Supported Properties.

Specified by:

getProperty in interface Unmarshaller

Parameters:

name - the name of the property to retrieve

Returns:

the value of the requested property

Throws:

PropertyException - when there is an error retrieving the given property or value property name

getSchema

public Schema getSchema()

Description copied from interface: Unmarshaller

Get the JAXP Schema object being used to perform unmarshal-time validation. If there is no Schema set on the unmarshaller, then this method will return null indicating that unmarshal-time validation will not be performed.

Specified by:

getSchema in interface Unmarshaller

Returns:

the Schema object being used to perform unmarshal-time validation or null if not present

getUnmarshallerHandler

public UnmarshallerHandler getUnmarshallerHandler()

Description copied from interface: Unmarshaller

Get an unmarshaller handler object that can be used as a component in an XML pipeline.

The Jakarta XML Binding Provider can return the same handler object for multiple invocations of this method. In other words, this method does not necessarily create a new instance of UnmarshallerHandler. If the application needs to use more than one UnmarshallerHandler, it should create more than one Unmarshaller.

Specified by:

getUnmarshallerHandler in interface Unmarshaller

Returns:

the unmarshaller handler object

See Also:

• UnmarshallerHandler

isValidating

@Deprecated
public boolean isValidating()
                     throws JAXBException

Deprecated.

This method is deprecated as of JAXB 2.0 - please use the new getSchema() API.

Throws:

JAXBException

setAdapter

public void setAdapter(XmlAdapter adapter)

Description copied from interface: Unmarshaller

Associates a configured instance of XmlAdapter with this unmarshaller.

This is a convenience method that invokes setAdapter(adapter.getClass(),adapter);.

Specified by:

setAdapter in interface Unmarshaller

Parameters:

adapter - the configured instance of XmlAdapter

See Also:

• Unmarshaller.setAdapter(Class,XmlAdapter)

setAdapter

public <A extends XmlAdapter> void setAdapter(Class<A> type,
 A adapter)

setAttachmentUnmarshaller

public void setAttachmentUnmarshaller(AttachmentUnmarshaller au)

Description copied from interface: Unmarshaller

Associate a context that resolves cid's, content-id URIs, to binary data passed as attachments. Unmarshal time validation, enabled via Unmarshaller.setSchema(Schema), must be supported even when unmarshaller is performing XOP processing.

Specified by:

setAttachmentUnmarshaller in interface Unmarshaller

Parameters:

au - the attachment unmarshaller to be set

setEventHandler

public void setEventHandler(ValidationEventHandler handler)
                     throws JAXBException

Description copied from interface: Unmarshaller

Allow an application to register a ValidationEventHandler.

The ValidationEventHandler will be called by the Jakarta XML Binding Provider if any validation errors are encountered during calls to any of the unmarshal methods. If the client application does not register a ValidationEventHandler before invoking the unmarshal methods, then ValidationEvents will be handled by the default event handler which will terminate the unmarshal operation after the first error or fatal error is encountered.

Calling this method with a null parameter will cause the Unmarshaller to revert back to the default event handler.

Specified by:

setEventHandler in interface Unmarshaller

Parameters:

handler - the validation event handler

Throws:

JAXBException - if an error was encountered while setting the event handler

setListener

public void setListener(Unmarshaller.Listener listener)

Description copied from interface: Unmarshaller

Register unmarshal event callback Unmarshaller.Listener with this Unmarshaller.

There is only one Listener per Unmarshaller. Setting a Listener replaces the previous set Listener. One can unregister current Listener by setting listener to null.

Specified by:

setListener in interface Unmarshaller

Parameters:

listener - provides unmarshal event callbacks for this Unmarshaller

setProperty

public void setProperty(String name,
 Object value)
                 throws PropertyException

Description copied from interface: Unmarshaller

Set the particular property in the underlying implementation of Unmarshaller. This method can only be used to set one of the standard Jakarta XML Binding defined properties above or a provider specific property. Attempting to set an undefined property will result in a PropertyException being thrown. See Supported Properties.

Specified by:

setProperty in interface Unmarshaller

Parameters:

name - the name of the property to be set. This value can either be specified using one of the constant fields or a user supplied string.

value - the value of the property to be set

Throws:

PropertyException - when there is an error processing the given property or value

setSchema

public void setSchema(Schema schema)

Description copied from interface: Unmarshaller

Specify the JAXP Schema object that should be used to validate subsequent unmarshal operations against. Passing null into this method will disable validation.

Initially this property is set to null.

Specified by:

setSchema in interface Unmarshaller

Parameters:

schema - Schema object to validate unmarshal operations against or null to disable validation

setValidating

@Deprecated
public void setValidating(boolean validating)
                   throws JAXBException

Deprecated.

since JAXB2.0, please see getSchema()

Throws:

JAXBException

unmarshal

public Object unmarshal(File f)
                 throws JAXBException

Description copied from interface: Unmarshaller

Unmarshal XML data from the specified file and return the resulting content tree.

Implements Unmarshal Global Root Element.

Specified by:

unmarshal in interface Unmarshaller

Parameters:

f - the file to unmarshal XML data from

Returns:

the newly created root object of the java content tree

Throws:

JAXBException - If any unexpected errors occur while unmarshalling

UnmarshalException - If the ValidationEventHandler returns false from its handleEvent method or the Unmarshaller is unable to perform the XML to Java binding. See Unmarshalling XML Data

unmarshal

public Object unmarshal(InputStream is)
                 throws JAXBException

Turns off expansion of external entities.

Specified by:

unmarshal in interface Unmarshaller

Parameters:

is - the InputStream to unmarshal XML data from

Returns:

the newly created root object of the java content tree

Throws:

JAXBException - If any unexpected errors occur while unmarshalling

UnmarshalException - If the ValidationEventHandler returns false from its handleEvent method or the Unmarshaller is unable to perform the XML to Java binding. See Unmarshalling XML Data

unmarshal

public Object unmarshal(Reader reader)
                 throws JAXBException

Description copied from interface: Unmarshaller

Unmarshal XML data from the specified Reader and return the resulting content tree. Validation event location information may be incomplete when using this form of the unmarshal API, because a Reader does not provide the system ID.

Implements Unmarshal Global Root Element.

Specified by:

unmarshal in interface Unmarshaller

Parameters:

reader - the Reader to unmarshal XML data from

Returns:

the newly created root object of the java content tree

Throws:

JAXBException - If any unexpected errors occur while unmarshalling

UnmarshalException - If the ValidationEventHandler returns false from its handleEvent method or the Unmarshaller is unable to perform the XML to Java binding. See Unmarshalling XML Data

unmarshal

public Object unmarshal(URL url)
                 throws JAXBException

Description copied from interface: Unmarshaller

Unmarshal XML data from the specified URL and return the resulting content tree.

Implements Unmarshal Global Root Element.

Specified by:

unmarshal in interface Unmarshaller

Parameters:

url - the url to unmarshal XML data from

Returns:

the newly created root object of the java content tree

Throws:

JAXBException - If any unexpected errors occur while unmarshalling

UnmarshalException - If the ValidationEventHandler returns false from its handleEvent method or the Unmarshaller is unable to perform the XML to Java binding. See Unmarshalling XML Data

unmarshal

public Object unmarshal(InputSource source)
                 throws JAXBException

Turns off expansion of external entities.

Specified by:

unmarshal in interface Unmarshaller

Parameters:

source - the input source to unmarshal XML data from

Returns:

the newly created root object of the java content tree

Throws:

JAXBException - If any unexpected errors occur while unmarshalling

UnmarshalException - If the ValidationEventHandler returns false from its handleEvent method or the Unmarshaller is unable to perform the XML to Java binding. See Unmarshalling XML Data

unmarshal

public Object unmarshal(Node node)
                 throws JAXBException

Description copied from interface: Unmarshaller

Unmarshal global XML data from the specified DOM tree and return the resulting content tree.

Implements Unmarshal Global Root Element.

Specified by:

unmarshal in interface Unmarshaller

Parameters:

node - the document/element to unmarshal XML data from. The caller must support at least Document and Element.

Returns:

the newly created root object of the java content tree

Throws:

JAXBException - If any unexpected errors occur while unmarshalling

UnmarshalException - If the ValidationEventHandler returns false from its handleEvent method or the Unmarshaller is unable to perform the XML to Java binding. See Unmarshalling XML Data

See Also:

• Unmarshaller.unmarshal(org.w3c.dom.Node, Class)

unmarshal

public Object unmarshal(Source source)
                 throws JAXBException

Description copied from interface: Unmarshaller

Unmarshal XML data from the specified XML Source and return the resulting content tree.

Implements Unmarshal Global Root Element.

SAX 2.0 Parser Pluggability

A client application can choose not to use the default parser mechanism supplied with their Jakarta XML Binding provider. Any SAX 2.0 compliant parser can be substituted for the Jakarta XML Binding provider's default mechanism. To do so, the client application must properly configure a SAXSource containing an XMLReader implemented by the SAX 2.0 parser provider. If the XMLReader has an org.xml.sax.ErrorHandler registered on it, it will be replaced by the Jakarta XML Binding Provider so that validation errors can be reported via the ValidationEventHandler mechanism of Jakarta XML Binding. If the SAXSource does not contain an XMLReader, then the Jakarta XML Binding provider's default parser mechanism will be used.

This parser replacement mechanism can also be used to replace the Jakarta XML Binding provider's unmarshal-time validation engine. The client application must properly configure their SAX 2.0 compliant parser to perform validation (as shown in the example above). Any SAXParserExceptions encountered by the parser during the unmarshal operation will be processed by the Jakarta XML Binding provider and converted into Jakarta XML Binding ValidationEvent objects which will be reported back to the client via the ValidationEventHandler registered with the Unmarshaller. Note: specifying a substitute validating SAX 2.0 parser for unmarshalling does not necessarily replace the validation engine used by the Jakarta XML Binding provider for performing on-demand validation.

The only way for a client application to specify an alternate parser mechanism to be used during unmarshal is via the unmarshal(SAXSource) API. All other forms of the unmarshal method (File, URL, Node, etc.) will use the Jakarta XML Binding provider's default parser and validator mechanisms.

Specified by:

unmarshal in interface Unmarshaller

Parameters:

source - the XML Source to unmarshal XML data from (providers are only required to support SAXSource, DOMSource, and StreamSource)

Returns:

the newly created root object of the java content tree

Throws:

JAXBException - If any unexpected errors occur while unmarshalling

UnmarshalException - If the ValidationEventHandler returns false from its handleEvent method or the Unmarshaller is unable to perform the XML to Java binding. See Unmarshalling XML Data

See Also:

• Unmarshaller.unmarshal(javax.xml.transform.Source, Class)

unmarshal

public Object unmarshal(XMLStreamReader reader)
                 throws JAXBException

Description copied from interface: Unmarshaller

Unmarshal XML data from the specified pull parser and return the resulting content tree.

Implements Unmarshal Global Root Element.

This method assumes that the parser is on a START_DOCUMENT or START_ELEMENT event. Unmarshalling will be done from this start event to the corresponding end event. If this method returns successfully, the reader will be pointing at the token right after the end event.

Specified by:

unmarshal in interface Unmarshaller

Parameters:

reader - The parser to be read.

Returns:

the newly created root object of the java content tree.

Throws:

JAXBException - If any unexpected errors occur while unmarshalling

UnmarshalException - If the ValidationEventHandler returns false from its handleEvent method or the Unmarshaller is unable to perform the XML to Java binding. See Unmarshalling XML Data

See Also:

• Unmarshaller.unmarshal(javax.xml.stream.XMLStreamReader, Class)

unmarshal

public Object unmarshal(XMLEventReader reader)
                 throws JAXBException

Description copied from interface: Unmarshaller

Unmarshal XML data from the specified pull parser and return the resulting content tree.

This method is an Unmarshal Global Root method.

This method assumes that the parser is on a START_DOCUMENT or START_ELEMENT event. Unmarshalling will be done from this start event to the corresponding end event. If this method returns successfully, the reader will be pointing at the token right after the end event.

Specified by:

unmarshal in interface Unmarshaller

Parameters:

reader - The parser to be read.

Returns:

the newly created root object of the java content tree.

Throws:

JAXBException - If any unexpected errors occur while unmarshalling

UnmarshalException - If the ValidationEventHandler returns false from its handleEvent method or the Unmarshaller is unable to perform the XML to Java binding. See Unmarshalling XML Data

See Also:

• Unmarshaller.unmarshal(javax.xml.stream.XMLEventReader, Class)

unmarshal

public <T> JAXBElement<T> unmarshal(Node node,
 Class<T> declaredType)
                             throws JAXBException

Description copied from interface: Unmarshaller

Unmarshal XML data by Jakarta XML Binding mapped declaredType and return the resulting content tree.

Implements Unmarshal by Declared Type

Specified by:

unmarshal in interface Unmarshaller

Type Parameters:

T - the XML Binding mapped class

Parameters:

node - the document/element to unmarshal XML data from. The caller must support at least Document and Element.

declaredType - appropriate Jakarta XML Binding mapped class to hold node's XML data.

Returns:

JAXBElement representation of node

Throws:

JAXBException - If any unexpected errors occur while unmarshalling

UnmarshalException - If the ValidationEventHandler returns false from its handleEvent method or the Unmarshaller is unable to perform the XML to Java binding. See Unmarshalling XML Data

unmarshal

public <T> JAXBElement<T> unmarshal(Source source,
 Class<T> declaredType)
                             throws JAXBException

Description copied from interface: Unmarshaller

Unmarshal XML data from the specified XML Source by declaredType and return the resulting content tree.

Implements Unmarshal by Declared Type

See SAX 2.0 Parser Pluggability

Specified by:

unmarshal in interface Unmarshaller

Type Parameters:

T - the XML Binding mapped class

Parameters:

source - the XML Source to unmarshal XML data from (providers are only required to support SAXSource, DOMSource, and StreamSource)

declaredType - appropriate Jakarta XML Binding mapped class to hold source's xml root element

Returns:

Java content rooted by JAXBElement

Throws:

JAXBException - If any unexpected errors occur while unmarshalling

UnmarshalException - If the ValidationEventHandler returns false from its handleEvent method or the Unmarshaller is unable to perform the XML to Java binding. See Unmarshalling XML Data

unmarshal

public <T> JAXBElement<T> unmarshal(XMLStreamReader reader,
 Class<T> declaredType)
                             throws JAXBException

Description copied from interface: Unmarshaller

Unmarshal root element to Jakarta XML Binding mapped declaredType and return the resulting content tree.

This method implements unmarshal by declaredType.

This method assumes that the parser is on a START_DOCUMENT or START_ELEMENT event. Unmarshalling will be done from this start event to the corresponding end event. If this method returns successfully, the reader will be pointing at the token right after the end event.

Specified by:

unmarshal in interface Unmarshaller

Type Parameters:

T - the XML Binding mapped class

Parameters:

reader - The parser to be read.

declaredType - appropriate Jakarta XML Binding mapped class to hold reader's START_ELEMENT XML data.

Returns:

content tree rooted by JAXBElement representation

Throws:

JAXBException - If any unexpected errors occur while unmarshalling

UnmarshalException - If the ValidationEventHandler returns false from its handleEvent method or the Unmarshaller is unable to perform the XML to Java binding. See Unmarshalling XML Data

unmarshal

public <T> JAXBElement<T> unmarshal(XMLEventReader reader,
 Class<T> declaredType)
                             throws JAXBException

Description copied from interface: Unmarshaller

Unmarshal root element to Jakarta XML Binding mapped declaredType and return the resulting content tree.

This method implements unmarshal by declaredType.

This method assumes that the parser is on a START_DOCUMENT or START_ELEMENT event. Unmarshalling will be done from this start event to the corresponding end event. If this method returns successfully, the reader will be pointing at the token right after the end event.

Specified by:

unmarshal in interface Unmarshaller

Type Parameters:

T - the XML Binding mapped class

Parameters:

reader - The parser to be read.

declaredType - appropriate Jakarta XML Binding mapped class to hold reader's START_ELEMENT XML data.

Returns:

content tree rooted by JAXBElement representation

Throws:

JAXBException - If any unexpected errors occur while unmarshalling

UnmarshalException - If the ValidationEventHandler returns false from its handleEvent method or the Unmarshaller is unable to perform the XML to Java binding. See Unmarshalling XML Data

getDelegate

public Unmarshaller getDelegate()

setDelegate

public void setDelegate(Unmarshaller delegate)

configureParserFactory

protected static void configureParserFactory(SAXParserFactory factory,
 boolean disableExternalEntities,
 boolean enableSecureProcessingFeature,
 boolean disableDTDs)
                                      throws ParserConfigurationException,
SAXNotRecognizedException,
SAXNotSupportedException

Throws:

ParserConfigurationException

SAXNotRecognizedException

SAXNotSupportedException