001    package org.apache.maven.project;
002    
003    /*
004     * Licensed to the Apache Software Foundation (ASF) under one
005     * or more contributor license agreements.  See the NOTICE file
006     * distributed with this work for additional information
007     * regarding copyright ownership.  The ASF licenses this file
008     * to you under the Apache License, Version 2.0 (the
009     * "License"); you may not use this file except in compliance
010     * with the License.  You may obtain a copy of the License at
011     *
012     *   http://www.apache.org/licenses/LICENSE-2.0
013     *
014     * Unless required by applicable law or agreed to in writing,
015     * software distributed under the License is distributed on an
016     * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
017     * KIND, either express or implied.  See the License for the
018     * specific language governing permissions and limitations
019     * under the License.
020     */
021    
022    import java.util.List;
023    
024    import org.codehaus.plexus.classworlds.realm.ClassRealm;
025    import org.sonatype.aether.graph.DependencyFilter;
026    
027    /**
028     * Caches project class realms. <strong>Warning:</strong> This is an internal utility interface that is only public for
029     * technical reasons, it is not part of the public API. In particular, this interface can be changed or deleted without
030     * prior notice.
031     * 
032     * @author Igor Fedorenko
033     * @author Benjamin Bentmann
034     */
035    public interface ProjectRealmCache
036    {
037    
038        public static class CacheRecord
039        {
040    
041            public final ClassRealm realm;
042    
043            public final DependencyFilter extensionArtifactFilter;
044    
045            public CacheRecord( ClassRealm realm, DependencyFilter extensionArtifactFilter )
046            {
047                this.realm = realm;
048                this.extensionArtifactFilter = extensionArtifactFilter;
049            }
050    
051        }
052    
053        CacheRecord get( List<? extends ClassRealm> extensionRealms );
054    
055        CacheRecord put( List<? extends ClassRealm> extensionRealms, ClassRealm projectRealm,
056                         DependencyFilter extensionArtifactFilter );
057    
058        void flush();
059    
060        /**
061         * Registers the specified cache record for usage with the given project. Integrators can use the information
062         * collected from this method in combination with a custom cache implementation to dispose unused records from the
063         * cache.
064         * 
065         * @param project The project that employs the plugin realm, must not be {@code null}.
066         * @param record The cache record being used for the project, must not be {@code null}.
067         */
068        void register( MavenProject project, CacheRecord record );
069    
070    }