All Known Subinterfaces:

VaultPackage
```
@ProviderType
public interface PackageProperties
```
The package properties provide extra/meta information about the package to install. The properties are usually store 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 java.lang.String`	`NAME_AC_HANDLING`	Name of the 'acHandling' by meta-inf property.
`static java.lang.String`	`NAME_ALLOW_INDEX_DEFINITIONS`	Name of the flag that defines if the package is supposed to contains/overwrite Oak index definitions.
`static java.lang.String`	`NAME_BUILD_COUNT`	Name of the build count meta-inf property
`static java.lang.String`	`NAME_CND_PATTERN`	Name of the 'cndPattern' by meta-inf property.
`static java.lang.String`	`NAME_CREATED`	Name of the created meta-inf property
`static java.lang.String`	`NAME_CREATED_BY`	Name of the created by meta-inf property
`static java.lang.String`	`NAME_DEPENDENCIES`	Name of the dependencies meta-inf property
`static java.lang.String`	`NAME_DESCRIPTION`	Name of the description meta-inf property
`static java.lang.String`	`NAME_DISABLE_INTERMEDIATE_SAVE`	Name of the flag that indicates to disable intermediate saves.
`static java.lang.String`	`NAME_GROUP`	Name of the group property
`static java.lang.String`	`NAME_LAST_MODIFIED`	Name of the last modified meta-inf property
`static java.lang.String`	`NAME_LAST_MODIFIED_BY`	Name of the last modified by meta-inf property
`static java.lang.String`	`NAME_LAST_WRAPPED`	Name of the last wrapped meta-inf property
`static java.lang.String`	`NAME_LAST_WRAPPED_BY`	Name of the last wrapped by meta-inf property
`static java.lang.String`	`NAME_NAME`	Name of the 'name' property
`static java.lang.String`	`NAME_PACKAGE_TYPE`	Name of the package-type property
`static java.lang.String`	`NAME_REQUIRES_RESTART`	Name of the flag that indicates that the system needs a restart after package extraction.
`static java.lang.String`	`NAME_REQUIRES_ROOT`	Name of the flag that indicates in only admin sessions can extract this package.
`static java.lang.String`	`NAME_SUB_PACKAGE_HANDLING`	Name of the flag that configures the sub package handling.
`static java.lang.String`	`NAME_USE_BINARY_REFERENCES`	Name of the flag that configures whether to use binary references instead of actual binary
`static java.lang.String`	`NAME_VERSION`	Name of the version meta-inf property
`static java.lang.String`	`PREFIX_INSTALL_HOOK`	the prefix for an install hook property.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`AccessControlHandling`	`getACHandling()`	Returns the access control handling defined in this package.
`java.util.Calendar`	`getCreated()`	Returns the date when this package was built or `null` if n/a.
`java.lang.String`	`getCreatedBy()`	Returns the user that built this package or null if n/a.
`java.util.Calendar`	`getDateProperty(java.lang.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
`java.lang.String`	`getDescription()`	Returns a description of this package or `null` if n/a
`PackageId`	`getId()`	Returns the id of this package or `null` if the id can't be determined.
`java.util.Calendar`	`getLastModified()`	Returns the last modification date or `null` if n/a.
`java.lang.String`	`getLastModifiedBy()`	Returns the user that last modified the package or `null` if n/a.
`java.util.Calendar`	`getLastWrapped()`	Returns the date when this package was wrapped or `null` if n/a.
`java.lang.String`	`getLastWrappedBy()`	Returns the user that wrapped this package or null if n/a.
`PackageType`	`getPackageType()`	Returns the package type or `null` if not package type was specified for this package.
`java.lang.String`	`getProperty(java.lang.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`	`requiresRoot()`	Returns `true` if this package can only be extracted by a admin session.

- Field Detail
  - NAME_LAST_MODIFIED
```
static final java.lang.String NAME_LAST_MODIFIED
```
    Name of the last modified meta-inf property
    
    See Also:
    
    Constant Field Values
  - NAME_LAST_MODIFIED_BY
```
static final java.lang.String NAME_LAST_MODIFIED_BY
```
    Name of the last modified by meta-inf property
    
    See Also:
    
    Constant Field Values
  - NAME_GROUP
```
static final java.lang.String NAME_GROUP
```
    Name of the group property
    
    Since:
    
    2.2
    
    See Also:
    
    Constant Field Values
  - NAME_NAME
```
static final java.lang.String NAME_NAME
```
    Name of the 'name' property
    
    Since:
    
    2.2
    
    See Also:
    
    Constant Field Values
  - NAME_BUILD_COUNT
```
static final java.lang.String NAME_BUILD_COUNT
```
    Name of the build count meta-inf property
    
    See Also:
    
    Constant Field Values
  - NAME_VERSION
```
static final java.lang.String NAME_VERSION
```
    Name of the version meta-inf property
    
    See Also:
    
    Constant Field Values
  - NAME_DEPENDENCIES
```
static final java.lang.String NAME_DEPENDENCIES
```
    Name of the dependencies meta-inf property
    
    See Also:
    
    Constant Field Values
  - NAME_CREATED
```
static final java.lang.String NAME_CREATED
```
    Name of the created meta-inf property
    
    See Also:
    
    Constant Field Values
  - NAME_CREATED_BY
```
static final java.lang.String NAME_CREATED_BY
```
    Name of the created by meta-inf property
    
    See Also:
    
    Constant Field Values
  - NAME_LAST_WRAPPED
```
static final java.lang.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 java.lang.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 java.lang.String NAME_AC_HANDLING
```
    Name of the 'acHandling' by meta-inf property.
    
    See Also:
    
    AccessControlHandling, Constant Field Values
  - NAME_CND_PATTERN
```
static final java.lang.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 java.lang.String NAME_DESCRIPTION
```
    Name of the description meta-inf property
    
    See Also:
    
    Constant Field Values
  - NAME_REQUIRES_ROOT
```
static final java.lang.String NAME_REQUIRES_ROOT
```
    Name of the flag that indicates in only admin sessions can extract this package.
    
    See Also:
    
    Constant Field Values
  - NAME_REQUIRES_RESTART
```
static final java.lang.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 java.lang.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 java.lang.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 java.lang.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 java.lang.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 java.lang.String NAME_PACKAGE_TYPE
```
    Name of the package-type property
    
    See Also:
    
    Constant Field Values
  - PREFIX_INSTALL_HOOK
```
static final java.lang.String PREFIX_INSTALL_HOOK
```
    the prefix for an install hook property. eg: 'installhook.test1.class = ....'
    
    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
```
java.util.Calendar getLastModified()
```
    Returns the last modification date or null if n/a.
    
    Returns:
    
    last modification date or null
  - getLastModifiedBy
```
java.lang.String getLastModifiedBy()
```
    Returns the user that last modified the package or null if n/a.
    
    Returns:
    
    the user or null
  - getCreated
```
java.util.Calendar getCreated()
```
    Returns the date when this package was built or null if n/a.
    
    Returns:
    
    the creation date
  - getCreatedBy
```
java.lang.String getCreatedBy()
```
    Returns the user that built this package or null if n/a.
    
    Returns:
    
    the creator
  - getLastWrapped
```
java.util.Calendar getLastWrapped()
```
    Returns the date when this package was wrapped or null if n/a.
    
    Returns:
    
    the wrapped date
    
    Since:
    
    2.2.22
  - getLastWrappedBy
```
java.lang.String getLastWrappedBy()
```
    Returns the user that wrapped this package or null if n/a.
    
    Returns:
    
    the wrapper
    
    Since:
    
    2.2.22
  - getDescription
```
java.lang.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.
  - getDependencies
```
Dependency[] getDependencies()
```
    Returns an unmodifiable list of dependencies
    
    Returns:
    
    list of dependencies
  - 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
```
java.util.Calendar getDateProperty(java.lang.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
```
java.lang.String getProperty(java.lang.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
PackageType getPackageType()
```
    Returns the package type or null if not package type was specified for this package.
    
    Returns:
    
    the package type

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_CREATED

NAME_CREATED_BY

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

Method Detail

getId

getLastModified

getLastModifiedBy

getCreated

getCreatedBy

getLastWrapped

getLastWrappedBy

getDescription

requiresRoot

getDependencies

getACHandling

getSubPackageHandling

getDateProperty

getProperty

getPackageType