All Known Subinterfaces:

JcrPackageDefinition, VaultPackage

All Known Implementing Classes:

DefaultPackageProperties, FsPackageProperties, HollowVaultPackage, JcrPackageDefinitionImpl, JcrPackageProperties, PackagePropertiesImpl, ZipVaultPackage
```
@ProviderType
public interface PackageProperties
```
The package properties provide extra/meta information about the package to install. The properties are usually stored in the META-INF/vault/properties.xml or in the jar's manifest.

Since:

3.1

Field Summary

Fields
Modifier and Type	Field	Description
`static String`	`MF_KEY_IMPORT_PACKAGE`	The manifest header key containing all necessary imports for this package
`static String`	`MF_KEY_PACKAGE_DEPENDENCIES`	The manifest header key for the package dependencies.
`static String`	`MF_KEY_PACKAGE_DEPENDENCIES_LOCATIONS`	The manifest header key for locations of package dependencies.
`static String`	`MF_KEY_PACKAGE_DESC`	The manifest header key for the package description.
`static String`	`MF_KEY_PACKAGE_ID`	The manifest header key for the package id in the form `<group>:<name>:<version>`
`static String`	`MF_KEY_PACKAGE_ROOTS`	The manifest header key for all filter roots separated by ','.
`static String`	`MF_KEY_PACKAGE_TYPE`	The manifest header key which indicates the package type
`static String`	`NAME_AC_HANDLING`	Name of the 'acHandling' by meta-inf property.
`static String`	`NAME_ALLOW_INDEX_DEFINITIONS`	Name of the flag that defines if the package is supposed to contains/overwrite Oak index definitions.
`static String`	`NAME_BUILD_COUNT`	Name of the build count meta-inf property
`static String`	`NAME_CND_PATTERN`	Name of the 'cndPattern' by meta-inf property.
`static String`	`NAME_CREATED`	Name of the created meta-inf property
`static String`	`NAME_CREATED_BY`	Name of the created by meta-inf property
`static String`	`NAME_DEPENDENCIES`	Name of the dependencies meta-inf property
`static String`	`NAME_DEPENDENCIES_LOCATIONS`	Name of the meta-inf property for locations of package dependencies.
`static String`	`NAME_DESCRIPTION`	Name of the description meta-inf property
`static String`	`NAME_DISABLE_INTERMEDIATE_SAVE`	Name of the flag that indicates to disable intermediate saves.
`static String`	`NAME_GENERATOR`	Name of the generator by meta-inf property
`static String`	`NAME_GROUP`	Name of the group property
`static String`	`NAME_LAST_MODIFIED`	Name of the last modified meta-inf property
`static String`	`NAME_LAST_MODIFIED_BY`	Name of the last modified by meta-inf property
`static String`	`NAME_LAST_WRAPPED`	Name of the last wrapped meta-inf property
`static String`	`NAME_LAST_WRAPPED_BY`	Name of the last wrapped by meta-inf property
`static String`	`NAME_NAME`	Name of the 'name' property
`static String`	`NAME_PACKAGE_TYPE`	Name of the package-type property
`static String`	`NAME_REQUIRES_RESTART`	Name of the flag that indicates that the system needs a restart after package extraction.
`static String`	`NAME_REQUIRES_ROOT`	Name of the flag that indicates that only admin sessions can extract this package.
`static String`	`NAME_SUB_PACKAGE_HANDLING`	Name of the flag that configures the sub package handling.
`static String`	`NAME_USE_BINARY_REFERENCES`	Name of the flag that configures whether to use binary references instead of actual binary
`static String`	`NAME_VERSION`	Name of the version meta-inf property
`static String`	`PREFIX_INSTALL_HOOK`	The prefix for an install hook property name.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`AccessControlHandling`	`getACHandling()`	Returns the access control handling defined in this package.
`long`	`getBuildCount()`	Returns the build count of this package
`Calendar`	`getCreated()`	Returns the date when this package was built or `null` if n/a.
`String`	`getCreatedBy()`	Returns the user that built this package or null if n/a.
`Calendar`	`getDateProperty(String name)`	Returns the date property with the given name or `null` if it does not exist or if the value cannot be converted to a date.
`Dependency[]`	`getDependencies()`	Returns an unmodifiable list of dependencies
`@NotNull Map<PackageId,URI>`	`getDependenciesLocations()`	Returns a map of dependency locations where key = package id and value = uri of package dependency with that id.
`String`	`getDescription()`	Returns a description of this package or `null` if n/a
`Map<String,String>`	`getExternalHooks()`
`String`	`getGenerator()`	Returns the name and version of the component that generated the package.
`PackageId`	`getId()`	Returns the id of this package or `null` if the id can't be determined.
`Calendar`	`getLastModified()`	Returns the last modification date or `null` if n/a.
`String`	`getLastModifiedBy()`	Returns the user that last modified the package or `null` if n/a.
`Calendar`	`getLastWrapped()`	Returns the date when this package was wrapped or `null` if n/a.
`String`	`getLastWrappedBy()`	Returns the user that wrapped this package or null if n/a.
`@Nullable PackageType`	`getPackageType()`	Returns the package type or `null` if no package type was specified for this package.
`String`	`getProperty(String name)`	Returns the property with the given name or `null` if it does not exist.
`SubPackageHandling`	`getSubPackageHandling()`	Returns the sub package handling configuration
`boolean`	`requiresRestart()`	Returns `true` if this package requires a restart after installation.
`boolean`	`requiresRoot()`	Returns `true` if this package can only be extracted by a admin session.

