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