org.dataone.service.util

Class TypeMarshaller

java.lang.Object

org.dataone.service.util.TypeMarshaller

public class TypeMarshaller
extends Object

The standard class used to marshal and unmarshal datatypes to and from input and output streams and file structures. This class maintains static global state of expensive-to-create JAXB contexts. Schema validation is performed by default upon marshalling, using either the packaged DataONE schemas, or if set, from the list of schemas indicated by marshalling.d1.schema.urls (Can only be reset with restart of the runtime). Validation by default can be disabled with the configuration property 'marshalling.d1.schema.validation=false'

Author:

rwaltz

Field Summary

Fields

Modifier and Type	Field and Description
protected static Schema	D1_SCHEMAS The java representation of the DataONE schemas used to validate unmarshalling
protected static Map<Class,JAXBContext>	jaxbContextMap
protected static boolean	USE_SCHEMA_VALIDATION

Constructor Summary

Constructors

Constructor and Description
TypeMarshaller()

Method Summary

Methods

Modifier and Type	Method and Description
protected static JAXBContext	getJAXBContext(Class clazz) A method to manage JAXB data type contexts, as they are expensive to build and destroy.
static File	marshalTypeToFile(Object typeObject, String filenamePath) Marshalls the typeObject to the provided file.
static void	marshalTypeToOutputStream(Object typeObject, OutputStream os) Marshalls the typeObject to the provided outputStream.
static void	marshalTypeToOutputStream(Object typeObject, OutputStream os, String styleSheet) Marshalls the typeObject to the provided outputStream.
static <T> T	unmarshalTypeFromFile(Class<T> domainClass, File file) Unmarshals the contents of the filenamePath into the specified domainClass.
static <T> T	unmarshalTypeFromFile(Class<T> domainClass, String filenamePath) Unmarshalls the contents of file parameter to the specified domainClass
static <T> T	unmarshalTypeFromStream(Class<T> domainClass, InputStream inputStream) Unmarshals the inputStream to the specified domainClass and unequivocally closes the passed in InputStream .
static void	validateAgainstSchema(Object typeObject) A method to validate DataONE types against the schemas registered with the TypeMarshaller.

Methods inherited from class java.lang.Object

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

Field Detail

jaxbContextMap

protected static final Map<Class,JAXBContext> jaxbContextMap

USE_SCHEMA_VALIDATION

protected static final boolean USE_SCHEMA_VALIDATION

D1_SCHEMAS

protected static final Schema D1_SCHEMAS

The java representation of the DataONE schemas used to validate unmarshalling

Constructor Detail

TypeMarshaller

public TypeMarshaller()

Method Detail

getJAXBContext

protected static JAXBContext getJAXBContext(Class clazz)
                                     throws JAXBException

A method to manage JAXB data type contexts, as they are expensive to build and destroy. Contexts are thread safe, while the Marshallers and Unmarshallers built from these are not (and therefore not maintained).

Parameters:

clazz - - the class of the context needed

Returns:

the JAXBContext for the class

Throws:

JAXBException

validateAgainstSchema

public static void validateAgainstSchema(Object typeObject)
                                  throws MarshallingException

A method to validate DataONE types against the schemas registered with the TypeMarshaller. It delegates validation to the underlying SAX parse, but is more efficient than marshalTypeTo... methods in this class, because it does not create output streams, or generate any XML.

Parameters:

typeObject -

Throws:

MarshallingException

Since:

2.3.0

marshalTypeToFile

public static File marshalTypeToFile(Object typeObject,
                     String filenamePath)
                              throws MarshallingException,
                                     FileNotFoundException,
                                     IOException

Marshalls the typeObject to the provided file. Schema validation occurs by default.

Parameters:

typeObject -

filenamePath -

Throws:

MarshallingException

IOException

FileNotFoundException

marshalTypeToOutputStream

public static void marshalTypeToOutputStream(Object typeObject,
                             OutputStream os)
                                      throws MarshallingException,
                                             IOException

Marshalls the typeObject to the provided outputStream. Schema validation occurs by default. Does not close the outputstream.

Parameters:

typeObject -

os -

Throws:

MarshallingException

IOException

marshalTypeToOutputStream

public static void marshalTypeToOutputStream(Object typeObject,
                             OutputStream os,
                             String styleSheet)
                                      throws MarshallingException,
                                             IOException

Marshalls the typeObject to the provided outputStream. Schema validation occurs by default. Does not close the outputstream.

Parameters:

typeObject -

os -

styleSheet -

Throws:

MarshallingException

IOException

unmarshalTypeFromFile

public static <T> T unmarshalTypeFromFile(Class<T> domainClass,
                          File file)
                               throws IOException,
                                      InstantiationException,
                                      IllegalAccessException,
                                      MarshallingException

Unmarshals the contents of the filenamePath into the specified domainClass.

Type Parameters:

T -

Parameters:

domainClass -

file -

Returns:

- an instance of the domainClass

Throws:

IOException

InstantiationException

IllegalAccessException

MarshallingException

unmarshalTypeFromFile

public static <T> T unmarshalTypeFromFile(Class<T> domainClass,
                          String filenamePath)
                               throws IOException,
                                      InstantiationException,
                                      IllegalAccessException,
                                      MarshallingException

Unmarshalls the contents of file parameter to the specified domainClass

Type Parameters:

T -

Parameters:

domainClass -

filenamePath -

Returns:

- an instance of the domainClass

Throws:

IOException

InstantiationException

IllegalAccessException

MarshallingException

unmarshalTypeFromStream

public static <T> T unmarshalTypeFromStream(Class<T> domainClass,
                            InputStream inputStream)
                                 throws IOException,
                                        InstantiationException,
                                        IllegalAccessException,
                                        MarshallingException

Unmarshals the inputStream to the specified domainClass and unequivocally closes the passed in InputStream .

Type Parameters:

T -

Parameters:

domainClass -

inputStream -

Returns:

- an instance of the domainClass

Throws:

IOException

InstantiationException

IllegalAccessException

MarshallingException