com.day.jcr.vault.packaging

Interface JcrPackageDefinition

Deprecated.

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

@Deprecated
public interface JcrPackageDefinition

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

Field Summary

Fields

Modifier and Type	Field and Description
static String	NN_FILTER Deprecated. Node name of the filter node
static String	PN_AC_HANDLING Deprecated. Property name of the access control handling mode
static String	PN_BUILD_COUNT Deprecated. Property name of the build count
static String	PN_CND_PATTERN Deprecated. Property name of the cnd pattern filter
static String	PN_CREATED Deprecated. Property name of the creation date
static String	PN_CREATED_BY Deprecated. Property name of the creation user id
static String	PN_DEPENDENCIES Deprecated. Property name of the package dependencies
static String	PN_DESCRIPTION Deprecated. Property name of the package description
static String	PN_DISABLE_INTERMEDIATE_SAVE Deprecated. Property name of the disable intermediate save flag
static String	PN_GROUP Deprecated. Property name of the 'group'
static String	PN_LAST_UNPACKED Deprecated. Property name of the last unpacked date
static String	PN_LAST_UNPACKED_BY Deprecated. Property name of the last unpacked user id
static String	PN_LAST_UNWRAPPED Deprecated. Property name of the last unwrapped date
static String	PN_LAST_UNWRAPPED_BY Deprecated. Property name of the last unwrapped user id
static String	PN_LAST_WRAPPED Deprecated. Property name of the last wrapped date
static String	PN_LAST_WRAPPED_BY Deprecated. Property name of the last wrapped user id
static String	PN_LASTMODIFIED Deprecated. Property name of the last modification date
static String	PN_LASTMODIFIED_BY Deprecated. Property name of the last modification user id
static String	PN_MODE Deprecated. Property name of the filter root
static String	PN_NAME Deprecated. Property name of the 'name'
static String	PN_PATH Deprecated. since 2.2. use 'name' and 'group' instead
static String	PN_PATTERN Deprecated. Property name of the rule pattern
static String	PN_REQUIRES_RESTART Deprecated. Property name of the "require restart" flag
static String	PN_REQUIRES_ROOT Deprecated. Property name of the "requires root" flag
static String	PN_ROOT Deprecated. Property name of the filter root
static String	PN_RULES Deprecated. Property name of the filter rules
static String	PN_SUB_PACKAGES Deprecated. Property name of the sub packages (only used in snapshots)
static String	PN_TYPE Deprecated. Property name of the rule type
static String	PN_VERSION Deprecated. Property name of the package version

Method Summary

