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