ee.ria.dhx.ws.service.impl

Class DhxMarshallerServiceImpl

java.lang.Object

ee.ria.dhx.ws.service.impl.DhxMarshallerServiceImpl

All Implemented Interfaces:

DhxMarshallerService

@Service(value="dhxMarshallerService")
public class DhxMarshallerServiceImpl
extends java.lang.Object
implements DhxMarshallerService

Version DhxMarshallerService for capsules with big data files. No limitation on data file size is set, data files from capsule are written to filesystem.

In order for big data logic to work, object parameter which might be BIG must be annotated with BigDataXmlElement annotation and be of type File. XMLSerializer is used during marshalling/unmarshalling process and does all the job except for the parameters annotated with BigDataXmlElement.

Author:

Aleksei Kokarev

Constructor Summary

Constructors

Constructor and Description
DhxMarshallerServiceImpl()

Method Summary

Modifier and Type	Method and Description
javax.xml.bind.JAXBContext	getJaxbContext() Returns the jaxbContext.
javax.xml.bind.Marshaller	getMarshaller() Method returns marshaller.
javax.xml.bind.Unmarshaller	getUnmarshaller() Method returns unmarshaller.
void	init() Postconstruct init method.
java.io.File	marshall(java.lang.Object container) Marshalls object to file.
void	marshall(java.lang.Object container, java.io.File file) Marshalls object to given file.
void	marshallToOutputStream(java.lang.Object container, java.io.OutputStream stream) Marshalls object to outputStream.
void	marshallToOutputStreamNoNamespacePrefixes(java.lang.Object container, java.io.OutputStream stream, java.lang.Boolean includeXmlns) Marshalls object to outputStream, removes all namespace prefixes from XML.
void	marshallToResult(java.lang.Object obj, javax.xml.transform.Result result) Marshalls object to result.
java.io.StringWriter	marshallToWriter(java.lang.Object container) Marshalls object to writer.
java.io.StringWriter	marshallToWriterAndValidate(java.lang.Object container, java.io.InputStream schemaStream) Marshalls object to writer and validates object if schemaStream is present.
<T> T	unmarshall(java.io.File capsuleFile) Parses(unmarshalls) object from file.
<T> T	unmarshall(java.io.File capsuleFile, java.lang.Class<? extends java.lang.Object> bigDataClass) Parses(unmarshalls) object from file.
<T> T	unmarshall(java.io.InputStream capsuleStream) Parses(unmarshalls) object from file.
<T> T	unmarshall(java.io.InputStream capsuleStream, java.lang.Class<? extends java.lang.Object> bigDataClass) Parses(unmarshalls) object from file.
<T> T	unmarshall(org.w3c.dom.Node node) Parses(unmarshalls) object from Node.
<T> T	unmarshall(javax.xml.transform.Source source) Method parses(unmarshalls) object.
<T> T	unmarshallAndValidate(java.io.File capsuleFile, java.io.InputStream schemaStream) Parses(unmarshalls) object from file.
<T> T	unmarshallAndValidate(java.io.InputStream capsuleStream, java.io.InputStream schemaStream) Parses(unmarshalls) object from file.
<T> T	unmarshallAndValidate(java.io.InputStream capsuleStream, java.io.InputStream schemaStream, java.lang.Class<? extends java.lang.Object> bigDataClass) Parses(unmarshalls) object from file.
void	validate(java.io.File file, java.io.InputStream schemaStream) Method validates file against XSD schema.
void	validate(java.io.InputStream fileStream, java.io.InputStream schemaStream) Function validates file against XSD schema.

Methods inherited from class java.lang.Object

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

Constructor Detail

DhxMarshallerServiceImpl

public DhxMarshallerServiceImpl()

Method Detail

getUnmarshaller

public javax.xml.bind.Unmarshaller getUnmarshaller()
                                            throws ee.ria.dhx.exception.DhxException

Description copied from interface: DhxMarshallerService

Method returns unmarshaller.

Specified by:

getUnmarshaller in interface DhxMarshallerService

Returns:

marshaller

Throws:

ee.ria.dhx.exception.DhxException - - thrown if error occured

getMarshaller

public javax.xml.bind.Marshaller getMarshaller()
                                        throws ee.ria.dhx.exception.DhxException

Description copied from interface: DhxMarshallerService

Method returns marshaller.

Specified by:

getMarshaller in interface DhxMarshallerService

Returns:

marshaller

Throws:

ee.ria.dhx.exception.DhxException - - thrown if error occured

init

@PostConstruct
public void init()
                          throws javax.xml.bind.JAXBException

Postconstruct init method. Sets marshallers needed for that service.

Throws:

javax.xml.bind.JAXBException - - thrown when error occured

unmarshall

@Loggable
public <T> T unmarshall(javax.xml.transform.Source source)
                            throws ee.ria.dhx.exception.DhxException

