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 * @version $Id: ArtifactMetadata.java 828793 2009-10-22 17:34:20Z bentmann $
30 * @todo merge with artifactmetadatasource
31 * @todo retrieval exception not appropriate for store
32 */
33 public interface ArtifactMetadata
34 {
35 /** Whether this metadata should be stored alongside the artifact. */
36 boolean storedInArtifactVersionDirectory();
37
38 /** Whether this metadata should be stored alongside the group. */
39 boolean storedInGroupDirectory();
40
41 String getGroupId();
42
43 String getArtifactId();
44
45 String getBaseVersion();
46
47 Object getKey();
48
49 /**
50 * Get the filename of this metadata on the local repository.
51 *
52 * @param repository the remote repository it came from
53 * @return the filename
54 */
55 String getLocalFilename( ArtifactRepository repository );
56
57 /**
58 * Get the filename of this metadata on the remote repository.
59 *
60 * @return the filename
61 */
62 String getRemoteFilename();
63
64 /**
65 * Merge a new metadata set into this piece of metadata.
66 *
67 * @param metadata the new metadata
68 * @todo this should only be needed on the repository metadata
69 */
70 void merge( ArtifactMetadata metadata );
71
72 /**
73 * Store the metadata in the local repository.
74 *
75 * @param localRepository the local repository
76 * @param remoteRepository the remote repository it came from
77 * @todo this should only be needed on the repository metadata
78 */
79 void storeInLocalRepository( ArtifactRepository localRepository,
80 ArtifactRepository remoteRepository )
81 throws RepositoryMetadataStoreException;
82
83 String extendedToString();
84 }