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.plugin.descriptor.PluginDescriptor;
26  import org.sonatype.aether.RepositorySystemSession;
27  import org.sonatype.aether.repository.RemoteRepository;
28  
29  /**
30   * Caches raw plugin descriptors. A raw plugin descriptor is a descriptor that has just been extracted from the plugin
31   * artifact and does not contain any runtime specific data. The cache must not be used for descriptors that hold runtime
32   * data like the plugin realm. <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   * @since 3.0
37   * @author Benjamin Bentmann
38   */
39  public interface PluginDescriptorCache
40  {
41  
42      /**
43       * A cache key.
44       */
45      interface Key
46      {
47          // marker interface for cache keys
48      }
49  
50      Key createKey( Plugin plugin, List<RemoteRepository> repositories, RepositorySystemSession session );
51  
52      void put( Key key, PluginDescriptor pluginDescriptor );
53  
54      PluginDescriptor get( Key key );
55  
56      void flush();
57  
58  }