View Javadoc
1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one
3    * or more contributor license agreements.  See the NOTICE file
4    * distributed with this work for additional information
5    * regarding copyright ownership.  The ASF licenses this file
6    * to you under the Apache License, Version 2.0 (the
7    * "License"); you may not use this file except in compliance
8    * with the License.  You may obtain a copy of the License at
9    *
10   *   http://www.apache.org/licenses/LICENSE-2.0
11   *
12   * Unless required by applicable law or agreed to in writing,
13   * software distributed under the License is distributed on an
14   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15   * KIND, either express or implied.  See the License for the
16   * specific language governing permissions and limitations
17   * under the License.
18   */
19  package org.eclipse.aether.artifact;
20  
21  /**
22   * The keys for common properties of artifacts.
23   *
24   * @see Artifact#getProperties()
25   */
26  public final class ArtifactProperties {
27  
28      /**
29       * A high-level characterization of the artifact, e.g. "maven-plugin" or "test-jar".
30       *
31       * @see ArtifactType#getId()
32       */
33      public static final String TYPE = "type";
34  
35      /**
36       * The programming language this artifact is relevant for, e.g. "java" or "none".
37       */
38      public static final String LANGUAGE = "language";
39  
40      /**
41       * The (expected) path to the artifact on the local filesystem. An artifact which has this property set is assumed
42       * to be not present in any regular repository and likewise has no artifact descriptor. Artifact resolution will
43       * verify the path and resolve the artifact if the path actually denotes an existing file. If the path isn't valid,
44       * resolution will fail and no attempts to search local/remote repositories are made.
45       */
46      public static final String LOCAL_PATH = "localPath";
47  
48      /**
49       * A boolean flag indicating whether the artifact presents some kind of bundle that physically includes its
50       * dependencies, e.g. a fat WAR.
51       */
52      public static final String INCLUDES_DEPENDENCIES = "includesDependencies";
53  
54      /**
55       * A boolean flag indicating whether the artifact is meant to be used for the compile/runtime/test build path of a
56       * consumer project.
57       * <p>
58       * Note: This property is about "build path", whatever it means in the scope of the consumer project. It is NOT
59       * about Java classpath or anything alike. How artifact is being consumed depends heavily on the consumer project.
60       * Resolver is and will remain agnostic of consumer project use cases.
61       */
62      public static final String CONSTITUTES_BUILD_PATH = "constitutesBuildPath";
63  
64      /**
65       * The URL to a web page from which the artifact can be manually downloaded. This URL is not contacted by the
66       * repository system but serves as a pointer for the end user to assist in getting artifacts that are not published
67       * in a proper repository.
68       */
69      public static final String DOWNLOAD_URL = "downloadUrl";
70  
71      private ArtifactProperties() {
72          // hide constructor
73      }
74  }