source.dussan.org Git - archiva.git/blob

   1 package org.apache.archiva.repository.content;
   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  * Represents a artifact of a repository. This object contains unique coordinates of the
  24  * artifact. A artifact has exactly one file representation in the repository.
  25  * The artifact instance does not tell, if the file exists or is readable. It just
  26  * keeps the coordinates and some meta information of the artifact.
  27  * <p>
  28  * Artifact implementations should be immutable. The implementation must not always represent the current state of the
  29  * corresponding storage asset (file). It is just a view of the attributes for a given point in time.
  30  * <p>
  31  * Implementations must provide proper hash and equals methods.
  32  *
  33  * @author Martin Stockhammer <martin_s@apache.org>
  34  */
  35 public interface Artifact extends ContentItem
  36 {
  37
  38     /**
  39      * The artifact identifier. The ID is unique in a given namespace of a given repository.
  40      * But there may exist artifacts with the same ID but different types, classifiers or extensions.
  41      * <p>
  42      * Never returns <code>null</code> or a empty string.
  43      *
  44      * @return the identifier of the artifact. Never returns <code>null</code> or empty string
  45      */
  46     String getId( );
  47
  48     /**
  49      * The version string of the artifact. The version string is exactly the version that is attached
  50      * to the artifact.
  51      * The version string may be different to the version string returned by the attached {@link Version} object.
  52      * E.g for maven artifacts the artifact version may be 1.3-20070725.210059-1 and the attached {@link Version} object
  53      * has version 1.3-SNAPSHOT.
  54      *
  55      * @return the artifact version string
  56      * @see #getVersion()
  57      */
  58     String getArtifactVersion( );
  59
  60     /**
  61      * Returns the attached version this artifact is part of.
  62      *
  63      * @return the version object
  64      */
  65     Version getVersion( );
  66
  67     /**
  68      * Returns the type of the artifact. The type is some hint about the usage of the artifact.
  69      * Implementations may always return a empty string, if it is not used.
  70      *
  71      * @return the type of the artifact. Returns never <code>null</code>, but may be empty string
  72      */
  73     String getType( );
  74
  75     /**
  76      * A classifier that distinguishes artifacts.
  77      * Implementations may always return a empty string, if it is not used.
  78      *
  79      * @return the classifier of the artifact. Returns never <code>null</code>, but may be empty string
  80      */
  81     String getClassifier( );
  82
  83     /**
  84      * Short cut for the file name. Should always return the same value as the artifact name.
  85      *
  86      * @return the name of the file
  87      */
  88     default String getFileName( )
  89     {
  90         return getAsset( ).getName( );
  91     }
  92
  93     /**
  94      * Returns the extension of the file. This method should always return the extension string after the last
  95      * '.'-character.
  96      *
  97      * @return the file name extension
  98      */
  99     default String getExtension( )
 100     {
 101         final String name = getAsset( ).getName( );
 102         final int idx = name.lastIndexOf( '.' );
 103         if ( idx >= 0 )
 104         {
 105             return name.substring( idx );
 106         }
 107         else
 108         {
 109             return "";
 110         }
 111     }
 112
 113     /**
 114      * This may be different from extension and gives the remainder that is used to build the file path from
 115      * the artifact coordinates (namespace, id, version, classifier, type)
 116      *
 117      * @return the file name remainder
 118      */
 119     String getRemainder( );
 120
 121     /**
 122      * Should return the mime type of the artifact.
 123      *
 124      * @return the mime type of the artifact.
 125      */
 126     String getContentType( );
 127
 128     /**
 129      * Returns the type of the artifact
 130      * @return
 131      */
 132     ArtifactType getArtifactType();
 133
 134 }