org.nuxeo.ecm.core.io.impl.plugins

Class NuxeoArchiveReader

java.lang.Object

org.nuxeo.ecm.core.io.impl.AbstractDocumentReader

org.nuxeo.ecm.core.io.impl.plugins.NuxeoArchiveReader

All Implemented Interfaces:

DocumentReader

public class NuxeoArchiveReader
extends AbstractDocumentReader

Reads nuxeo archives generated using NuxeoArchiveWriter.

If you need to read a CoreIO XML Archive that was not directly generated by NuxeoArchiveWriter or that was modified you need to use the NuxeoArchiveReader(File) constructor.

Author:

Bogdan Stefanescu

Constructor Summary

Constructors

Constructor and Description
NuxeoArchiveReader(File file) Create a NuxeoArchiveReader from a File.
NuxeoArchiveReader(InputStream in) Create a NuxeoArchiveReader from an InputStream.
NuxeoArchiveReader(URL url) Create a NuxeoArchiveReader from a url.
NuxeoArchiveReader(ZipInputStream in) Create a NuxeoArchiveReader from an ZipInputStream.

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Closes the reader.
static boolean	isMarkerEntry(ZipEntry entry)
ExportedDocument	read() Reads a single document.

Methods inherited from class org.nuxeo.ecm.core.io.impl.AbstractDocumentReader

read

Methods inherited from class java.lang.Object

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

Constructor Detail

NuxeoArchiveReader

public NuxeoArchiveReader(URL url)
                   throws IOException

Create a NuxeoArchiveReader from a url.

The url must point to an archive that was generated by NuxeoArchiveWriter.

Parameters:

url - url to an archive that was generated by NuxeoArchiveWriter

Throws:

IOException

NuxeoArchiveReader

public NuxeoArchiveReader(File file)
                   throws IOException

Create a NuxeoArchiveReader from a File.

This constructor is different from others because it allows the input zip file to have been generated by an other engine that NuxeoArchiveWriter.

In particular, you can use this constructor on a Zip Archive that was manually modified.

Parameters:

in - InputStream pointing an archive that was generated by NuxeoArchiveWriter

Throws:

IOException

NuxeoArchiveReader

public NuxeoArchiveReader(InputStream in)
                   throws IOException

Create a NuxeoArchiveReader from an InputStream.

The InputStream must point to an archive that was generated by NuxeoArchiveWriter.

Parameters:

in - InputStream pointing an archive that was generated by NuxeoArchiveWriter

Throws:

IOException

NuxeoArchiveReader

public NuxeoArchiveReader(ZipInputStream in)
                   throws IOException

Create a NuxeoArchiveReader from an ZipInputStream.

The ZipInputStream must point to an archive that was generated by NuxeoArchiveWriter.

Parameters:

in - ZipInputStream pointing an archive that was generated by NuxeoArchiveWriter

Throws:

IOException

Method Detail

read

public ExportedDocument read()
                      throws IOException

Description copied from interface: DocumentReader

Reads a single document.

Specified by:

read in interface DocumentReader

Specified by:

read in class AbstractDocumentReader

Returns:

the document read or null if there are no more documents to read

Throws:

IOException

close

public void close()

Description copied from interface: DocumentReader

Closes the reader.

isMarkerEntry

public static boolean isMarkerEntry(ZipEntry entry)