1 package org.apache.maven.artifact.repository;
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 /**
23 * Caches auxiliary data used during repository access like already processed metadata. The data in the cache is meant
24 * for exclusive consumption by the repository system and is opaque to the cache implementation.
25 *
26 * @author Benjamin Bentmann
27 */
28 @Deprecated
29 //
30 // Used by Tycho and will break users and force them to upgrade to Maven 3.1 so we should really leave
31 // this here, possibly indefinitely.
32 //
33 public interface RepositoryCache
34 {
35
36 /**
37 * Puts the specified data into the cache. <strong>Warning:</strong> The cache will directly save the provided
38 * reference. If the cached data is mutable, i.e. could be modified after being put into the cache, the caller is
39 * responsible for creating a copy of the original data and store the copy in the cache.
40 *
41 * @param request The repository request from which this cache was retrieved, must not be {@code null}.
42 * @param key The key to use associate the data with, must not be {@code null}.
43 * @param data The data to store in the cache, may be {@code null}.
44 */
45 void put( RepositoryRequest request, Object key, Object data );
46
47 /**
48 * Gets the specified data from the cache. <strong>Warning:</strong> The cache will directly return the saved
49 * reference. If the cached data is to be modified after its retrieval, the caller is responsible to create a copy
50 * of the returned data and use this instead of the cache record.
51 *
52 * @param request The repository request from which this cache was retrieved, must not be {@code null}.
53 * @param key The key to use for lookup of the data, must not be {@code null}.
54 * @return The requested data or {@code null} if none was present in the cache.
55 */
56 Object get( RepositoryRequest request, Object key );
57
58 }