Metadata

This is a reference for the metadata file format used by Javapackages.

<metadata>
  <uuid/>
  <properties>
    <key>value</key>
  </properties>
  <artifacts>
    <artifact>
      <groupId/>
      <artifactId/>
      <extension/>
      <classifier/>
      <version/>
      <path/>
      <namespace/>
      <uuid/>
      <properties>
        <key>value</key>
      </properties>
      <compatVersions/>
      <aliases>
        <alias>
          <groupId/>
          <artifactId/>
          <extension/>
          <classifier/>
        </alias>
      </aliases>
      <dependencies>
        <dependency>
          <groupId/>
          <artifactId/>
          <extension/>
          <classifier/>
          <requestedVersion/>
          <resolvedVersion/>
          <namespace/>
          <optional/>
          <exclusions>
            <exclusion>
              <groupId/>
              <artifactId/>
            </exclusion>
          </exclusions>
        </dependency>
      </dependencies>
    </artifact>
  </artifacts>
  <skippedArtifacts>
    <skippedArtifact>
      <groupId/>
      <artifactId/>
      <extension/>
      <classifier/>
    </skippedArtifact>
  </skippedArtifacts>
</metadata>

metadata

Root element of the metadata file.

Element Type Description
uuid String Universally unique identifier of this piece of metadata.
properties/key=value* Properties (Many) Properties of this piece of metadata.
artifacts/artifact* List<ArtifactMetadata> (Many) List of installed artifacts described by this piece of metadata.
skippedArtifacts/skippedArtifact* List<SkippedArtifactMetadata> (Many) List of artifacts built but not installed in any package. Useful for detecting broken package dependencies.

artifact

Information about a single artifact.

Element Type Description
groupId String Group identifier of the artifact.
artifactId String Identifier of the artifact.
extension String Extension of artifact file.
Default value is: jar.
classifier String Classifier of the artifact.
Default value is: .
version String Artifact version. This is always upstream version, never compat version nor SYSTEM.
path String Absolute path to artifact file stored in the local file system.
namespace String A namespace within which this artifact is stored. This usually is an identifier of software collection.
Default value is: .
uuid String Universally unique identifier of this artifact.
properties/key=value* Properties (Many) Extra properties of this artifact.
compatVersions/version* List<String> (Many) Compatibility versions of this artifact. If the list is empty then this artifact is not considered as compatibility artifact.
aliases/alias* List<ArtifactAlias> (Many) Alternative identifiers of the artifact.
dependencies/dependency* List<Dependency> (Many) List of artifact dependencies.

alias

Alternative artifact identification coordinates.

Element Type Description
groupId String Group ID of the artifact alias.
artifactId String Artifact ID of the artifact alias.
extension String Extension of the artifact alias.
Default value is: jar.
classifier String Classifier of the artifact alias.
Default value is: .

dependency

Description of dependency artifact.

Element Type Description
groupId String Group ID of the dependency artifact.
artifactId String Artifact ID of the dependency artifact.
extension String Extension of the dependency artifact.
Default value is: jar.
classifier String Classifier of the dependency artifact.
Default value is: .
requestedVersion String Version of the dependency artifact as defined in the main artifact descriptor. This may be a version range as supported by Aether.
Default value is: SYSTEM.
resolvedVersion String Version of the dependency artifact, as resolved during build. Absence of this field indicates a dependency on default artifact version.
Default value is: SYSTEM.
namespace String A namespace within which this artifact is stored. This usually is an identifier of software collection.
Default value is: .
optional Boolean Specifies whether given dependency is optional or not.
exclusions/exclusion* List<DependencyExclusion> (Many) List of dependency exclusions.

exclusion

Description of artifact excluded from dependency tree.

Element Type Description
groupId String Group ID of the excluded artifact.
artifactId String Artifact ID of the excluded artifact.

skippedArtifact

Information about artifact which was built, but not installed into any package.

Element Type Description
groupId String Group ID of skipped artifact.
artifactId String Artifact ID of skipped artifact.
extension String Extension of skipped artifact.
Default value is: jar.
classifier String Classifier of skipped artifact.
Default value is: .