com.day.jcr.vault.packaging.PackageManager Maven / Gradle / Ivy

Go to download
/*************************************************************************
 *
 * ADOBE CONFIDENTIAL
 * __________________
 *
 *  Copyright 2011 Adobe Systems Incorporated
 *  All Rights Reserved.
 *
 * NOTICE:  All information contained herein is, and remains
 * the property of Adobe Systems Incorporated and its suppliers,
 * if any.  The intellectual and technical concepts contained
 * herein are proprietary to Adobe Systems Incorporated and its
 * suppliers and are protected by trade secret or copyright law.
 * Dissemination of this information or reproduction of this material
 * is strictly forbidden unless prior written permission is obtained
 * from Adobe Systems Incorporated.
 *
 **************************************************************************/

package com.day.jcr.vault.packaging;

import java.io.File;
import java.io.IOException;
import java.io.OutputStream;

import javax.jcr.RepositoryException;
import javax.jcr.Session;

/**
 * The package manager is used to deal with packages. the following operations
 * are defined:
 *
 * 
 * open
 * read underlying data and validate them
 *
 * close
 * release underlying data. the package is unusable afterwards
 *
 * upload
 * import the package from a binary source to the system. for example
 * create a new jcr node structure or create a file.
 * 
 *
 * export
 * export the package in binary format.
 * 
 *
 * unwrap
 * extract the meta information of the binary data and store it in the
 * repository
 *
 * assemble
 * create a vault export of the repository using the package definition
 * and filter.
 *
 * extract
 * extract the packaged content to the repository.
 *
 * install
 * install the packaged content to the repository but create a snapshot if needed.
 *
 * snapshot
 * assemble snapshot information that can be used for a later uninstall. this
 * is done by assembling the content using the same filter definition.
 *
 * uninstall
 * revert changes to the repository of a previous installation.
 *
 * 
 *
 * @deprecated since 2.5.0. Use the org.apache.jackrabbit.vault API instead.
 */
@Deprecated
public interface PackageManager {

    /**
     * Opens the given file and creates a package
     * @param file the file
     * @return the package
     * @throws IOException if an error occurrs
     */
    VaultPackage open(File file) throws IOException;

    /**
     * Opens the given file and creates a package
     * @param file the file
     * @param strict if true the import is more strict in respect to errors.
     * @return the package
     * @throws IOException if an error occurrs
     */
    VaultPackage open(File file, boolean strict) throws IOException;

    /**
     * Assembles a package using the given meta information and file to
     * store to. if file is null a temp file is generated.
     *
     * @param s the repository session
     * @param opts export options
     * @param file the file to write to
     * @return the newly created vault package
     *
     * @throws IOException if an I/O error occurs.
     * @throws RepositoryException if a repository error during building occurs.
     * @throws IllegalStateException if the package is not new.
     */
    VaultPackage assemble(Session s, ExportOptions opts, File file)
            throws IOException, RepositoryException;

    /**
     * Assembles a package using the given meta information. The package
     * is directly streamed to the given output stream.
     *
     * @param s the repository session
     * @param opts the export options
     * @param out the output stream to write to
     * @throws IOException if an I/O error occurs.
     * @throws RepositoryException if a repository error during building occurs.
     * @throws IllegalStateException if the package is not new.
     */
    void assemble(Session s, ExportOptions opts, OutputStream out)
            throws IOException, RepositoryException;

    /**
     * Re-wraps a package using the given meta information and file to
     * store to. if file is null a temp file is generated.
     *
     * @param opts export options
     * @param src source package
     * @param file the file to write to
     * @return the newly created vault package
     *
     * @throws IOException if an I/O error occurs.
     * @throws RepositoryException if a repository error during building occurs.
     * @throws IllegalStateException if the package is not new.
     */
    VaultPackage rewrap(ExportOptions opts, VaultPackage src, File file)
            throws IOException, RepositoryException;

    /**
     * Re-wraps the given package with the definition provided in the export
     * options.
     * @param opts export options
     * @param src source package
     * @param out destination output stream
     * @throws IOException if an I/O error occurs
     */
    void rewrap(ExportOptions opts, VaultPackage src, OutputStream out)
            throws IOException;
}