org.apache.jackrabbit.vault.packaging.PackageManager Maven / Gradle / Ivy
Show all versions of aem-sdk-api Show documentation
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You 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.
*/
package org.apache.jackrabbit.vault.packaging;
import java.io.File;
import java.io.IOException;
import java.io.OutputStream;
import javax.jcr.RepositoryException;
import javax.jcr.Session;
import org.apache.jackrabbit.vault.fs.io.Archive;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
import org.osgi.annotation.versioning.ProviderType;
/**
* 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.
*
*
*/
@ProviderType
public interface PackageManager {
/**
* Opens the given archive and creates a package
* @param archive the archive
* @return the package
* @throws IOException if an error occurs
*/
@NotNull
VaultPackage open(@NotNull Archive archive) throws IOException;
/**
* Opens the given archive and creates a package
* @param archive the archive
* @param strict if {@code true} the import is more strict with regards to errors.
* @return the package
* @throws IOException if an error occurs
*/
@NotNull
VaultPackage open(@NotNull Archive archive, boolean strict) throws IOException;
/**
* Opens the given file and creates a package
* @param file the file
* @return the package
* @throws IOException if an error occurs
*
* @deprecated File handling is not supported anymore.
*/
@NotNull
@Deprecated()
VaultPackage open(@NotNull File file) throws IOException;
/**
* Opens the given file and creates a package
* @param file the file
* @param strict if {@code true} the import is more strict with regards to errors.
* @return the package
* @throws IOException if an error occurs
*
* @deprecated File handling is not supported anymore.
*/
@NotNull
@Deprecated()
VaultPackage open(@NotNull File file, boolean strict) throws IOException;
/**
* Assembles a package using the given meta information and file to
* store to. if file is {@code 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.
*
* @deprecated File handling is not supported anymore.
*/
@NotNull
@Deprecated()
VaultPackage assemble(@NotNull Session s, @NotNull ExportOptions opts, @Nullable File file) throws IOException, RepositoryException;
/**
* Assembles a package using the given meta information. The package
* is directly streamed to the given output stream.
* The specified stream is closed after this method returns.
* @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(@NotNull Session s, @NotNull ExportOptions opts, @NotNull OutputStream out) throws IOException, RepositoryException;
/**
* Re-wraps a package using the given meta information and file to
* store to.
*
* @param opts export options
* @param src source package
* @param file the file to write to (may be {@code null}) to create a new temp file
* @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.
*
* @deprecated File handling is not supported anymore.
*/
@NotNull
@Deprecated()
VaultPackage rewrap(@NotNull ExportOptions opts, @NotNull VaultPackage src, @Nullable File file) throws IOException, RepositoryException;
/**
* Re-wraps the given package with the definition provided in the export
* options.
*
The specified stream is closed after this method returns.
* @param opts export options
* @param src source package
* @param out destination output stream
* @throws IOException if an I/O error occurs
*/
void rewrap(@NotNull ExportOptions opts, @NotNull VaultPackage src, @NotNull OutputStream out) throws IOException;
}