View Javadoc
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.project.artifact;
20  
21  import java.util.Collection;
22  import java.util.Set;
23  
24  import org.apache.maven.artifact.Artifact;
25  import org.apache.maven.lifecycle.LifecycleExecutionException;
26  import org.apache.maven.project.MavenProject;
27  import org.eclipse.aether.RepositorySystemSession;
28  
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   */
35  public interface ProjectArtifactsCache {
36  
37      /**
38       * A cache key.
39       */
40      interface Key {
41          // marker interface for cache keys
42      }
43  
44      /**
45       * CacheRecord
46       */
47      class CacheRecord {
48  
49          public Set<Artifact> getArtifacts() {
50              return artifacts;
51          }
52  
53          private final Set<Artifact> artifacts;
54  
55          public LifecycleExecutionException getException() {
56              return exception;
57          }
58  
59          private final LifecycleExecutionException exception;
60  
61          CacheRecord(Set<Artifact> artifacts) {
62              this.artifacts = artifacts;
63              this.exception = null;
64          }
65  
66          CacheRecord(LifecycleExecutionException exception) {
67              this.artifacts = null;
68              this.exception = exception;
69          }
70      }
71  
72      Key createKey(
73              MavenProject project,
74              Collection<String> scopesToCollect,
75              Collection<String> scopesToResolve,
76              boolean aggregating,
77              RepositorySystemSession session);
78  
79      CacheRecord get(Key key) throws LifecycleExecutionException;
80  
81      CacheRecord put(Key key, Set<Artifact> pluginArtifacts);
82  
83      CacheRecord put(Key key, LifecycleExecutionException e);
84  
85      void flush();
86  
87      /**
88       * Registers the specified cache record for usage with the given project. Integrators can use the information
89       * collected from this method in combination with a custom cache implementation to dispose unused records from the
90       * cache.
91       *
92       * @param project The project that employs the plugin realm, must not be {@code null}.
93       * @param record The cache record being used for the project, must not be {@code null}.
94       */
95      void register(MavenProject project, Key cacheKey, CacheRecord record);
96  }