IOManager.java

/*
 * (C) Copyright 2006-2007 Nuxeo SA (http://nuxeo.com/) and others.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 * Contributors:
 *     <a href="mailto:at@nuxeo.com">Anahide Tchertchian</a>
 *
 * $Id: IOManager.java 30145 2008-02-13 16:56:56Z dmihalache $
 */

package org.nuxeo.ecm.platform.io.api;

import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
import java.io.Serializable;
import java.util.Collection;
import java.util.Map;

import org.nuxeo.ecm.core.api.DocumentLocation;
import org.nuxeo.ecm.core.api.DocumentRef;

/**
 * Service handling complex import/export of documents and associated resources.
 *
 * @author <a href="mailto:at@nuxeo.com">Anahide Tchertchian</a>
 */
public interface IOManager extends Serializable {

    String DOCUMENTS_ADAPTER_NAME = "documents";

    /**
     * Returns the adapter with given name.
     */
    IOResourceAdapter getAdapter(String name);

    /**
     * Adds an adapter with given name and definition.
     */
    void addAdapter(String name, IOResourceAdapter adapter);

    /**
     * Removes adapter with given name.
     */
    void removeAdapter(String name);

    /**
     * Import document and resources described by given input stream at given document location.
     *
     * @param 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.
     * @param repo the repository name.
     * @param root Optional location of document that must be taken as root of the import (can be null).
     */
    void importDocumentsAndResources(InputStream in, String repo, DocumentRef root) throws IOException;

    /**
     * Export documents and resources.
     *
     * @param out stream that can be turned into a zip holding a group of file for each additional resources types.
     * @param repo TODO
     * @param sources locations of documents to export.
     * @param recurse recurse into sources children
     * @param format export format. XXX see what format is actually accepted.
     * @param ioAdapters list of adapters to use for additional resources.
     */
    void exportDocumentsAndResources(OutputStream out, String repo, Collection<DocumentRef> sources, boolean recurse,
            String format, Collection<String> ioAdapters) throws IOException;

    /**
     * Copy documents and resources to another location (on a same machine).
     *
     * @param repo the initial repository name.
     * @param sources locations of documents to export.
     * @param targetLocation location of the document where copies must be placed.
     * @param ioAdapters list of adapters to use for additional resources.
     * @return the list of copied documents references.
     */
    Collection<DocumentRef> copyDocumentsAndResources(String repo, Collection<DocumentRef> sources,
            DocumentLocation targetLocation, Collection<String> ioAdapters);

    void importFromStream(InputStream in, DocumentLocation targetLocation, String docReaderFactoryClassName,
            Map<String, Object> rFactoryParams, String docWriterFactoryClassName, Map<String, Object> wFactoryParams);

}