|
Nuxeo Enterprise Platform 5.4 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IOManager
Service handling complex import/export of documents and associated resources.
Field Summary | |
---|---|
static java.lang.String |
DOCUMENTS_ADAPTER_NAME
|
Method Summary | |
---|---|
void |
addAdapter(java.lang.String name,
IOResourceAdapter adapter)
Adds an adapter with given name and definition. |
java.util.Collection<DocumentRef> |
copyDocumentsAndResources(java.lang.String repo,
java.util.Collection<DocumentRef> sources,
DocumentLocation targetLocation,
java.util.Collection<java.lang.String> ioAdapters)
Copy documents and resources to another location (on a same machine). |
void |
copyDocumentsAndResources(java.lang.String repo,
java.util.Collection<DocumentRef> sources,
IOManager remoteIOManager,
DocumentLocation targetLocation,
java.util.Collection<java.lang.String> ioAdapters)
Remote copy. |
void |
copyDocumentsAndResources(java.lang.String repo,
java.util.Collection<DocumentRef> sources,
java.lang.String serverAddress,
int jndiPort,
DocumentLocation targetLocation,
java.util.Collection<java.lang.String> ioAdapters)
Remote copy. |
void |
copyDocumentsAndResources(java.lang.String repo,
java.util.Collection<DocumentRef> sources,
java.lang.String serverAddress,
int jndiPort,
DocumentLocation targetLocation,
java.lang.String docReaderFactoryClassName,
java.util.Map<java.lang.String,java.lang.Object> rFactoryParams,
java.lang.String docWriterFactoryClassName,
java.util.Map<java.lang.String,java.lang.Object> wFactoryParams,
java.util.Collection<java.lang.String> ioAdapters)
Copies documents and resources associated with the given sources from the local repository to a remote repository instance (available on a machine with the given serverAddress). |
void |
disposeExport(java.lang.String uri)
Should be called by client code after using the export created by calling the externalizeExport(java.lang.String, java.util.Collection . |
void |
exportDocumentsAndResources(java.io.OutputStream out,
java.lang.String repo,
java.util.Collection<DocumentRef> sources,
boolean recurse,
java.lang.String format,
java.util.Collection<java.lang.String> ioAdapters)
Export documents and resources. |
java.lang.String |
externalizeExport(java.lang.String repo,
java.util.Collection<DocumentRef> sources,
java.util.Collection<java.lang.String> ioAdapters)
Exports the documents and resources specified by sources and creates an external reachable URI (through stream service) from where a client could download the export. |
java.lang.String |
externalizeExport(java.lang.String repo,
java.util.Collection<DocumentRef> sources,
java.lang.String docReaderFactoryName,
java.util.Map<java.lang.String,java.lang.Object> readerFactoryParams,
java.util.Collection<java.lang.String> ioAdapters)
Exports documents as an streamable archive - using all options |
java.lang.String |
externalizeExport(java.lang.String repo,
java.lang.String docReaderFactoryName,
java.util.Map<java.lang.String,java.lang.Object> readerFactoryParams,
java.util.Collection<java.lang.String> ioAdapters)
Exports the documents and resources using custom DocumentReader that will be created by specified readerFactoryName. |
IOResourceAdapter |
getAdapter(java.lang.String name)
Returns the adapter with given name. |
void |
importDocumentsAndResources(java.io.InputStream in,
java.lang.String repo,
DocumentRef root)
Import document and resources described by given input stream at given document location. |
void |
importExportedFile(java.lang.String uri,
DocumentLocation targetLocation)
Will be called after a successful export to import data from the file. |
void |
importExportedFile(java.lang.String uri,
DocumentLocation targetLocation,
java.lang.String docWriterFactoryClassName,
java.util.Map<java.lang.String,java.lang.Object> wFactoryParams)
Will be called after a successful export to import data from the file. |
void |
importFromStreamSource(java.lang.String uri,
DocumentLocation targetLocation,
java.lang.String docReaderFactoryClassName,
java.util.Map<java.lang.String,java.lang.Object> rFactoryParams,
java.lang.String docWriterFactoryClassName,
java.util.Map<java.lang.String,java.lang.Object> wFactoryParams)
|
void |
removeAdapter(java.lang.String name)
Removes adapter with given name. |
Field Detail |
---|
static final java.lang.String DOCUMENTS_ADAPTER_NAME
Method Detail |
---|
IOResourceAdapter getAdapter(java.lang.String name) throws ClientException
ClientException
void addAdapter(java.lang.String name, IOResourceAdapter adapter) throws ClientException
ClientException
void removeAdapter(java.lang.String name) throws ClientException
ClientException
void importDocumentsAndResources(java.io.InputStream in, java.lang.String repo, DocumentRef root) throws java.io.IOException, ClientException, ImportDocumentException
in
- stream representing the documents and resources to import. Can
be a zip file of a group of export files. The service is
responsible for unzipping and redirecting import to specific
import services.repo
- the repository name.root
- Optional location of document that must be taken as root of
the import (can be null).
java.io.IOException
ClientException
ImportDocumentException
- TODOvoid exportDocumentsAndResources(java.io.OutputStream out, java.lang.String repo, java.util.Collection<DocumentRef> sources, boolean recurse, java.lang.String format, java.util.Collection<java.lang.String> ioAdapters) throws java.io.IOException, ClientException, ExportDocumentException
out
- stream that can be turned into a zip holding a group of file for
each additional resources types.repo
- TODOsources
- locations of documents to export.recurse
- recurse into sources childrenformat
- export format. XXX see what format is actually accepted.ioAdapters
- list of adapters to use for additional resources.
java.io.IOException
ClientException
ExportDocumentException
- TODOjava.util.Collection<DocumentRef> copyDocumentsAndResources(java.lang.String repo, java.util.Collection<DocumentRef> sources, DocumentLocation targetLocation, java.util.Collection<java.lang.String> ioAdapters) throws ClientException
repo
- the initial repository name.sources
- locations of documents to export.targetLocation
- location of the document where copies must be
placed.ioAdapters
- list of adapters to use for additional resources.
ClientException
void copyDocumentsAndResources(java.lang.String repo, java.util.Collection<DocumentRef> sources, java.lang.String serverAddress, int jndiPort, DocumentLocation targetLocation, java.util.Collection<java.lang.String> ioAdapters) throws ClientException
ClientException
void copyDocumentsAndResources(java.lang.String repo, java.util.Collection<DocumentRef> sources, IOManager remoteIOManager, DocumentLocation targetLocation, java.util.Collection<java.lang.String> ioAdapters) throws ClientException
ClientException
void copyDocumentsAndResources(java.lang.String repo, java.util.Collection<DocumentRef> sources, java.lang.String serverAddress, int jndiPort, DocumentLocation targetLocation, java.lang.String docReaderFactoryClassName, java.util.Map<java.lang.String,java.lang.Object> rFactoryParams, java.lang.String docWriterFactoryClassName, java.util.Map<java.lang.String,java.lang.Object> wFactoryParams, java.util.Collection<java.lang.String> ioAdapters) throws ClientException
Also if there are custom DocumentReader and DocumentWriter classes that should be used when externalizing documents and/or when re-creating them at the remote location, they could be created through specific factory classes (specified as class names). These factory classes are instantiated and provided with the given factoryParams in order to build custom DocumentReader or DocumentWriter objects.
repo
- sources
- serverAddress
- jndiPort
- targetLocation
- docReaderFactoryClassName
- classname for a DocumentReaderFactory custom implementationrFactoryParams
- params to be given to custom DocumentReaderFactory to create DocumentReaderdocWriterFactoryClassName
- classname for a DocumentWriterFactory custom implementationwFactoryParams
- params to be given to custom DocumentWriterFactory to create DocumentWriterioAdapters
-
ClientException
java.lang.String externalizeExport(java.lang.String repo, java.util.Collection<DocumentRef> sources, java.util.Collection<java.lang.String> ioAdapters) throws ClientException
repo
- sources
- ioAdapters
-
ClientException
java.lang.String externalizeExport(java.lang.String repo, java.lang.String docReaderFactoryName, java.util.Map<java.lang.String,java.lang.Object> readerFactoryParams, java.util.Collection<java.lang.String> ioAdapters) throws ClientException
repo
- docReaderFactoryName
- readerFactoryParams
- ioAdapters
-
ClientException
java.lang.String externalizeExport(java.lang.String repo, java.util.Collection<DocumentRef> sources, java.lang.String docReaderFactoryName, java.util.Map<java.lang.String,java.lang.Object> readerFactoryParams, java.util.Collection<java.lang.String> ioAdapters) throws ClientException
repo
- sources
- docReaderFactoryName
- readerFactoryParams
- ioAdapters
-
ClientException
void disposeExport(java.lang.String uri) throws ClientException
externalizeExport(java.lang.String, java.util.Collection, java.util.Collection)
.
uri
-
ClientException
void importExportedFile(java.lang.String uri, DocumentLocation targetLocation) throws ClientException
uri
- targetLocation
-
ClientException
void importExportedFile(java.lang.String uri, DocumentLocation targetLocation, java.lang.String docWriterFactoryClassName, java.util.Map<java.lang.String,java.lang.Object> wFactoryParams) throws ClientException
uri
- targetLocation
- docWriterFactoryClassName
- wFactoryParams
-
ClientException
void importFromStreamSource(java.lang.String uri, DocumentLocation targetLocation, java.lang.String docReaderFactoryClassName, java.util.Map<java.lang.String,java.lang.Object> rFactoryParams, java.lang.String docWriterFactoryClassName, java.util.Map<java.lang.String,java.lang.Object> wFactoryParams) throws ClientException
ClientException
|
Nuxeo Enterprise Platform 5.4 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |