View Javadoc

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