Package org.apache.jackrabbit.vault.packaging

Interface JcrPackageDefinition

  • @ProviderType
public interface JcrPackageDefinition
    Specifies the interface of a package definition stored in the repository.

    • Field Summary

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

    • Method Summary

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

    • Field Detail

      • PN_LAST_UNPACKED

        static final java.lang.String PN_LAST_UNPACKED
        Property name of the last unpacked date
        See Also:
        Constant Field Values

      • PN_LAST_UNPACKED_BY

        static final java.lang.String PN_LAST_UNPACKED_BY
        Property name of the last unpacked user id
        See Also:
        Constant Field Values

      • PN_CREATED

        static final java.lang.String PN_CREATED
        Property name of the creation date
        See Also:
        Constant Field Values

      • PN_CREATED_BY

        static final java.lang.String PN_CREATED_BY
        Property name of the creation user id
        See Also:
        Constant Field Values

      • PN_LASTMODIFIED

        static final java.lang.String PN_LASTMODIFIED
        Property name of the last modification date
        See Also:
        Constant Field Values

      • PN_LASTMODIFIED_BY

        static final java.lang.String PN_LASTMODIFIED_BY
        Property name of the last modification user id
        See Also:
        Constant Field Values

      • PN_LAST_WRAPPED

        static final java.lang.String PN_LAST_WRAPPED
        Property name of the last wrapped date
        Since:
        2.2.22
        See Also:
        Constant Field Values

      • PN_LAST_WRAPPED_BY

        static final java.lang.String PN_LAST_WRAPPED_BY
        Property name of the last wrapped user id
        Since:
        2.2.22
        See Also:
        Constant Field Values

      • PN_DESCRIPTION

        static final java.lang.String PN_DESCRIPTION
        Property name of the package description
        See Also:
        Constant Field Values

      • PN_VERSION

        static final java.lang.String PN_VERSION
        Property name of the package version
        See Also:
        Constant Field Values

      • PN_BUILD_COUNT

        static final java.lang.String PN_BUILD_COUNT
        Property name of the build count
        See Also:
        Constant Field Values

      • PN_NAME

        static final java.lang.String PN_NAME
        Property name of the 'name'
        Since:
        2.2
        See Also:
        Constant Field Values

      • PN_GROUP

        static final java.lang.String PN_GROUP
        Property name of the 'group'
        Since:
        2.2
        See Also:
        Constant Field Values

      • PN_REQUIRES_ROOT

        static final java.lang.String PN_REQUIRES_ROOT
        Property name of the "requires root" flag
        See Also:
        Constant Field Values

      • PN_REQUIRES_RESTART

        static final java.lang.String PN_REQUIRES_RESTART
        Property name of the "require restart" flag
        See Also:
        Constant Field Values

      • PN_DEPENDENCIES

        static final java.lang.String PN_DEPENDENCIES
        Property name of the package dependencies
        See Also:
        Constant Field Values

      • PN_SUB_PACKAGES

        static final java.lang.String PN_SUB_PACKAGES
        Property name of the sub packages (only used in snapshots)
        See Also:
        Constant Field Values

      • PN_LAST_UNWRAPPED

        static final java.lang.String PN_LAST_UNWRAPPED
        Property name of the last unwrapped date
        See Also:
        Constant Field Values

      • PN_LAST_UNWRAPPED_BY

        static final java.lang.String PN_LAST_UNWRAPPED_BY
        Property name of the last unwrapped user id
        See Also:
        Constant Field Values

      • PN_AC_HANDLING

        static final java.lang.String PN_AC_HANDLING
        Property name of the access control handling mode
        See Also:
        Constant Field Values

      • PN_CND_PATTERN

        static final java.lang.String PN_CND_PATTERN
        Property name of the cnd pattern filter
        See Also:
        Constant Field Values

      • NN_FILTER

        static final java.lang.String NN_FILTER
        Node name of the filter node
        See Also:
        Constant Field Values

      • PN_ROOT

        static final java.lang.String PN_ROOT
        Property name of the filter root
        See Also:
        Constant Field Values

      • PN_MODE

        static final java.lang.String PN_MODE
        Property name of the filter root
        See Also:
        Constant Field Values

      • PN_RULES

        static final java.lang.String PN_RULES
        Property name of the filter rules
        See Also:
        Constant Field Values

      • PN_TYPE

        static final java.lang.String PN_TYPE
        Property name of the rule type
        See Also:
        Constant Field Values

      • PN_PATTERN

        static final java.lang.String PN_PATTERN
        Property name of the rule pattern
        See Also:
        Constant Field Values

      • PN_DISABLE_INTERMEDIATE_SAVE

        static final java.lang.String PN_DISABLE_INTERMEDIATE_SAVE
        Property name of the disable intermediate save flag
        See Also:
        Constant Field Values

    • Method Detail

      • getNode

        @Nonnull