- Field Detail
  - NAME_LAST_MODIFIED
```
static final String NAME_LAST_MODIFIED
```
    Name of the last modified meta-inf property
    
    See Also:
    
    Constant Field Values
  - NAME_LAST_MODIFIED_BY
```
static final String NAME_LAST_MODIFIED_BY
```
    Name of the last modified by meta-inf property
    
    See Also:
    
    Constant Field Values
  - NAME_GROUP
```
static final String NAME_GROUP
```
    Name of the group property
    
    Since:
    
    2.2
    
    See Also:
    
    Constant Field Values
  - NAME_NAME
```
static final String NAME_NAME
```
    Name of the 'name' property
    
    Since:
    
    2.2
    
    See Also:
    
    Constant Field Values
  - NAME_BUILD_COUNT
```
static final String NAME_BUILD_COUNT
```
    Name of the build count meta-inf property
    
    See Also:
    
    Constant Field Values
  - NAME_VERSION
```
static final String NAME_VERSION
```
    Name of the version meta-inf property
    
    See Also:
    
    Constant Field Values
  - NAME_DEPENDENCIES
```
static final String NAME_DEPENDENCIES
```
    Name of the dependencies meta-inf property
    
    See Also:
    
    Constant Field Values
  - NAME_DEPENDENCIES_LOCATIONS
```
static final String NAME_DEPENDENCIES_LOCATIONS
```
    Name of the meta-inf property for locations of package dependencies. Each location has the format <packageId>=<uri>. Multiple locations are separated by ",".
    
    See Also:
    
    Constant Field Values
  - NAME_CREATED
```
static final String NAME_CREATED
```
    Name of the created meta-inf property
    
    See Also:
    
    Constant Field Values
  - NAME_CREATED_BY
```
static final String NAME_CREATED_BY
```
    Name of the created by meta-inf property
    
    See Also:
    
    Constant Field Values
  - NAME_GENERATOR
```
static final String NAME_GENERATOR
```
    Name of the generator by meta-inf property
    
    See Also:
    
    Constant Field Values
  - NAME_LAST_WRAPPED
```
static final String NAME_LAST_WRAPPED
```
    Name of the last wrapped meta-inf property
    
    Since:
    
    2.2.22
    
    See Also:
    
    Constant Field Values
  - NAME_LAST_WRAPPED_BY
```
static final String NAME_LAST_WRAPPED_BY
```
    Name of the last wrapped by meta-inf property
    
    Since:
    
    2.2.22
    
    See Also:
    
    Constant Field Values
  - NAME_AC_HANDLING
```
static final String NAME_AC_HANDLING
```
    Name of the 'acHandling' by meta-inf property.
    
    See Also:
    
    AccessControlHandling, Constant Field Values
  - NAME_CND_PATTERN
```
static final String NAME_CND_PATTERN
```
    Name of the 'cndPattern' by meta-inf property.
    
    Since:
    
    2.3.12
    
    See Also:
    
    Constant Field Values
  - NAME_DESCRIPTION
```
static final String NAME_DESCRIPTION
```
    Name of the description meta-inf property
    
    See Also:
    
    Constant Field Values
  - NAME_REQUIRES_ROOT
