Package org.apache.jackrabbit.vault.packaging

Interface JcrPackageDefinition

All Superinterfaces:
PackageProperties
All Known Implementing Classes:
JcrPackageDefinitionImpl
@ProviderType public interface JcrPackageDefinition extends PackageProperties
Specifies the interface of a package definition stored in the repository.

  • Field Details

  • Method Details

    • getNode

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

    • setId

      void setId(@NotNull @NotNull 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 @Nullable VaultPackage pack, boolean force, boolean autoSave) throws RepositoryException, 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
      IOException - if an I/O error occurs

    • dumpCoverage

      void dumpCoverage(@NotNull @NotNull ProgressTrackerListener listener) throws RepositoryException
      Dumps the coverage of this definition to the given listener
      Parameters:
      listener - the listener
      Throws:
      RepositoryException - if an error occurrs

    • setDependencies

      void setDependencies(@NotNull @NotNull 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

      @Nullable @Nullable String get(@NotNull @NotNull 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(@NotNull @NotNull 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

      @Nullable @Nullable Calendar getCalendar(@NotNull @NotNull 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(@NotNull @NotNull String name, @Nullable @Nullable 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(@NotNull @NotNull String name, @Nullable @Nullable 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(@NotNull @NotNull 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 @Nullable 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 @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.

    • getLastUnwrapped

      @Nullable @Nullable Calendar getLastUnwrapped()
      Returns the last unwrapped date
      Returns:
      the last unwrapped date

    • getLastUnwrappedBy

      @Nullable @Nullable String getLastUnwrappedBy()
      Returns the last unwrapped user id
      Returns:
      the last unwrapped user id

    • getLastUnpacked

      @Nullable @Nullable Calendar getLastUnpacked()
      Returns the date when the package was unpacked
      Returns:
      the unpacked date

    • getLastUnpackedBy

      @Nullable @Nullable String getLastUnpackedBy()
      Returns the user id who unpacked the package
      Returns:
      the unpacked user id

    • getAccessControlHandling

      @Nullable @Deprecated @Nullable AccessControlHandling getAccessControlHandling()
      Deprecated.
      Use PackageProperties.getACHandling() retrieved via getMetaInf() and MetaInf.getPackageProperties().
      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

    • getMetaInf

      @NotNull @NotNull MetaInf getMetaInf() throws RepositoryException
      Returns the meta inf of this package
      Returns:
      the meta inf
      Throws:
      RepositoryException - if an error occurs.