Modifier and Type	Method and Description
void	dumpCoverage(ProgressTrackerListener listener) Deprecated. Dumps the coverage of this definition to the given listener
String	get(String name) Deprecated. Generic method to retrieve a string property of this definition.
AccessControlHandling	getAccessControlHandling() Deprecated. Returns the access control handling defined in the definition, or null if not defined.
boolean	getBoolean(String name) Deprecated. Generic method to retrieve a boolean property of this definition.
long	getBuildCount() Deprecated. Returns the build count of this package
Calendar	getCalendar(String name) Deprecated. Generic method to retrieve a date property of this definition.
Calendar	getCreated() Deprecated. Returns the created date
String	getCreatedBy() Deprecated. Returns the creator user id
Dependency[]	getDependencies() Deprecated. Returns the dependencies stored in this definition
String	getDescription() Deprecated. Returns the description of this package
PackageId	getId() Deprecated. Returns the package id
Calendar	getLastModified() Deprecated. Returns the last modified date
String	getLastModifiedBy() Deprecated. Returns the last modified user id
Calendar	getLastUnpacked() Deprecated. Returns the date when the package was unpacked
String	getLastUnpackedBy() Deprecated. Returns the user id who unpacked the package
Calendar	getLastUnwrapped() Deprecated. Returns the last unwrapped date
String	getLastUnwrappedBy() Deprecated. Returns the last unwrapped user id
Calendar	getLastWrapped() Deprecated. Returns the last wrapped date
String	getLastWrappedBy() Deprecated. Returns the wrapper user id
MetaInf	getMetaInf() Deprecated. Returns the meta inf of this package
Node	getNode() Deprecated. Returns the underlying node
boolean	isModified() Deprecated. Checks if the definition was modified since it was last wrapped.
boolean	isUnwrapped() Deprecated. Checks if this definition is unwrapped, i.e.
boolean	requiresRestart() Deprecated. Returns true if this package needs restart after installation.
boolean	requiresRoot() Deprecated.
void	set(String name, boolean value, boolean autoSave) Deprecated. Generic method to set a boolean property to this definition.
void	set(String name, Calendar value, boolean autoSave) Deprecated. Generic method to set a date property to this definition.
void	set(String name, String value, boolean autoSave) Deprecated. Generic method to set a string property to this definition.
void	setFilter(WorkspaceFilter filter, boolean autoSave) Deprecated. Sets the filter to this definition and stores it in a node representation.
void	setId(PackageId id, boolean autoSave) Deprecated. Writes the properties derived from the package id to the content
void	touch(Calendar now, boolean autoSave) Deprecated. Touches the last modified and last modified by property.
void	unwrap(VaultPackage pack, boolean force) Deprecated. use unwrap(VaultPackage, boolean, boolean) instead.
void	unwrap(VaultPackage pack, boolean force, boolean autoSave) Deprecated. Unwrapps the package definition to the underlying node.

Field Detail

PN_LAST_UNPACKED

static final String PN_LAST_UNPACKED

Deprecated.

Property name of the last unpacked date

See Also:

Constant Field Values

PN_LAST_UNPACKED_BY

static final String PN_LAST_UNPACKED_BY

Deprecated.

Property name of the last unpacked user id

See Also:

Constant Field Values

PN_CREATED

static final String PN_CREATED

Deprecated.

Property name of the creation date

See Also:

Constant Field Values

PN_CREATED_BY

static final String PN_CREATED_BY

Deprecated.

Property name of the creation user id

See Also:

Constant Field Values

PN_LASTMODIFIED

static final String PN_LASTMODIFIED

Deprecated.

Property name of the last modification date

See Also:

Constant Field Values

PN_LASTMODIFIED_BY

static final String PN_LASTMODIFIED_BY

Deprecated.

Property name of the last modification user id

See Also:

Constant Field Values

PN_LAST_WRAPPED

static final String PN_LAST_WRAPPED

Deprecated.

Property name of the last wrapped date

Since:

2.2.22

See Also:

Constant Field Values

PN_LAST_WRAPPED_BY

static final String PN_LAST_WRAPPED_BY

Deprecated.

Property name of the last wrapped user id

Since:

2.2.22

See Also:

Constant Field Values

PN_DESCRIPTION

static final String PN_DESCRIPTION

Deprecated.

Property name of the package description

See Also:

Constant Field Values

PN_VERSION

static final String PN_VERSION

Deprecated.

Property name of the package version

See Also:

Constant Field Values

PN_BUILD_COUNT

static final String PN_BUILD_COUNT

Deprecated.

Property name of the build count

See Also:

Constant Field Values

PN_PATH

@Deprecated
static final String PN_PATH

Deprecated. since 2.2. use 'name' and 'group' instead

Property name of the installation path

See Also:

Constant Field Values

PN_NAME

static final String PN_NAME

Deprecated.

Property name of the 'name'

Since:

2.2

See Also:

Constant Field Values

PN_GROUP

static final String PN_GROUP

Deprecated.

Property name of the 'group'

Since:

2.2

See Also:

Constant Field Values

PN_REQUIRES_ROOT

static final String PN_REQUIRES_ROOT

Deprecated.

Property name of the "requires root" flag

See Also:

Constant Field Values

PN_REQUIRES_RESTART

static final String PN_REQUIRES_RESTART

