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.plugin;
20  
21  import java.util.List;
22  
23  import org.apache.maven.model.Plugin;
24  import org.apache.maven.plugin.descriptor.PluginDescriptor;
25  import org.eclipse.aether.RepositorySystemSession;
26  import org.eclipse.aether.repository.RemoteRepository;
27  
28  /**
29   * Caches raw plugin descriptors. A raw plugin descriptor is a descriptor that has just been extracted from the plugin
30   * artifact and does not contain any runtime specific data. The cache must not be used for descriptors that hold runtime
31   * data like the plugin realm. <strong>Warning:</strong> This is an internal utility interface that is only public for
32   * technical reasons, it is not part of the public API. In particular, this interface can be changed or deleted without
33   * prior notice.
34   *
35   * @since 3.0
36   * @author Benjamin Bentmann
37   */
38  public interface PluginDescriptorCache {
39  
40      /**
41       * A cache key.
42       */
43      interface Key {
44          // marker interface for cache keys
45      }
46  
47      @FunctionalInterface
48      interface PluginDescriptorSupplier {
49          PluginDescriptor load()
50                  throws PluginResolutionException, PluginDescriptorParsingException, InvalidPluginDescriptorException;
51      }
52  
53      Key createKey(Plugin plugin, List<RemoteRepository> repositories, RepositorySystemSession session);
54  
55      void put(Key key, PluginDescriptor pluginDescriptor);
56  
57      PluginDescriptor get(Key key);
58  
59      default PluginDescriptor get(Key key, PluginDescriptorSupplier supplier)
60              throws PluginResolutionException, PluginDescriptorParsingException, InvalidPluginDescriptorException {
61          PluginDescriptor pd = get(key);
62          if (pd == null) {
63              pd = supplier.load();
64              put(key, pd);
65          }
66          return pd;
67      }
68  
69      void flush();
70  }