ee.ria.dhx.ws.service

Interface DhxMarshallerService

All Known Implementing Classes:

DhxMarshallerServiceImpl

public interface DhxMarshallerService

Methods related to XSD and marshalling. e.g. marshalling, unmarshalling , validating

Author:

Aleksei Kokarev

Method Summary

Modifier and Type	Method and Description
javax.xml.bind.Marshaller	getMarshaller() Method returns marshaller.
javax.xml.bind.Unmarshaller	getUnmarshaller() Method returns unmarshaller.
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.
<T> T	unmarshall(java.io.File capsuleFile) Parses(unmarshalls) object from file.
<T> T	unmarshall(java.io.InputStream capsuleStream) 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.
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.

Method Detail

unmarshall

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

Method parses(unmarshalls) object.

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

<T> T unmarshall(java.io.File capsuleFile)
          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

Returns:

- parsed(unmarshalled) object

Throws:

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

unmarshall

<T> T unmarshall(java.io.InputStream capsuleStream)
          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

Returns:

- parsed(unmarshalled) object

Throws:

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

unmarshall

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

Parses(unmarshalls) object from Node.

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

<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.

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
<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.

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

marshall

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

Marshalls object to file.

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
void marshall(java.lang.Object container,
                         java.io.File file)
                  throws ee.ria.dhx.exception.DhxException

Marshalls object to given file.

Parameters:

container - object to marshall

file - file to marshall to

Throws:

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

marshallToOutputStream

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

Marshalls object to outputStream.

Parameters:

container - - object to marshall

stream - - containing marshalled object

Throws:

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

marshallToOutputStreamNoNamespacePrefixes

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.

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

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

Marshalls object to result.

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

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

Marshalls object to writer.

Parameters:

container - - object to marshall

Returns:

- file containing marshalled object

Throws:

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

marshallToWriterAndValidate

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

Marshalls object to writer and validates.

Parameters:

container - - object to marshall

schemaStream - - stream 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

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

Method validates file against XSD schema.

Parameters:

file - - file to validate

schemaStream - - stream caontaining XSD schema

Throws:

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

validate

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

Function validates file against XSD schema.

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.

getMarshaller

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

Method returns marshaller.

Returns:

marshaller

Throws:

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

getUnmarshaller

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

Method returns unmarshaller.

Returns:

marshaller

Throws:

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