com.day.jcr.vault.packaging

Interface JcrPackage

All Superinterfaces:

java.lang.Comparable<JcrPackage>

Deprecated.

since 2.5.0. Use the org.apache.jackrabbit.vault API instead.

@Deprecated
public interface JcrPackage
extends java.lang.Comparable<JcrPackage>

Specifies the interface of a vault package stored in the repository.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	MIME_TYPE Deprecated. default mime type of a package
static java.lang.String	NN_VLT_DEFINITION Deprecated. Nodename of the definition node
static java.lang.String	NT_VLT_PACKAGE Deprecated. Nodetype name of a package node
static java.lang.String	NT_VLT_PACKAGE_DEFINITION Deprecated. Nodetype name of a definition node

Method Summary

Modifier and Type	Method and Description
void	close() Deprecated. Closes this package and destroys all temporary data.
void	extract(ImportOptions opts) Deprecated. since 2.3.14 use extract(com.day.jcr.vault.fs.io.ImportOptions) instead.
void	extract(ImportOptions opts) Deprecated. Extracts the package contents to the repository
Property	getData() Deprecated. Returns the jcr:data property of the package
JcrPackageDefinition	getDefinition() Deprecated. Returns the package definition of this package
Node	getDefNode() Deprecated. Returns the definition node or null if not exists
Node	getNode() Deprecated. Returns the underlying node
VaultPackage	getPackage() Deprecated. Returns the vault package stored in the data of this package
long	getSize() Deprecated. Returns the size of the underlying package.
JcrPackage	getSnapshot() Deprecated. Returns the snapshot that was taken when installing this package.
void	install(ImportOptions opts) Deprecated. since 2.3.14, use install(com.day.jcr.vault.fs.io.ImportOptions) instead
void	install(ImportOptions opts) Deprecated. Installs the package contents to the repository but creates a snapshot if necessary.
boolean	isInstalled() Deprecated. Checks if this package is installed.
boolean	isSealed() Deprecated. Checks if this package is sealed.
boolean	isValid() Deprecated. Checks if the underlying node contains the correct structure.
JcrPackage	snapshot(ExportOptions opts, boolean replace) Deprecated. Creates a snapshot of this package.
void	uninstall(ImportOptions opts) Deprecated. since 2.3.14, use uninstall(com.day.jcr.vault.fs.io.ImportOptions) instead.
void	uninstall(ImportOptions opts) Deprecated. Reverts the changes of a prior installation of this package.
boolean	verifyId(boolean autoFix, boolean autoSave) Deprecated. Checks if the package id is correct in respect to the installation path and adjusts it accordingly.

Methods inherited from interface java.lang.Comparable

compareTo

Field Detail

NT_VLT_PACKAGE

static final java.lang.String NT_VLT_PACKAGE

Deprecated.

Nodetype name of a package node

See Also:

Constant Field Values

NT_VLT_PACKAGE_DEFINITION

static final java.lang.String NT_VLT_PACKAGE_DEFINITION

Deprecated.

Nodetype name of a definition node

See Also:

Constant Field Values

NN_VLT_DEFINITION

static final java.lang.String NN_VLT_DEFINITION

Deprecated.

Nodename of the definition node

See Also:

Constant Field Values

MIME_TYPE

static final java.lang.String MIME_TYPE

Deprecated.

default mime type of a package

See Also:

Constant Field Values

Method Detail

getDefinition

JcrPackageDefinition getDefinition()
                            throws RepositoryException

Deprecated.

Returns the package definition of this package

Returns:

the package definition or null if this package is not valid.

Throws:

RepositoryException - if an error occurrs

isValid

boolean isValid()

Deprecated.

Checks if the underlying node contains the correct structure.

Returns:

true if this package is valid.

getNode

Node getNode()

Deprecated.

Returns the underlying node

Returns:

the node

isSealed

boolean isSealed()

Deprecated.

Checks if this package is sealed. this is the case, if it was not modified since it was unwrapped.

Returns:

true if this package is sealed.

getPackage

VaultPackage getPackage()
                 throws RepositoryException,
                        java.io.IOException

Deprecated.

Returns the vault package stored in the data of this package

Returns:

the package

Throws:

RepositoryException - if an error occurs

java.io.IOException - if an I/O error occurs

extract

void extract(ImportOptions opts)
      throws RepositoryException,
             PackageException,
             java.io.IOException

Deprecated. since 2.3.14 use extract(com.day.jcr.vault.fs.io.ImportOptions) instead.

Extracts the package contents to the repository

Parameters:

opts - import options

Throws:

RepositoryException - if a repository error during installation occurs.

PackageException - if an error during packaging occurs