Node getNode()
        Returns the underlying node
        Returns:
        the node

      • getId

        @Nonnull
PackageId getId()
        Returns the package id
        Returns:
        the package id

      • setId

        void setId​(@Nonnull
           PackageId id,
           boolean autoSave)
        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()
        Checks if this definition is unwrapped, i.e. if the definition structured was extracted from a VaultPackage.
        Returns:
        true if unwrapped.

      • isModified

        boolean isModified()
        Checks if the definition was modified since it was last wrapped. new packages are considered modified.
        Returns:
        true if modified

      • unwrap

        void unwrap​(@Nullable
            VaultPackage pack,
            boolean force,
            boolean autoSave)
     throws RepositoryException,
            java.io.IOException
        Unwraps 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
        java.io.IOException - if an I/O error occurs

      • getDependencies

        @Nonnull
Dependency[] getDependencies()
        Returns the dependencies stored in this definition
        Returns:
        the dependencies

      • setDependencies

        void setDependencies​(@Nonnull
                     Dependency[] dependencies,
                     boolean autoSave)
        Sets the dependencies to this definition and stores it in a node representation.
        Parameters:
        dependencies - the package dependencies
        autoSave - if true the modifications are saved automatically.
        Since:
        3.1.32

      • get

        @CheckForNull
java.lang.String get​(@Nonnull
                     java.lang.String name)
        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​(@Nonnull
                   java.lang.String name)
        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

        @CheckForNull
java.util.Calendar getCalendar​(@Nonnull
                               java.lang.String name)
        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​(@Nonnull
         java.lang.String name,
         @Nullable
         java.lang.String value,
         boolean autoSave)
        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​(@Nonnull
         java.lang.String name,
         @Nullable
         java.util.Calendar value,
         boolean autoSave)
        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​(@Nonnull
         java.lang.String name,
         boolean value,
         boolean autoSave)
        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​(@Nullable
           java.util.Calendar now,
           boolean autoSave)
        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​(@Nullable
               WorkspaceFilter filter,
               boolean autoSave)
        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

        @CheckForNull
java.util.Calendar getLastModified()
        Returns the last modified date
        Returns:
        the last modified date

      • getLastModifiedBy

        @CheckForNull
java.lang.String getLastModifiedBy()
        Returns the last modified user id
        Returns:
        the last modified user id

      • getCreated

        @CheckForNull
java.util.Calendar getCreated()
        Returns the created date
        Returns:
        the created date

      • getCreatedBy

        @CheckForNull
java.lang.String getCreatedBy()
        Returns the creator user id
        Returns:
        the creator

      • getLastWrapped

        @CheckForNull
java.util.Calendar getLastWrapped()
        Returns the last wrapped date
        Returns:
        the last wrapped date
        Since:
        2.2.22

      • getLastWrappedBy

        @CheckForNull
java.lang.String getLastWrappedBy()
        Returns the wrapper user id
        Returns:
        the wrapper
        Since:
        2.2.22

      • getLastUnwrapped

        @CheckForNull
java.util.Calendar getLastUnwrapped()
        Returns the last unwrapped date
        Returns:
        the last unwrapped date

      • getLastUnwrappedBy

        @CheckForNull
java.lang.String getLastUnwrappedBy()
        Returns the last unwrapped user id
        Returns:
        the last unwrapped user id

      • getLastUnpacked

        @CheckForNull
java.util.Calendar getLastUnpacked()
        Returns the date when the package was unpacked
        Returns:
        the unpacked date

      • getLastUnpackedBy

        @CheckForNull
java.lang.String getLastUnpackedBy()
        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()
        Returns true if this package needs restart after installation.
        Returns:
        the "requires restart" flag.

      • getAccessControlHandling

        @CheckForNull
AccessControlHandling getAccessControlHandling()
        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

        @CheckForNull
java.lang.String getDescription()
        Returns the description of this package
        Returns:
        the description

      • getBuildCount

        long getBuildCount()
        Returns the build count of this package
        Returns:
        the build count.