org.nuxeo.ecm.platform.ui.web.restAPI

Class ExportRepresentation

java.lang.Object

org.restlet.resource.Variant

org.restlet.resource.Representation

org.restlet.resource.StreamRepresentation

org.restlet.resource.OutputRepresentation

org.nuxeo.ecm.platform.ui.web.restAPI.ExportRepresentation

public abstract class ExportRepresentation
extends org.restlet.resource.OutputRepresentation

Facelet resource representation that calls a DocumentPipe using the facelet's output stream for the document writer's output.

This abstract method must be subclassed to implement makePipe(), makeDocumentReader(org.nuxeo.ecm.core.api.CoreSession, org.nuxeo.ecm.core.api.DocumentModel) and makeDocumentWriter(java.io.OutputStream).

Author:

Florent Guillaume

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	isUnrestricted
protected String	repositoryName
protected String	rootId

Fields inherited from class org.restlet.resource.Variant

UNKNOWN_SIZE

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ExportRepresentation(org.restlet.data.MediaType mediaType, DocumentModel root)
protected	ExportRepresentation(org.restlet.data.MediaType mediaType, DocumentModel root, boolean unrestricted)

Method Summary

Modifier and Type	Method and Description
protected abstract DocumentReader	makeDocumentReader(CoreSession documentManager, DocumentModel root) Create a DocumentReader for the export.
protected abstract DocumentWriter	makeDocumentWriter(OutputStream outputStream) Create a DocumentWriter for the export.
protected abstract DocumentPipe	makePipe() Create a DocumentPipe adequate for the number of documents needed by the export.
void	write(OutputStream outputStream)

Methods inherited from class org.restlet.resource.OutputRepresentation

getStream

Methods inherited from class org.restlet.resource.StreamRepresentation

getChannel, write

Methods inherited from class org.restlet.resource.Representation

getText, isAvailable, isTransient, setAvailable, setTransient

Methods inherited from class org.restlet.resource.Variant

getCharacterSet, getEncodings, getExpirationDate, getIdentifier, getLanguages, getMediaType, getModificationDate, getSize, getTag, setCharacterSet, setExpirationDate, setIdentifier, setIdentifier, setMediaType, setModificationDate, setSize, setTag

Methods inherited from class java.lang.Object

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

Field Detail

repositoryName

protected final String repositoryName

rootId

protected final String rootId

isUnrestricted

protected final boolean isUnrestricted

Constructor Detail

ExportRepresentation

protected ExportRepresentation(org.restlet.data.MediaType mediaType,
                               DocumentModel root)

ExportRepresentation

protected ExportRepresentation(org.restlet.data.MediaType mediaType,
                               DocumentModel root,
                               boolean unrestricted)

Method Detail

makePipe

protected abstract DocumentPipe makePipe()

Create a DocumentPipe adequate for the number of documents needed by the export.

Returns:

the document pipe.

makeDocumentReader

protected abstract DocumentReader makeDocumentReader(CoreSession documentManager,
                                                     DocumentModel root)

Create a DocumentReader for the export.

Parameters:

documentManager - a session

root - the root of the export

Returns:

the document reader

makeDocumentWriter

protected abstract DocumentWriter makeDocumentWriter(OutputStream outputStream)
                                              throws IOException

Create a DocumentWriter for the export.

Parameters:

outputStream - the stream to use

Returns:

the document writer

Throws:

IOException

write

public void write(OutputStream outputStream)
           throws IOException

Specified by:

write in class org.restlet.resource.OutputRepresentation

Throws:

IOException