1 package org.apache.maven.project.artifact;
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 java.util.Collection;
23 import java.util.Set;
24
25 import org.apache.maven.artifact.Artifact;
26 import org.apache.maven.lifecycle.LifecycleExecutionException;
27 import org.apache.maven.project.MavenProject;
28 import org.eclipse.aether.RepositorySystemSession;
29 /**
30 * Caches project artifacts. <strong>Warning:</strong> This is an internal utility interface that is only public for
31 * technical reasons, it is not part of the public API. In particular, this interface can be changed or deleted without
32 * prior notice.
33 *
34 * @author Igor Fedorenko
35 * @author Benjamin Bentmann
36 * @author Anton Tanasenko
37 */
38 public interface ProjectArtifactsCache
39 {
40
41 /**
42 * A cache key.
43 */
44 interface Key
45 {
46 // marker interface for cache keys
47 }
48
49 /**
50 * CacheRecord
51 */
52 class CacheRecord
53 {
54
55 public Set<Artifact> getArtifacts()
56 {
57 return artifacts;
58 }
59
60 private final Set<Artifact> artifacts;
61
62 public LifecycleExecutionException getException()
63 {
64 return exception;
65 }
66
67 private final LifecycleExecutionException exception;
68
69 CacheRecord( Set<Artifact> artifacts )
70 {
71 this.artifacts = artifacts;
72 this.exception = null;
73 }
74
75 CacheRecord( LifecycleExecutionException exception )
76 {
77 this.artifacts = null;
78 this.exception = exception;
79 }
80 }
81
82 Key createKey( MavenProject project, Collection<String> scopesToCollect, Collection<String> scopesToResolve,
83 boolean aggregating, RepositorySystemSession session );
84
85 CacheRecord get( Key key ) throws LifecycleExecutionException;
86
87 CacheRecord put( Key key, Set<Artifact> pluginArtifacts );
88
89 CacheRecord put( Key key, LifecycleExecutionException e );
90
91 void flush();
92
93 /**
94 * Registers the specified cache record for usage with the given project. Integrators can use the information
95 * collected from this method in combination with a custom cache implementation to dispose unused records from the
96 * cache.
97 *
98 * @param project The project that employs the plugin realm, must not be {@code null}.
99 * @param record The cache record being used for the project, must not be {@code null}.
100 */
101 void register( MavenProject project, Key cacheKey, CacheRecord record );
102
103 }