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.apache.maven.repository.internal.artifact;
20
21 /**
22 * The keys for Maven specific properties of artifacts. These properties "extend" (or supplement) the Resolver
23 * core properties defined in {@link org.eclipse.aether.artifact.ArtifactProperties}.
24 *
25 * @see org.eclipse.aether.artifact.ArtifactProperties
26 * @since 4.0.0
27 */
28 public final class MavenArtifactProperties {
29 /**
30 * A boolean flag indicating whether the artifact presents some kind of bundle that physically includes its
31 * dependencies, e.g. a fat WAR.
32 */
33 public static final String INCLUDES_DEPENDENCIES = "includesDependencies";
34
35 /**
36 * A boolean flag indicating whether the artifact is meant to be used for the compile/runtime/test build path of a
37 * consumer project.
38 * <p>
39 * Note: This property is about "build path", whatever it means in the scope of the consumer project. It is NOT
40 * about Java classpath or anything alike. How artifact is being consumed depends heavily on the consumer project.
41 * Resolver is and will remain agnostic of consumer project use cases.
42 */
43 public static final String CONSTITUTES_BUILD_PATH = "constitutesBuildPath";
44
45 /**
46 * The (expected) path to the artifact on the local filesystem. An artifact which has this property set is assumed
47 * to be not present in any regular repository and likewise has no artifact descriptor. Artifact resolution will
48 * verify the path and resolve the artifact if the path actually denotes an existing file. If the path isn't valid,
49 * resolution will fail and no attempts to search local/remote repositories are made.
50 */
51 public static final String LOCAL_PATH = "localPath";
52
53 private MavenArtifactProperties() {
54 // hide constructor
55 }
56 }