1 /*
2 * Copyright (C) 2018, Konrad Windszus <konrad_w@gmx.de>
3 * and other copyright owners as documented in the project's IP log.
4 *
5 * This program and the accompanying materials are made available
6 * under the terms of the Eclipse Distribution License v1.0 which
7 * accompanies this distribution, is reproduced below, and is
8 * available at http://www.eclipse.org/org/documents/edl-v10.php
9 *
10 * All rights reserved.
11 *
12 * Redistribution and use in source and binary forms, with or
13 * without modification, are permitted provided that the following
14 * conditions are met:
15 *
16 * - Redistributions of source code must retain the above copyright
17 * notice, this list of conditions and the following disclaimer.
18 *
19 * - Redistributions in binary form must reproduce the above
20 * copyright notice, this list of conditions and the following
21 * disclaimer in the documentation and/or other materials provided
22 * with the distribution.
23 *
24 * - Neither the name of the Eclipse Foundation, Inc. nor the
25 * names of its contributors may be used to endorse or promote
26 * products derived from this software without specific prior
27 * written permission.
28 *
29 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
30 * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
31 * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
32 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
33 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
34 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
35 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
36 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
37 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
38 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
39 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
40 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
41 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
42 */
43 package org.eclipse.jgit.internal.transport.http;
44
45 import java.nio.file.Path;
46
47 import org.eclipse.jgit.transport.HttpConfig;
48 import org.eclipse.jgit.util.LRUMap;
49
50 /**
51 * A cache of all known cookie files ({@link NetscapeCookieFile}). May contain
52 * at most {@code n} entries, where the least-recently used one is evicted as
53 * soon as more entries are added. The maximum number of entries (={@code n})
54 * can be set via the git config key {@code http.cookieFileCacheLimit}. By
55 * default it is set to 10.
56 * <p>
57 * The cache is global, i.e. it is shared among all consumers within the same
58 * Java process.
59 *
60 * @see NetscapeCookieFile
61 *
62 */
63 public class NetscapeCookieFileCache {
64
65 private final LRUMap<Path, NetscapeCookieFile> cookieFileMap;
66
67 private static NetscapeCookieFileCache instance;
68
69 private NetscapeCookieFileCache(HttpConfig config) {
70 cookieFileMap = new LRUMap<>(config.getCookieFileCacheLimit(),
71 config.getCookieFileCacheLimit());
72 }
73
74 /**
75 * @param config
76 * the config which defines the limit for this cache
77 * @return the singleton instance of the cookie file cache. If the cache has
78 * already been created the given config is ignored (even if it
79 * differs from the config, with which the cache has originally been
80 * created)
81 */
82 public static NetscapeCookieFileCache getInstance(HttpConfig config) {
83 if (instance == null) {
84 return new NetscapeCookieFileCache(config);
85 }
86 return instance;
87 }
88
89 /**
90 * @param path
91 * the path of the cookie file to retrieve
92 * @return the cache entry belonging to the requested file
93 */
94 public NetscapeCookieFile getEntry(Path path) {
95 if (!cookieFileMap.containsKey(path)) {
96 synchronized (NetscapeCookieFileCache.class) {
97 if (!cookieFileMap.containsKey(path)) {
98 cookieFileMap.put(path, new NetscapeCookieFile(path));
99 }
100 }
101 }
102 return cookieFileMap.get(path);
103 }
104
105 }