Deprecated.

Property name of the "require restart" flag

See Also:

Constant Field Values

PN_DEPENDENCIES

static final String PN_DEPENDENCIES

Deprecated.

Property name of the package dependencies

See Also:

Constant Field Values

PN_SUB_PACKAGES

static final String PN_SUB_PACKAGES

Deprecated.

Property name of the sub packages (only used in snapshots)

See Also:

Constant Field Values

PN_LAST_UNWRAPPED

static final String PN_LAST_UNWRAPPED

Deprecated.

Property name of the last unwrapped date

See Also:

Constant Field Values

PN_LAST_UNWRAPPED_BY

static final String PN_LAST_UNWRAPPED_BY

Deprecated.

Property name of the last unwrapped user id

See Also:

Constant Field Values

PN_AC_HANDLING

static final String PN_AC_HANDLING

Deprecated.

Property name of the access control handling mode

See Also:

Constant Field Values

PN_CND_PATTERN

static final String PN_CND_PATTERN

Deprecated.

Property name of the cnd pattern filter

See Also:

Constant Field Values

NN_FILTER

static final String NN_FILTER

Deprecated.

Node name of the filter node

See Also:

Constant Field Values

PN_ROOT

static final String PN_ROOT

Deprecated.

Property name of the filter root

See Also:

Constant Field Values

PN_MODE

static final String PN_MODE

Deprecated.

Property name of the filter root

See Also:

Constant Field Values

PN_RULES

static final String PN_RULES

Deprecated.

Property name of the filter rules

See Also:

Constant Field Values

PN_TYPE

static final String PN_TYPE

Deprecated.

Property name of the rule type

See Also:

Constant Field Values

PN_PATTERN

static final String PN_PATTERN

Deprecated.

Property name of the rule pattern

See Also:

Constant Field Values

PN_DISABLE_INTERMEDIATE_SAVE

static final String PN_DISABLE_INTERMEDIATE_SAVE

Deprecated.

Property name of the disable intermediate save flag

See Also:

Constant Field Values

Method Detail

getNode

Node getNode()

Deprecated.

Returns the underlying node

Returns:

the node

getId

PackageId getId()

Deprecated.

Returns the package id

Returns:

the package id

setId

void setId(PackageId id,
           boolean autoSave)

Deprecated.

Writes the properties derived from the package id to the content

Parameters:

id - the package id

autoSave - if true the changes are saved automatically.

Since:

2.2

isUnwrapped

boolean isUnwrapped()

Deprecated.

Checks if this definition is unwrapped, i.e. if the definition structured was extracted from a VaultPackage.

Returns:

true if unwrapped.

isModified

boolean isModified()

Deprecated.

Checks if the definition was modified since it was last wrapped. new packages are considered modified.

Returns:

true if modified

unwrap

@Deprecated
void unwrap(VaultPackage pack,
                        boolean force)
                 throws RepositoryException,
                        IOException

Deprecated. use unwrap(VaultPackage, boolean, boolean) instead.

Unwrapps the package definition to the underlying node.

Parameters:

pack - the package

force - if true unwrapping is forced

Throws:

RepositoryException - if an error occurs

IOException - if an I/O error occurs

unwrap

void unwrap(VaultPackage pack,
            boolean force,
            boolean autoSave)
     throws RepositoryException,
            IOException

Deprecated.

Unwrapps the package definition to the underlying node.

Parameters:

pack - the package

force - if true unwrapping is forced

autoSave - if true modifications are saved automatically

Throws:

RepositoryException - if an error occurs

IOException - if an I/O error occurs

dumpCoverage

void dumpCoverage(ProgressTrackerListener listener)
           throws RepositoryException

Deprecated.

Dumps the coverage of this definition to the given listener

Parameters:

listener - the listener

Throws:

RepositoryException - if an error occurrs

getDependencies

Dependency[] getDependencies()

Deprecated.

Returns the dependencies stored in this definition

Returns:

the dependencies

get

