001package 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
022import java.util.List;
023
024import org.codehaus.plexus.classworlds.realm.ClassRealm;
025import org.eclipse.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 */
035public interface ProjectRealmCache
036{
037
038    /**
039     * A cache key.
040     */
041    interface Key
042    {
043        // marker interface for cache keys
044    }
045
046    static class CacheRecord
047    {
048
049        public final ClassRealm realm;
050
051        public final DependencyFilter extensionArtifactFilter;
052
053        public CacheRecord( ClassRealm realm, DependencyFilter extensionArtifactFilter )
054        {
055            this.realm = realm;
056            this.extensionArtifactFilter = extensionArtifactFilter;
057        }
058
059    }
060
061    Key createKey( List<? extends ClassRealm> extensionRealms );
062
063    CacheRecord get( Key key );
064
065    CacheRecord put( Key key, ClassRealm projectRealm, DependencyFilter extensionArtifactFilter );
066
067    void flush();
068
069    /**
070     * Registers the specified cache record for usage with the given project. Integrators can use the information
071     * collected from this method in combination with a custom cache implementation to dispose unused records from the
072     * cache.
073     * 
074     * @param project The project that employs the plugin realm, must not be {@code null}.
075     * @param record The cache record being used for the project, must not be {@code null}.
076     */
077    void register( MavenProject project, Key key, CacheRecord record );
078
079}