```
static final String NAME_REQUIRES_ROOT
```
    Name of the flag that indicates that only admin sessions can extract this package.
    
    See Also:
    
    Constant Field Values
  - NAME_REQUIRES_RESTART
```
static final String NAME_REQUIRES_RESTART
```
    Name of the flag that indicates that the system needs a restart after package extraction.
    
    See Also:
    
    Constant Field Values
  - NAME_DISABLE_INTERMEDIATE_SAVE
```
static final String NAME_DISABLE_INTERMEDIATE_SAVE
```
    Name of the flag that indicates to disable intermediate saves.
    
    See Also:
    
    Constant Field Values
  - NAME_SUB_PACKAGE_HANDLING
```
static final String NAME_SUB_PACKAGE_HANDLING
```
    Name of the flag that configures the sub package handling.
    
    Since:
    
    3.1
    
    See Also:
    
    Constant Field Values
  - NAME_ALLOW_INDEX_DEFINITIONS
```
static final String NAME_ALLOW_INDEX_DEFINITIONS
```
    Name of the flag that defines if the package is supposed to contains/overwrite Oak index definitions.
    
    Since:
    
    3.2.10
    
    See Also:
    
    Constant Field Values
  - NAME_USE_BINARY_REFERENCES
```
static final String NAME_USE_BINARY_REFERENCES
```
    Name of the flag that configures whether to use binary references instead of actual binary
    
    See Also:
    
    Constant Field Values
  - NAME_PACKAGE_TYPE
```
static final String NAME_PACKAGE_TYPE
```
    Name of the package-type property
    
    See Also:
    
    Constant Field Values
  - PREFIX_INSTALL_HOOK
```
static final String PREFIX_INSTALL_HOOK
```
    The prefix for an install hook property name. The full name may look like this: installhook.test1.class.
    
    See Also:
    
    Constant Field Values
  - MF_KEY_PACKAGE_TYPE
```
static final String MF_KEY_PACKAGE_TYPE
```
    The manifest header key which indicates the package type
    
    See Also:
    
    NAME_PACKAGE_TYPE, Constant Field Values
  - MF_KEY_PACKAGE_ID
```
static final String MF_KEY_PACKAGE_ID
```
    The manifest header key for the package id in the form <group>:<name>:<version>
    
    See Also:
    
    NAME_GROUP, NAME_NAME, NAME_VERSION, Constant Field Values
  - MF_KEY_PACKAGE_DEPENDENCIES
```
static final String MF_KEY_PACKAGE_DEPENDENCIES
```
    The manifest header key for the package dependencies.
    
    See Also:
    
    NAME_DEPENDENCIES, Constant Field Values
  - MF_KEY_PACKAGE_DEPENDENCIES_LOCATIONS
```
static final String MF_KEY_PACKAGE_DEPENDENCIES_LOCATIONS
```
    The manifest header key for locations of package dependencies. Each location has the format <packageId>=<uri>. Multiple locations are separated by ",".
    
    See Also:
    
    NAME_DEPENDENCIES_LOCATIONS, Constant Field Values
  - MF_KEY_PACKAGE_ROOTS
```
static final String MF_KEY_PACKAGE_ROOTS
```
    The manifest header key for all filter roots separated by ','.
    
    See Also:
    
    WorkspaceFilter, Constant Field Values
  - MF_KEY_PACKAGE_DESC
```
static final String MF_KEY_PACKAGE_DESC
```
    The manifest header key for the package description.
    
    See Also:
    
    NAME_DESCRIPTION, Constant Field Values
  - MF_KEY_IMPORT_PACKAGE
```
static final String MF_KEY_IMPORT_PACKAGE
```
    The manifest header key containing all necessary imports for this package
    
    See Also:
    
    Constant Field Values
- Method Detail
  - getId
```
PackageId getId()
```
    Returns the id of this package or null if the id can't be determined.
    
    Returns:
    
    the id of this package.
  - getLastModified
```
Calendar getLastModified()
```
    Returns the last modification date or null if n/a.
    
    Returns:
    
    last modification date or null
  - getLastModifiedBy
```
String getLastModifiedBy()
```
    Returns the user that last modified the package or null if n/a.
    
    Returns:
    
    the user or null
  - getCreated
```
Calendar getCreated()
```
    Returns the date when this package was built or null if n/a.
    
    Returns:
    
    the creation date
  - getCreatedBy
```
String getCreatedBy()
```
    Returns the user that built this package or null if n/a.
    
    Returns:
    
    the creator
  - getGenerator
