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