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