com.day.durbo

Class DurboOutput

java.lang.Object

com.day.durbo.DurboOutput

All Implemented Interfaces:

DurboConstants

public class DurboOutput
extends java.lang.Object
implements DurboConstants

The DurboOutput class provides base implementation for the Durbo serialization. The Durbo is hierarchical name-value pair serialization that is optimized for stream based operation. the basic principal is, that every data element is stored using RLE encoding, i.e. consists of the size of the data, followed by the data itself. on the logical level, those elements can be properties or nodes. the properties consist of zero, one or more values, which are either strings or binaries. the properties itself also hold a high-level property type, namely the PropertyTypes from jsr170. the additional (invisible) element 'namespace' is used to sequentially define namespaces that will be used in the subsequent elements.

since version 2.1 the deflater of the output stream is reset about every 2^12 bytes (1mb). this generates a output stream that consists of several compressed chunks. this means that a possible reader must be prepared for resetting it's inflater as well. see ChunkedDeflaterOutputStream and ChunkedInflaterInputStream for details. this has only an advantage during deserialization when large binary properties are kept in DurboValues and needed to be read from the consumer.

Version 2.0 introduced:

• JCR property type support
• namespace support
• zip compression

Version 2.1 introduced:

• chunked zip compression

durbo:= header {elem}; header:= hdrVersion hdrContentType hdrEncoding; hdrVersion := svProp; // with name <a href="../../../com/day/durbo/DurboConstants.html#PROTOCOL_HEADER"><code>DurboConstants.PROTOCOL_HEADER</code></a> hdrContentType := svProp; // with name <a href="../../../com/day/durbo/DurboConstants.html#PROTOCOL_CONTENT_TYPE"><code>DurboConstants.PROTOCOL_CONTENT_TYPE</code></a> hdrEncoding := svProp; // with name <a href="../../../com/day/durbo/DurboConstants.html#PROTOCOL_ENCODING"><code>DurboConstants.PROTOCOL_ENCODING</code></a> <p/> elem:= node | prop | namespace; node:= NODE_START name elemlist NODE_END; prop:= svProp | mvProp; svProp:= PROPERTY|type name value; mvProp:= PROPERTY|MULTIPLE|type name <# values> {value}; namespace:= NAMESPACE prefix uri; prefix:= sValue; uri := sValue; name:= sValue; value:= sValue | bValue; <p/> sValue:= <size of string.getBytes()> <string.getBytes()>; bValue:= <size of data> {byte}; <p/> NODE_START:= <a href="../../../com/day/durbo/DurboConstants.html#NODE_START"><code>DurboConstants.NODE_START</code></a>; NODE_END:= <a href="../../../com/day/durbo/DurboConstants.html#NODE_END"><code>DurboConstants.NODE_END</code></a>; PROPERTY:= <a href="../../../com/day/durbo/DurboConstants.html#PROPERTY"><code>DurboConstants.PROPERTY</code></a>; MULTIPLE:= <a href="../../../com/day/durbo/DurboConstants.html#MULTIPLE"><code>DurboConstants.MULTIPLE</code></a>; NAMESPACE:= <a href="../../../com/day/durbo/DurboConstants.html#NAMESPACE"><code>DurboConstants.NAMESPACE</code></a>; <p/>

Field Summary

Fields inherited from interface com.day.durbo.DurboConstants

DEFAULT_CONTENT_TYPE, MULTIPLE, NAMESPACE, NODE_END, NODE_START, PROPERTY, PROPERTY_TYPE_MASK, PROTOCOL_CONTENT_TYPE, PROTOCOL_ENCODING, PROTOCOL_HEADER, PROTOCOL_VERSION, PROTOCOL_VERSION_1, PROTOCOL_VERSION_2, PROTOCOL_VERSION_2_1

Constructor Summary

Constructors

Constructor and Description
DurboOutput(java.io.OutputStream out) Creates a new DurboOutput that uses the given output stream.
DurboOutput(java.io.OutputStream out, double version) Creates a new DurboOutput that uses the given output stream.
DurboOutput(java.io.OutputStream out, DurboNamespaceResolver resolver) Creates a new DurboOutput that uses the given output stream.
DurboOutput(java.io.OutputStream out, DurboNamespaceResolver resolver, double version) Creates a new DurboOutput that uses the given output stream.
DurboOutput(java.io.OutputStream out, DurboNamespaceResolver resolver, java.lang.String contentType, boolean compressed) Creates a new DurboOutput that uses the given output stream.
DurboOutput(java.io.OutputStream out, DurboNamespaceResolver resolver, java.lang.String contentType, boolean compressed, double version) Creates a new DurboOutput that uses the given output stream.

Method Summary

Modifier and Type	Method and Description
void	close() closes the output.
void	closeNode() Writes an closing node marker to the output.
void	defineNamespace(java.lang.String prefix, java.lang.String uri) writes a namespace definition to the stream.
void	openNode(java.lang.String name) Writes an open node marker to the output with the given node name.
void	writeProperty(Property prop) Writes a JCR property to the output
void	writeProperty(java.lang.String name, byte[] data) Writes a binary property with the given name and data to the output.
void	writeProperty(java.lang.String name, java.io.InputStream in) Write a binary property with the given name and data provided in the input stream to to the output.
void	writeProperty(java.lang.String name, java.io.InputStream in, int size) Write a property with the given name and data provided in the input stream to to the output.
void	writeProperty(java.lang.String name, int type, java.lang.String value) Writes a typed single value property.
void	writeProperty(java.lang.String name, int type, java.lang.String[] values) Writes a typed multivalue property.
void	writeProperty(java.lang.String name, java.lang.String data) Writes a string property with the given name and data to the output.

