View Javadoc

1   package org.apache.maven.repository.legacy.metadata;
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  import org.apache.maven.artifact.repository.ArtifactRepository;
23  import org.apache.maven.artifact.repository.metadata.RepositoryMetadataStoreException;
24  
25  /**
26   * Contains metadata about an artifact, and methods to retrieve/store it from an artifact repository.
27   *
28   * @author <a href="mailto:brett@apache.org">Brett Porter</a>
29   * @todo merge with artifactmetadatasource
30   * @todo retrieval exception not appropriate for store
31   */
32  public interface ArtifactMetadata
33  {
34      /** Whether this metadata should be stored alongside the artifact. */
35      boolean storedInArtifactVersionDirectory();
36  
37      /** Whether this metadata should be stored alongside the group. */
38      boolean storedInGroupDirectory();
39  
40      String getGroupId();
41  
42      String getArtifactId();
43  
44      String getBaseVersion();
45  
46      Object getKey();
47  
48      /**
49       * Get the filename of this metadata on the local repository.
50       *
51       * @param repository the remote repository it came from
52       * @return the filename
53       */
54      String getLocalFilename( ArtifactRepository repository );
55  
56      /**
57       * Get the filename of this metadata on the remote repository.
58       *
59       * @return the filename
60       */
61      String getRemoteFilename();
62  
63      /**
64       * Merge a new metadata set into this piece of metadata.
65       *
66       * @param metadata the new metadata
67       * @todo this should only be needed on the repository metadata
68       */
69      void merge( ArtifactMetadata metadata );
70  
71      /**
72       * Store the metadata in the local repository.
73       *
74       * @param localRepository  the local repository
75       * @param remoteRepository the remote repository it came from
76       * @todo this should only be needed on the repository metadata
77       */
78      void storeInLocalRepository( ArtifactRepository localRepository,
79                                   ArtifactRepository remoteRepository )
80          throws RepositoryMetadataStoreException;
81  
82      String extendedToString();
83  }