001/*
002 * Licensed to the Apache Software Foundation (ASF) under one
003 * or more contributor license agreements.  See the NOTICE file
004 * distributed with this work for additional information
005 * regarding copyright ownership.  The ASF licenses this file
006 * to you under the Apache License, Version 2.0 (the
007 * "License"); you may not use this file except in compliance
008 * with the License.  You may obtain a copy of the License at
009 *
010 *   http://www.apache.org/licenses/LICENSE-2.0
011 *
012 * Unless required by applicable law or agreed to in writing,
013 * software distributed under the License is distributed on an
014 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
015 * KIND, either express or implied.  See the License for the
016 * specific language governing permissions and limitations
017 * under the License.
018 */
019package org.eclipse.aether.artifact;
020
021/**
022 * The keys for common properties of artifacts.
023 *
024 * @see Artifact#getProperties()
025 */
026public final class ArtifactProperties {
027
028    /**
029     * A high-level characterization of the artifact, e.g. "maven-plugin" or "test-jar".
030     *
031     * @see ArtifactType#getId()
032     */
033    public static final String TYPE = "type";
034
035    /**
036     * The programming language this artifact is relevant for, e.g. "java" or "none".
037     */
038    public static final String LANGUAGE = "language";
039
040    /**
041     * The (expected) path to the artifact on the local filesystem. An artifact which has this property set is assumed
042     * to be not present in any regular repository and likewise has no artifact descriptor. Artifact resolution will
043     * verify the path and resolve the artifact if the path actually denotes an existing file. If the path isn't valid,
044     * resolution will fail and no attempts to search local/remote repositories are made.
045     */
046    public static final String LOCAL_PATH = "localPath";
047
048    /**
049     * A boolean flag indicating whether the artifact presents some kind of bundle that physically includes its
050     * dependencies, e.g. a fat WAR.
051     */
052    public static final String INCLUDES_DEPENDENCIES = "includesDependencies";
053
054    /**
055     * A boolean flag indicating whether the artifact is meant to be used for the compile/runtime/test build path of a
056     * consumer project.
057     */
058    public static final String CONSTITUTES_BUILD_PATH = "constitutesBuildPath";
059
060    /**
061     * The URL to a web page from which the artifact can be manually downloaded. This URL is not contacted by the
062     * repository system but serves as a pointer for the end user to assist in getting artifacts that are not published
063     * in a proper repository.
064     */
065    public static final String DOWNLOAD_URL = "downloadUrl";
066
067    private ArtifactProperties() {
068        // hide constructor
069    }
070}