Package org.apache.jackrabbit.vault.packaging

Interface PackageProperties

  • All Known Subinterfaces:
    JcrPackageDefinition, VaultPackage
    @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 java.lang.String MF_KEY_IMPORT_PACKAGE
      The manifest header key containing all necessary imports for this package
      static java.lang.String MF_KEY_PACKAGE_DEPENDENCIES
      The manifest header key for the package dependencies.
      static java.lang.String MF_KEY_PACKAGE_DEPENDENCIES_LOCATIONS
      The manifest header key for locations of package dependencies.
      static java.lang.String MF_KEY_PACKAGE_DESC
      The manifest header key for the package description.
      static java.lang.String MF_KEY_PACKAGE_ID
      The manifest header key for the package id in the form <group>:<name>:<version>
      static java.lang.String MF_KEY_PACKAGE_ROOTS
      The manifest header key for all filter roots separated by ','.
      static java.lang.String MF_KEY_PACKAGE_TYPE
      The manifest header key which indicates the package type
      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_DEPENDENCIES_LOCATIONS
      Name of the meta-inf property for locations of package dependencies.
      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_GENERATOR
      Name of the generator by meta-inf property
      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 that 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 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
      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
      @NotNull java.util.Map<PackageId,​java.net.URI> getDependenciesLocations()
      Returns a map of dependency locations where key = package id and value = uri of package dependency with that id.
      java.lang.String getDescription()
      Returns a description of this package or null if n/a
      java.util.Map<java.lang.String,​java.lang.String> getExternalHooks()  
      java.lang.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.
      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.
      @Nullable PackageType getPackageType()
      Returns the package type or null if no 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 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 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_DEPENDENCIES_LOCATIONS

        static final java.lang.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 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_GENERATOR

        static final java.lang.String NAME_GENERATOR
        Name of the generator 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_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 that 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 name. The full name may look like this: installhook.test1.class.
        See Also:
        Constant Field Values

      • MF_KEY_PACKAGE_DEPENDENCIES

        static final java.lang.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 java.lang.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 java.lang.String MF_KEY_PACKAGE_ROOTS
        The manifest header key for all filter roots separated by ','.
        See Also:
        WorkspaceFilter, Constant Field Values

      • MF_KEY_IMPORT_PACKAGE

        static final java.lang.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

        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

      • getGenerator

        java.lang.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

        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.

      • 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

        java.util.Map<java.lang.String,​java.lang.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

        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
@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 java.util.Map<PackageId,​java.net.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.