Package org.apache.jackrabbit.vault.packaging

Interface PackageProperties

  • 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 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_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_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_REQUIRES_ROOT

        static final 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 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

      • PREFIX_INSTALL_HOOK

        static final 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

        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

      • 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.

      • 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

        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
PackageType getPackageType()
        Returns the package type or null if not package type was specified for this package.
        Returns:
        the package type