Interface MetaInf

All Known Implementing Classes:
DefaultMetaInf

@ProviderType public interface MetaInf
Abstracts the way of accessing the vault specific meta-info of a checkout. TODO: merge with packageInfo
  • Field Details

    • FORMAT_VERSION_1

      static final int FORMAT_VERSION_1
      Format Version 1. Used for content assembled until Vault 1.2.8
      Since:
      2.0
      See Also:
    • FORMAT_VERSION_2

      static final int FORMAT_VERSION_2
      Format Version 2. Used for content assembled since Vault 1.2.9
      Since:
      2.0
      See Also:
    • PACKAGE_FORMAT_VERSION

      static final String PACKAGE_FORMAT_VERSION
      Name of the package format version
      Since:
      2.0
      See Also:
    • CREATED

      static final String CREATED
      Name of the 'created' property
      See Also:
    • CREATED_BY

      static final String CREATED_BY
      Name of the 'created by' property
      See Also:
    • GENERATOR

      static final String GENERATOR
      Name of the 'generator' property
      See Also:
  • Method Details

    • getPackageFormatVersion

      int getPackageFormatVersion()
      Returns the package format version of this package. If the package lacks this information, FORMAT_VERSION_2 is returned, since this feature was implemented recently.
      Returns:
      the package format version
      Since:
      2.0
    • getSettings

      @Nullable @Nullable VaultSettings getSettings()
      Returns the vault settings.
      Returns:
      the vault settings
    • getFilter

      @Nullable @Nullable WorkspaceFilter getFilter()
      Returns the workspace filter.
      Returns:
      the workspace filter
    • getConfig

      @Nullable @Nullable VaultFsConfig getConfig()
      Returns the vault config.
      Returns:
      the vault config
    • getProperties

      @Nullable @Nullable Properties getProperties()
      Returns the properties.
      Returns:
      the properties
    • getPackageProperties

      @NotNull @NotNull PackageProperties getPackageProperties()
      Returns the package properties.
      Returns:
      the package properties
    • getNodeTypes

      @NotNull @NotNull Collection<NodeTypeSet> getNodeTypes()
      Returns the node types.
      Returns:
      the node types
    • getPrivileges

      @Nullable @Nullable PrivilegeDefinitions getPrivileges()
      Returns custom privileges defined in the meta inf.
      Returns:
      a collection of custom privileges
      Since:
      3.0
    • hasDefinition

      boolean hasDefinition()
      Checks if the meta-inf contains a serialized definition.
      Returns:
      true if it contains a serialized definition