```
String getGenerator()
```
    Returns the name and version of the component that generated the package.
    
    Returns:
    
    the generator or null if n/a
    
    Since:
    
    3.7.0
  - getLastWrapped
```
Calendar getLastWrapped()
```
    Returns the date when this package was wrapped or null if n/a.
    
    Returns:
    
    the wrapped date
    
    Since:
    
    2.2.22
  - getLastWrappedBy
```
String getLastWrappedBy()
```
    Returns the user that wrapped this package or null if n/a.
    
    Returns:
    
    the wrapper
    
    Since:
    
    2.2.22
  - getDescription
```
String getDescription()
```
    Returns a description of this package or null if n/a
    
    Returns:
    
    a description
  - requiresRoot
```
boolean requiresRoot()
```
    Returns true if this package can only be extracted by a admin session.
    
    Returns:
    
    true if this package requires an admin session for extraction.
  - requiresRestart
```
boolean requiresRestart()
```
    Returns true if this package requires a restart after installation.
    
    Returns:
    
    true if this package requires a restart after installation.
  - getDependencies
```
Dependency[] getDependencies()
```
    Returns an unmodifiable list of dependencies
    
    Returns:
    
    list of dependencies
  - getExternalHooks
```
Map<String,String> getExternalHooks()
```
    Returns:
    
    all external hooks registered in a package (key = name, value = fully qualified class name)
  - getACHandling
```
AccessControlHandling getACHandling()
```
    Returns the access control handling defined in this package.
    
    Returns:
    
    the access control handling.
  - getSubPackageHandling
```
SubPackageHandling getSubPackageHandling()
```
    Returns the sub package handling configuration
    
    Returns:
    
    the sub package handling configuration.
  - getDateProperty
```
Calendar getDateProperty(String name)
```
    Returns the date property with the given name or null if it does not exist or if the value cannot be converted to a date.
    
    Parameters:
    
    name - the property name
    
    Returns:
    
    the property value or null
  - getProperty
```
String getProperty(String name)
```
    Returns the property with the given name or null if it does not exist.
    
    Parameters:
    
    name - the property name
    
    Returns:
    
    the property value or null
  - getPackageType
```
@Nullable
@Nullable PackageType getPackageType()
```
    Returns the package type or null if no package type was specified for this package.
    
    Returns:
    
    the package type
  - getDependenciesLocations
```
@NotNull
@NotNull Map<PackageId,URI> getDependenciesLocations()
```
    Returns a map of dependency locations where key = package id and value = uri of package dependency with that id.
    
    Returns:
    
    dependencies locations as map
  - getBuildCount
```
long getBuildCount()
```
    Returns the build count of this package
    
    Returns:
    
    the build count.

Interface PackageProperties

Field Summary

Method Summary

Field Detail

NAME_LAST_MODIFIED

NAME_LAST_MODIFIED_BY

NAME_GROUP

NAME_NAME

NAME_BUILD_COUNT

NAME_VERSION

NAME_DEPENDENCIES

NAME_DEPENDENCIES_LOCATIONS

NAME_CREATED

NAME_CREATED_BY

NAME_GENERATOR

NAME_LAST_WRAPPED

NAME_LAST_WRAPPED_BY

NAME_AC_HANDLING

NAME_CND_PATTERN

NAME_DESCRIPTION

NAME_REQUIRES_ROOT

NAME_REQUIRES_RESTART

NAME_DISABLE_INTERMEDIATE_SAVE

NAME_SUB_PACKAGE_HANDLING

NAME_ALLOW_INDEX_DEFINITIONS

NAME_USE_BINARY_REFERENCES

NAME_PACKAGE_TYPE

PREFIX_INSTALL_HOOK

MF_KEY_PACKAGE_TYPE

MF_KEY_PACKAGE_ID

MF_KEY_PACKAGE_DEPENDENCIES

MF_KEY_PACKAGE_DEPENDENCIES_LOCATIONS

MF_KEY_PACKAGE_ROOTS

MF_KEY_PACKAGE_DESC

MF_KEY_IMPORT_PACKAGE

Method Detail

getId

getLastModified

getLastModifiedBy

getCreated

getCreatedBy

getGenerator

getLastWrapped

getLastWrappedBy

getDescription

requiresRoot

requiresRestart

getDependencies

getExternalHooks

getACHandling

getSubPackageHandling

getDateProperty

getProperty

getPackageType

getDependenciesLocations

getBuildCount