Methods inherited from class java.lang.Object

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

Constructor Detail

DurboOutput

public DurboOutput(java.io.OutputStream out)
            throws java.io.IOException

Creates a new DurboOutput that uses the given output stream. this also writes the protocol header.

please note that the protocol version is set to DurboConstants.PROTOCOL_VERSION_1 which is probably what you want.

please note that this uses the IdentityNamespaceResolver and can therefor generate weird results upon deserialization.

Parameters:

out - the output stream

Throws:

java.io.IOException - if an error occurs

DurboOutput

public DurboOutput(java.io.OutputStream out,
                   double version)
            throws java.io.IOException

Creates a new DurboOutput that uses the given output stream. this also writes the protocol header.

please note that this uses the IdentityNamespaceResolver and can therefor generate weird results upon deserialization.

Parameters:

out - the output stream

version - the protocol version to use. default is DurboConstants.PROTOCOL_VERSION

Throws:

java.io.IOException - if an error occurs

DurboOutput

public DurboOutput(java.io.OutputStream out,
                   DurboNamespaceResolver resolver)
            throws java.io.IOException

Creates a new DurboOutput that uses the given output stream. this also writes the protocol header.

Parameters:

out - the output stream

resolver - the namespace resolver

Throws:

java.io.IOException - if an error occurs

DurboOutput

public DurboOutput(java.io.OutputStream out,
                   DurboNamespaceResolver resolver,
                   double version)
            throws java.io.IOException

Creates a new DurboOutput that uses the given output stream. this also writes the protocol header.

Parameters:

out - the output stream

resolver - the namespace resolver

version - the protocol version to use. default is DurboConstants.PROTOCOL_VERSION

Throws:

java.io.IOException - if an error occurs

DurboOutput

public DurboOutput(java.io.OutputStream out,
                   DurboNamespaceResolver resolver,
                   java.lang.String contentType,
                   boolean compressed)
            throws java.io.IOException

Creates a new DurboOutput that uses the given output stream. this also writes the protocol header.

Parameters:

out - the output stream

resolver - the namespace resolver

contentType - the content type to include in the header. default is DurboConstants.DEFAULT_CONTENT_TYPE

compressed - if true output stream will be compressed.

Throws:

java.io.IOException - if an error occurs

DurboOutput

public DurboOutput(java.io.OutputStream out,
                   DurboNamespaceResolver resolver,
                   java.lang.String contentType,
                   boolean compressed,
                   double version)
            throws java.io.IOException

Creates a new DurboOutput that uses the given output stream. this also writes the protocol header.

Parameters:

out - the output stream

resolver - the namespace resolver

contentType - the content type to include in the header. default is DurboConstants.DEFAULT_CONTENT_TYPE

compressed - if true output stream will be compressed.

version - the protocol version to use. default is DurboConstants.PROTOCOL_VERSION

Throws:

java.io.IOException - if an error occurs

Method Detail

close

public void close()
           throws java.io.IOException

closes the output.

Throws:

java.io.IOException - if an I/O error occurs

defineNamespace

public void defineNamespace(java.lang.String prefix,
                            java.lang.String uri)
                     throws java.io.IOException

writes a namespace definition to the stream.

Parameters:

prefix - the namespace prefix

uri - the namespace uri

Throws:

java.io.IOException - if an I/O exception occurs

writeProperty

public void writeProperty(java.lang.String name,
                          byte[] data)
                   throws java.io.IOException

Writes a binary property with the given name and data to the output.

Parameters:

name - the name of the property

data - the data to write to the stream

Throws:

java.io.IOException - if an error occurs

writeProperty

public void writeProperty(java.lang.String name,
                          java.lang.String data)
                   throws java.io.IOException

Writes a string property with the given name and data to the output.

Parameters:

name - the name of the property

data - the data to write to the stream

Throws:

java.io.IOException - if an error occurs

writeProperty

public void writeProperty(Property prop)
                   throws java.io.IOException,
                          RepositoryException

Writes a JCR property to the output

Parameters:

prop - the property to write

Throws:

java.io.IOException - if an I/O error occurs

RepositoryException - if an error occurs

writeProperty

public void writeProperty(java.lang.String name,
                          int type,
                          java.lang.String[] values)
                   throws java.io.IOException

Writes a typed multivalue property.

Parameters:

name - name of the property

type - type of the property

values - values of the property

Throws:

java.io.IOException - if an I/O error occurs

writeProperty

public void writeProperty(java.lang.String name,
                          int type,
                          java.lang.String value)
                   throws java.io.IOException

Writes a typed single value property.

Parameters:

name - name of the property

type - type of the property

value - value of the property

Throws:

java.io.IOException - if an I/O error occurs

writeProperty

public void writeProperty(java.lang.String name,
                          java.io.InputStream in)
                   throws java.io.IOException

Write a binary property with the given name and data provided in the input stream to to the output.

Parameters:

name - the name of the property

in - the data to write to the stream

Throws:

java.io.IOException - if an error occurs

writeProperty

public void writeProperty(java.lang.String name,
                          java.io.InputStream in,
                          int size)
                   throws java.io.IOException

Write a property with the given name and data provided in the input stream to to the output.

Parameters:

name - the name of the property

in - the data to write to the stream

size - The number of bytes to write from the InputStream. If this value is negative, as much is read from the input stream as possible.

Throws:

java.io.IOException - if an error occurs

openNode

public void openNode(java.lang.String name)
              throws java.io.IOException

Writes an open node marker to the output with the given node name.

Parameters:

name - the name of the node

Throws:

java.io.IOException - if an error occurs

closeNode

public void closeNode()
               throws java.io.IOException

Writes an closing node marker to the output.

Throws:

java.io.IOException - if an error occurs