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