java.lang.IllegalStateException - if the package is not valid.

java.io.IOException - if an I/O error occurs

extract

void extract(ImportOptions opts)
      throws RepositoryException,
             PackageException,
             java.io.IOException

Deprecated.

Extracts the package contents to the repository

Parameters:

opts - import options

Throws:

RepositoryException - if a repository error during installation occurs.

PackageException - if an error during packaging occurs

java.lang.IllegalStateException - if the package is not valid.

java.io.IOException - if an I/O error occurs

Since:

2.3.14

install

void install(ImportOptions opts)
      throws RepositoryException,
             PackageException,
             java.io.IOException

Deprecated. since 2.3.14, use install(com.day.jcr.vault.fs.io.ImportOptions) instead

Installs the package contents to the repository but creates a snapshot if necessary.

Parameters:

opts - import options

Throws:

RepositoryException - if a repository error during installation occurs.

PackageException - if an error during packaging occurs

java.lang.IllegalStateException - if the package is not valid.

java.io.IOException - if an I/O error occurs

Since:

2.0

install

void install(ImportOptions opts)
      throws RepositoryException,
             PackageException,
             java.io.IOException

Deprecated.

Installs the package contents to the repository but creates a snapshot if necessary.

Parameters:

opts - import options

Throws:

RepositoryException - if a repository error during installation occurs.

PackageException - if an error during packaging occurs

java.lang.IllegalStateException - if the package is not valid.

java.io.IOException - if an I/O error occurs

Since:

2.3.14

snapshot

JcrPackage snapshot(ExportOptions opts,
                    boolean replace)
             throws RepositoryException,
                    PackageException,
                    java.io.IOException

Deprecated.

Creates a snapshot of this package.

Parameters:

opts - export options

replace - if true any existing snapshot is replaced.

Returns:

a package that represents the snapshot of this package.

Throws:

RepositoryException - if a repository error during installation occurs.

PackageException - if an error during packaging occurs

java.lang.IllegalStateException - if the package is not valid.

java.io.IOException - if an I/O error occurs

Since:

2.0

getSnapshot

JcrPackage getSnapshot()
                throws RepositoryException

Deprecated.

Returns the snapshot that was taken when installing this package.

Returns:

the snapshot package or null

Throws:

RepositoryException - if an error occurs.

Since:

2.0

uninstall

void uninstall(ImportOptions opts)
        throws RepositoryException,
               PackageException,
               java.io.IOException

Deprecated. since 2.3.14, use uninstall(com.day.jcr.vault.fs.io.ImportOptions) instead.

Reverts the changes of a prior installation of this package.

Parameters:

opts - import options

Throws:

RepositoryException - if a repository error during installation occurs.

PackageException - if an error during packaging occurs or if no snapshot is available.

java.lang.IllegalStateException - if the package is not valid.

java.io.IOException - if an I/O error occurs

Since:

2.0

uninstall

void uninstall(ImportOptions opts)
        throws RepositoryException,
               PackageException,
               java.io.IOException

Deprecated.

Reverts the changes of a prior installation of this package.

Parameters:

opts - import options

Throws:

RepositoryException - if a repository error during installation occurs.

PackageException - if an error during packaging occurs or if no snapshot is available.

java.lang.IllegalStateException - if the package is not valid.

java.io.IOException - if an I/O error occurs

Since:

2.3.14

verifyId

boolean verifyId(boolean autoFix,
                 boolean autoSave)
          throws RepositoryException

Deprecated.

Checks if the package id is correct in respect to the installation path and adjusts it accordingly.

Parameters:

autoFix - true to automatically fix the id

autoSave - true to save changes immediately

Returns:

true if id is correct.

Throws:

RepositoryException - if an error occurs.

Since:

2.2.18

isInstalled

boolean isInstalled()
             throws RepositoryException

Deprecated.

Checks if this package is installed. Note: the default implementation only checks the JcrPackageDefinition.getLastUnpacked() date. If the package is replaced since it was installed. this method will return false.

Returns:

true if this package is installed.

Throws:

RepositoryException - if an error occurs.

Since:

2.4.6

getSize

long getSize()

Deprecated.

Returns the size of the underlying package.

Returns:

the size in bytes or -1 if not valid.

close

void close()

Deprecated.

Closes this package and destroys all temporary data.

getData

Property getData()
          throws RepositoryException

Deprecated.

Returns the jcr:data property of the package

Returns:

the jcr:data property

Throws:

RepositoryException - if an error occurrs

getDefNode

Node getDefNode()
         throws RepositoryException

Deprecated.

Returns the definition node or null if not exists

Returns:

the definition node.

Throws:

RepositoryException - if an error occurrs