String get(String name)

Deprecated.

Generic method to retrieve a string property of this definition.

Parameters:

name - the name of the property.

Returns:

the property value or null if it does not exist.

getBoolean

boolean getBoolean(String name)

Deprecated.

Generic method to retrieve a boolean property of this definition.

Parameters:

name - the name of the property.

Returns:

the property value or null if it does not exist.

getCalendar

Calendar getCalendar(String name)

Deprecated.

Generic method to retrieve a date property of this definition.

Parameters:

name - the name of the property.

Returns:

the property value or null if it does not exist.

set

void set(String name,
         String value,
         boolean autoSave)

Deprecated.

Generic method to set a string property to this definition.

Parameters:

name - the name of the property

value - the value or null to clear the property

autoSave - if true the modifications are saved automatically.

set

void set(String name,
         Calendar value,
         boolean autoSave)

Deprecated.

Generic method to set a date property to this definition.

Parameters:

name - the name of the property

value - the value or null to clear the property

autoSave - if true the modifications are saved automatically.

set

void set(String name,
         boolean value,
         boolean autoSave)

Deprecated.

Generic method to set a boolean property to this definition.

Parameters:

name - the name of the property

value - the value

autoSave - if true the modifications are saved automatically.

touch

void touch(Calendar now,
           boolean autoSave)

Deprecated.

Touches the last modified and last modified by property.

Parameters:

now - calendar or null

autoSave - if true the modifications are saved automatically.

setFilter

void setFilter(WorkspaceFilter filter,
               boolean autoSave)

Deprecated.

Sets the filter to this definition and stores it in a node representation.

Parameters:

filter - the filter to set

autoSave - if true the modifications are saved automatically.

getLastModified

Calendar getLastModified()

Deprecated.

Returns the last modified date

Returns:

the last modified date

getLastModifiedBy

String getLastModifiedBy()

Deprecated.

Returns the last modified user id

Returns:

the last modified user id

getCreated

Calendar getCreated()

Deprecated.

Returns the created date

Returns:

the created date

getCreatedBy

String getCreatedBy()

Deprecated.

Returns the creator user id

Returns:

the creator

getLastWrapped

Calendar getLastWrapped()

Deprecated.

Returns the last wrapped date

Returns:

the last wrapped date

Since:

2.2.22

getLastWrappedBy

String getLastWrappedBy()

Deprecated.

Returns the wrapper user id

Returns:

the wrapper

Since:

2.2.22

getLastUnwrapped

Calendar getLastUnwrapped()

Deprecated.

Returns the last unwrapped date

Returns:

the last unwrapped date

getLastUnwrappedBy

String getLastUnwrappedBy()

Deprecated.

Returns the last unwrapped user id

Returns:

the last unwrapped user id

getLastUnpacked

Calendar getLastUnpacked()

Deprecated.

Returns the date when the package was unpacked

Returns:

the unpacked date

getLastUnpackedBy

String getLastUnpackedBy()

Deprecated.

Returns the user id who unpacked the package

Returns:

the unpacked user id

requiresRoot

@Deprecated
boolean requiresRoot()

Deprecated.

Returns true if this package needs a admin user to install it.

Returns:

the "requires root" flag

requiresRestart

boolean requiresRestart()

Deprecated.

Returns true if this package needs restart after installation.

Returns:

the "requires restart" flag.

getAccessControlHandling

AccessControlHandling getAccessControlHandling()

Deprecated.

Returns the access control handling defined in the definition, or null if not defined.

Returns:

the access control handling or null

Since:

2.3.2

getDescription

String getDescription()

Deprecated.

Returns the description of this package

Returns:

the description

getBuildCount

long getBuildCount()

Deprecated.

Returns the build count of this package

Returns:

the build count.

getMetaInf

MetaInf getMetaInf()
            throws RepositoryException

Deprecated.

Returns the meta inf of this package

Returns:

the meta inf

Throws:

RepositoryException - if an error occurs.