Package org.apache.jackrabbit.vault.packaging.impl

Class PackageManagerImpl

java.lang.Object

org.apache.jackrabbit.vault.packaging.impl.PackageManagerImpl

All Implemented Interfaces:

PackageManager

Direct Known Subclasses:

JcrPackageManagerImpl

public class PackageManagerImpl
extends Object
implements PackageManager

Implements the package manager

Constructor Summary

Constructors

Constructor	Description
PackageManagerImpl()

Method Summary

Modifier and Type	Method	Description
VaultPackage	assemble(Session s, ExportOptions opts, File file)	Assembles a package using the given meta information and file to store to.
void	assemble(Session s, ExportOptions opts, OutputStream out)	Assembles a package using the given meta information.
@NotNull VaultPackage	open(@NotNull Archive archive)	Opens the given archive and creates a package
@NotNull VaultPackage	open(@NotNull Archive archive, boolean strict)	Opens the given archive and creates a package
VaultPackage	open(File file)	Opens the given file and creates a package
VaultPackage	open(File file, boolean strict)	Opens the given file and creates a package
VaultPackage	rewrap(ExportOptions opts, VaultPackage src, File file)	Re-wraps a package using the given meta information and file to store to.
void	rewrap(ExportOptions opts, VaultPackage src, OutputStream out)	Re-wraps the given package with the definition provided in the export options.
void	setDispatcher(@Nullable PackageEventDispatcher dispatcher)

Methods inherited from class java.lang.Object

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

Constructor Detail

PackageManagerImpl

public PackageManagerImpl()

Method Detail

open

@NotNull
public @NotNull VaultPackage open(@NotNull
                                  @NotNull Archive archive)
                           throws IOException

Opens the given archive and creates a package

Specified by:

open in interface PackageManager

Parameters:

archive - the archive

Returns:

the package

Throws:

IOException - if an error occurs

open

@NotNull
public @NotNull VaultPackage open(@NotNull
                                  @NotNull Archive archive,
                                  boolean strict)
                           throws IOException

Opens the given archive and creates a package

Specified by:

open in interface PackageManager

Parameters:

archive - the archive

strict - if true the import is more strict with regards to errors.

Returns:

the package

Throws:

IOException - if an error occurs

open

public VaultPackage open(File file)
                  throws IOException

Opens the given file and creates a package

Specified by:

open in interface PackageManager

Parameters:

file - the file

Returns:

the package

Throws:

IOException - if an error occurs

open

public VaultPackage open(File file,
                         boolean strict)
                  throws IOException

Opens the given file and creates a package

Specified by:

open in interface PackageManager

Parameters:

file - the file

strict - if true the import is more strict with regards to errors.

Returns:

the package

Throws:

IOException - if an error occurs

assemble

public VaultPackage assemble(Session s,
                             ExportOptions opts,
                             File file)
                      throws IOException,
                             RepositoryException

Assembles a package using the given meta information and file to store to. if file is null a temp file is generated.

Specified by:

assemble in interface PackageManager

Parameters:

s - the repository session

opts - export options

file - the file to write to

Returns:

the newly created vault package

Throws:

IOException - if an I/O error occurs.

RepositoryException - if a repository error during building occurs.

assemble

public void assemble(Session s,
                     ExportOptions opts,
                     OutputStream out)
              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.

Specified by:

assemble in interface PackageManager

Parameters:

s - the repository session

opts - the export options

out - the output stream to write to

Throws:

IOException - if an I/O error occurs.

RepositoryException - if a repository error during building occurs.

rewrap

public VaultPackage rewrap(ExportOptions opts,
                           VaultPackage src,
                           File file)
                    throws IOException,
                           RepositoryException

Re-wraps a package using the given meta information and file to store to.

Specified by:

rewrap in interface PackageManager

Parameters:

opts - export options

src - source package

file - the file to write to (may be null) to create a new temp file

Returns:

the newly created vault package

Throws:

IOException - if an I/O error occurs.

RepositoryException - if a repository error during building occurs.

rewrap

public void rewrap(ExportOptions opts,
                   VaultPackage src,
                   OutputStream out)
            throws IOException

Re-wraps the given package with the definition provided in the export options.

The specified stream is closed after this method returns.

Specified by:

rewrap in interface PackageManager

Parameters:

opts - export options

src - source package

out - destination output stream

Throws:

IOException - if an I/O error occurs

setDispatcher

public void setDispatcher(@Nullable
                          @Nullable PackageEventDispatcher dispatcher)