Method parses(unmarshalls) object.

Specified by:

unmarshall in interface DhxMarshallerService

Type Parameters:

T - - type of the capsule being unmarshalled

Parameters:

source - - source of the marshalled object

Returns:

- unmarshalled object

Throws:

ee.ria.dhx.exception.DhxException - - thrown if error occurs while unmrashalling object

unmarshall

@Loggable
public <T> T unmarshall(java.io.File capsuleFile)
                            throws ee.ria.dhx.exception.DhxException

Parses(unmarshalls) object from file.

Specified by:

unmarshall in interface DhxMarshallerService

Type Parameters:

T - - type of the capsule being unmarshalled

Parameters:

capsuleFile - - file to parse

Returns:

- parsed(unmarshalled) object

Throws:

ee.ria.dhx.exception.DhxException - - thrown if error occurs while parsing file

unmarshall

@Loggable
public <T> T unmarshall(java.io.InputStream capsuleStream)
                            throws ee.ria.dhx.exception.DhxException

Parses(unmarshalls) object from file.

Specified by:

unmarshall in interface DhxMarshallerService

Type Parameters:

T - - type of the capsule being unmarshalled

Parameters:

capsuleStream - - stream to parse

Returns:

- parsed(unmarshalled) object

Throws:

ee.ria.dhx.exception.DhxException - - thrown if error occurs while parsing file

unmarshall

@Loggable
public <T> T unmarshall(java.io.File capsuleFile,
                                   java.lang.Class<? extends java.lang.Object> bigDataClass)
                            throws ee.ria.dhx.exception.DhxException

Parses(unmarshalls) object from file.

Type Parameters:

T - - type of the capsule being unmarshalled

Parameters:

capsuleFile - file to parse

bigDataClass - class having big data that is being unmarshalled or null if no big datat is expected

Returns:

parsed(unmarshalled) object

Throws:

ee.ria.dhx.exception.DhxException - - thrown if error occurs while parsing file

unmarshall

public <T> T unmarshall(org.w3c.dom.Node node)
                 throws ee.ria.dhx.exception.DhxException

Parses(unmarshalls) object from Node.

Specified by:

unmarshall in interface DhxMarshallerService

Type Parameters:

T - - type of the capsule being unmarshalled

Parameters:

node - - node to unmarshall

Returns:

- parsed(unmarshalled) object

Throws:

ee.ria.dhx.exception.DhxException - - thrown if error occurs while parsing file

unmarshallAndValidate

@Loggable
public <T> T unmarshallAndValidate(java.io.InputStream capsuleStream,
                                              java.io.InputStream schemaStream)
                                       throws ee.ria.dhx.exception.DhxException

Parses(unmarshalls) object from file. And does validation against XSD schema if schemaStream is present.

Specified by:

unmarshallAndValidate in interface DhxMarshallerService

Type Parameters:

T - - type of the capsule being unmarshalled

Parameters:

capsuleStream - - stream of to parse

schemaStream - - stream on XSD schema against which to validate. No validation is done if stream is NULL

Returns:

- parsed(unmarshalled) object

Throws:

ee.ria.dhx.exception.DhxException - - thrown if error occurs while parsing file

unmarshallAndValidate

@Loggable
public <T> T unmarshallAndValidate(java.io.File capsuleFile,
                                              java.io.InputStream schemaStream)
                                       throws ee.ria.dhx.exception.DhxException

Parses(unmarshalls) object from file. And does validation against XSD schema if schemaStream is present.

Specified by:

unmarshallAndValidate in interface DhxMarshallerService

Type Parameters:

T - - type of the capsule being unmarshalled

Parameters:

capsuleFile - - file to parse

schemaStream - - stream on XSD schema against which to validate. No validation is done if stream is NULL

Returns:

- parsed(unmarshalled) object

Throws:

ee.ria.dhx.exception.DhxException - - thrown if error occurs while parsing file

unmarshallAndValidate

@Loggable
public <T> T unmarshallAndValidate(java.io.InputStream capsuleStream,
                                              java.io.InputStream schemaStream,
                                              java.lang.Class<? extends java.lang.Object> bigDataClass)
                                       throws ee.ria.dhx.exception.DhxException

Parses(unmarshalls) object from file. And does validation against XSD schema if schemaStream is present.

Type Parameters:

T - - type of the capsule being unmarshalled

Parameters:

capsuleStream - - stream of to parse

schemaStream - - stream on XSD schema against which to validate. No validation is done if stream is NULL

bigDataClass - class having big data that is being unmarshalled or null if no big datat is expected

Returns:

- parsed(unmarshalled) object

Throws:

ee.ria.dhx.exception.DhxException - - thrown if error occurs while parsing file

unmarshall

@Loggable
public <T> T unmarshall(java.io.InputStream capsuleStream,
                                   java.lang.Class<? extends java.lang.Object> bigDataClass)
                            throws ee.ria.dhx.exception.DhxException

Parses(unmarshalls) object from file.

Type Parameters:

T - - type of the capsule being unmarshalled

Parameters:

capsuleStream - - stream to parse

bigDataClass - class having big data that is being unmarshalled or null if no big datat is expected

Returns:

- parsed(unmarshalled) object

Throws:

ee.ria.dhx.exception.DhxException - - thrown if error occurs while parsing file

marshall

@Loggable
public java.io.File marshall(java.lang.Object container)
                                 throws ee.ria.dhx.exception.DhxException

Marshalls object to file.

Specified by:

marshall in interface DhxMarshallerService

Parameters:

container - - object to marshall

Returns:

- file containing marshalled object

Throws:

ee.ria.dhx.exception.DhxException - - thrown if error occurs while marshalling object

marshall

@Loggable
public void marshall(java.lang.Object container,
                                java.io.File file)
                         throws ee.ria.dhx.exception.DhxException

Marshalls object to given file.

Specified by:

marshall in interface DhxMarshallerService

Parameters:

container - object to marshall

file - file to marshall to

Throws:

ee.ria.dhx.exception.DhxException - thrown if error occurs while marshalling object

marshallToOutputStream

@Loggable
public void marshallToOutputStream(java.lang.Object container,
                                              java.io.OutputStream stream)
                                       throws ee.ria.dhx.exception.DhxException

Marshalls object to outputStream.

Specified by:

marshallToOutputStream in interface DhxMarshallerService

Parameters:

container - - object to marshall

stream - - containing marshalled object

Throws:

ee.ria.dhx.exception.DhxException - - thrown if error occurs while marshalling object

marshallToOutputStreamNoNamespacePrefixes

@Loggable
public void marshallToOutputStreamNoNamespacePrefixes(java.lang.Object container,
                                                                 java.io.OutputStream stream,
                                                                 java.lang.Boolean includeXmlns)
                                                          throws ee.ria.dhx.exception.DhxException

Marshalls object to outputStream, removes all namespace prefixes from XML.

Specified by:

marshallToOutputStreamNoNamespacePrefixes in interface DhxMarshallerService

Parameters:

container - - object to marshall

stream - - containing marshalled object

includeXmlns - if true, then xmlns will be added

Throws:

ee.ria.dhx.exception.DhxException - - thrown if error occurs while marshalling object

marshallToResult

@Loggable
public void marshallToResult(java.lang.Object obj,
                                        javax.xml.transform.Result result)
                                 throws ee.ria.dhx.exception.DhxException

Marshalls object to result.

Specified by:

marshallToResult in interface DhxMarshallerService

Parameters:

obj - - object to marshall

result - - result into which object will be marshalled

Throws:

ee.ria.dhx.exception.DhxException - - thrown if error occurs while marshalling object

marshallToWriter

@Loggable
public java.io.StringWriter marshallToWriter(java.lang.Object container)
                                                 throws ee.ria.dhx.exception.DhxException

Marshalls object to writer.

Specified by:

marshallToWriter in interface DhxMarshallerService

Parameters:

container - - object to marshall

Returns:

- file containing marshalled object

Throws:

ee.ria.dhx.exception.DhxException - - thrown if error occurs while marshalling object

marshallToWriterAndValidate

public java.io.StringWriter marshallToWriterAndValidate(java.lang.Object container,
                                                        java.io.InputStream schemaStream)
                                                 throws ee.ria.dhx.exception.DhxException

Marshalls object to writer and validates object if schemaStream is present.

Specified by:

marshallToWriterAndValidate in interface DhxMarshallerService

Parameters:

container - object to marshall

schemaStream - InputStream of the XSD schema to validate against

Returns:

- file containing marshalled object

Throws:

ee.ria.dhx.exception.DhxException - thrown if error occurs while marshalling object

validate

@Loggable
public void validate(java.io.File file,
                                java.io.InputStream schemaStream)
                         throws ee.ria.dhx.exception.DhxException

Method validates file against XSD schema.

Specified by:

validate in interface DhxMarshallerService

Parameters:

file - - file to validate

schemaStream - - stream caontaining XSD schema

Throws:

ee.ria.dhx.exception.DhxException - - thrown if error occurs

validate

@Loggable
public void validate(java.io.InputStream fileStream,
                                java.io.InputStream schemaStream)
                         throws ee.ria.dhx.exception.DhxException

Function validates file against XSD schema.

Specified by:

validate in interface DhxMarshallerService

Parameters:

fileStream - - stream to validate

schemaStream - - stream containing schema against which to validate

Throws:

ee.ria.dhx.exception.DhxException - - thrown if file is not validated against XSD schema.

getJaxbContext

public javax.xml.bind.JAXBContext getJaxbContext()

Returns the jaxbContext.

Returns:

the jaxbContext