content/site/apidocs-8.0.0/src-html/org/apache/juneau/utils/ClasspathResourceManager.html

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> <html lang="en"> <head> <title>Source code</title> <link rel="stylesheet" type="text/css" href="../../../../../javadoc.css" title="Style"> </head> <body> <div class="sourceContainer"> <pre>001// ***************************************************************************************************************************<a name="line.1"></a> 002// * Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file *<a name="line.2"></a> 003// * distributed with this work for additional information regarding copyright ownership. The ASF licenses this file *<a name="line.3"></a> 004// * to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance *<a name="line.4"></a> 005// * with the License. You may obtain a copy of the License at *<a name="line.5"></a> 006// * *<a name="line.6"></a> 007// * http://www.apache.org/licenses/LICENSE-2.0 *<a name="line.7"></a> 008// * *<a name="line.8"></a> 009// * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an *<a name="line.9"></a> 010// * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the *<a name="line.10"></a> 011// * specific language governing permissions and limitations under the License. *<a name="line.11"></a> 012// ***************************************************************************************************************************<a name="line.12"></a> 013package org.apache.juneau.utils;<a name="line.13"></a> 014<a name="line.14"></a> 015import java.io.*;<a name="line.15"></a> 016import java.util.*;<a name="line.16"></a> 017import java.util.concurrent.*;<a name="line.17"></a> 018<a name="line.18"></a> 019import org.apache.juneau.internal.*;<a name="line.19"></a> 020<a name="line.20"></a> 021/**<a name="line.21"></a> 022 * Class for retrieving and caching resource files from the classpath.<a name="line.22"></a> 023 */<a name="line.23"></a> 024public final class ClasspathResourceManager {<a name="line.24"></a> 025<a name="line.25"></a> 026 // Maps resource names+locales to found resources.<a name="line.26"></a> 027 private final ConcurrentHashMap<ResourceKey,byte[]> byteCache;<a name="line.27"></a> 028 private final ConcurrentHashMap<ResourceKey,String> stringCache;<a name="line.28"></a> 029<a name="line.29"></a> 030 private final Class<?> baseClass;<a name="line.30"></a> 031 private final ClasspathResourceFinder resourceFinder;<a name="line.31"></a> 032 private final boolean useCache;<a name="line.32"></a> 033<a name="line.33"></a> 034 /**<a name="line.34"></a> 035 * Constructor.<a name="line.35"></a> 036 *<a name="line.36"></a> 037 * @param baseClass The default class to use for retrieving resources from the classpath.<a name="line.37"></a> 038 * @param resourceFinder The resource finder implementation.<a name="line.38"></a> 039 * @param useCache If <jk>true</jk>, retrieved resources are stored in an in-memory cache for fast lookup.<a name="line.39"></a> 040 */<a name="line.40"></a> 041 public ClasspathResourceManager(Class<?> baseClass, ClasspathResourceFinder resourceFinder, boolean useCache) {<a name="line.41"></a> 042 this.baseClass = baseClass;<a name="line.42"></a> 043 this.resourceFinder = resourceFinder;<a name="line.43"></a> 044 this.useCache = useCache;<a name="line.44"></a> 045 if (useCache) {<a name="line.45"></a> 046 this.byteCache = new ConcurrentHashMap<>();<a name="line.46"></a> 047 this.stringCache = new ConcurrentHashMap<>();<a name="line.47"></a> 048 } else {<a name="line.48"></a> 049 this.byteCache = null;<a name="line.49"></a> 050 this.stringCache = null;<a name="line.50"></a> 051 }<a name="line.51"></a> 052 }<a name="line.52"></a> 053<a name="line.53"></a> 054 /**<a name="line.54"></a> 055 * Constructor.<a name="line.55"></a> 056 *<a name="line.56"></a> 057 * <a name="line.57"></a> 058 * Uses default {@link ClasspathResourceFinderBasic} for finding resources.<a name="line.58"></a> 059 *<a name="line.59"></a> 060 * @param baseClass The default class to use for retrieving resources from the classpath.<a name="line.60"></a> 061 */<a name="line.61"></a> 062 public ClasspathResourceManager(Class<?> baseClass) {<a name="line.62"></a> 063 this(baseClass, new ClasspathResourceFinderBasic(), false);<a name="line.63"></a> 064 }<a name="line.64"></a> 065<a name="line.65"></a> 066 /**<a name="line.66"></a> 067 * Finds the resource with the given name.<a name="line.67"></a> 068 *<a name="line.68"></a> 069 * @param name Name of the desired resource.<a name="line.69"></a> 070 * @return An input stream to the object, or <jk>null</jk> if the resource could not be found.<a name="line.70"></a> 071 * @throws IOException<a name="line.71"></a> 072 */<a name="line.72"></a> 073 public InputStream getStream(String name) throws IOException {<a name="line.73"></a> 074 return getStream(name, null);<a name="line.74"></a> 075 }<a name="line.75"></a> 076<a name="line.76"></a> 077 /**<a name="line.77"></a> 078 * Finds the resource with the given name for the specified locale and returns it as an input stream.<a name="line.78"></a> 079 *<a name="line.79"></a> 080 * @param name Name of the desired resource.<a name="line.80"></a> 081 * @param locale The locale. Can be <jk>null</jk>.<a name="line.81"></a> 082 * @return An input stream to the object, or <jk>null</jk> if the resource could not be found.<a name="line.82"></a> 083 * @throws IOException<a name="line.83"></a> 084 */<a name="line.84"></a> 085 public InputStream getStream(String name, Locale locale) throws IOException {<a name="line.85"></a> 086 return getStream(baseClass, name, locale);<a name="line.86"></a> 087 }<a name="line.87"></a> 088<a name="line.88"></a> 089 /**<a name="line.89"></a> 090 * Finds the resource with the given name for the specified locale and returns it as an input stream.<a name="line.90"></a> 091 *<a name="line.91"></a> 092 * @param baseClass<a name="line.92"></a> 093 * Overrides the default class to use for retrieving the classpath resource.<a name="line.93"></a> 094 * If <jk>null<jk>, uses the base class passed in through the constructor of this class.<a name="line.94"></a> 095 * @param name Name of the desired resource.<a name="line.95"></a> 096 * @param locale The locale. Can be <jk>null</jk>.<a name="line.96"></a> 097 * @return An input stream to the object, or <jk>null</jk> if the resource could not be found.<a name="line.97"></a> 098 * @throws IOException<a name="line.98"></a> 099 */<a name="line.99"></a> 100 public InputStream getStream(Class<?> baseClass, String name, Locale locale) throws IOException {<a name="line.100"></a> 101<a name="line.101"></a> 102 if (baseClass == null)<a name="line.102"></a> 103 baseClass = this.baseClass;<a name="line.103"></a> 104<a name="line.104"></a> 105 if (! useCache)<a name="line.105"></a> 106 return resourceFinder.findResource(baseClass, name, locale);<a name="line.106"></a> 107<a name="line.107"></a> 108 ResourceKey key = new ResourceKey(name, locale);<a name="line.108"></a> 109<a name="line.109"></a> 110 byte[] r = byteCache.get(key);<a name="line.110"></a> 111 if (r == null) {<a name="line.111"></a> 112 try (InputStream is = resourceFinder.findResource(baseClass, name, locale)) {<a name="line.112"></a> 113 if (is != null)<a name="line.113"></a> 114 byteCache.putIfAbsent(key, IOUtils.readBytes(is, 1024));<a name="line.114"></a> 115 }<a name="line.115"></a> 116 }<a name="line.116"></a> 117<a name="line.117"></a> 118 r = byteCache.get(key);<a name="line.118"></a> 119 return r == null ? null : new ByteArrayInputStream(r);<a name="line.119"></a> 120 }<a name="line.120"></a> 121<a name="line.121"></a> 122 /**<a name="line.122"></a> 123 * Finds the resource with the given name and converts it to a simple string.<a name="line.123"></a> 124 *<a name="line.124"></a> 125 * @param name Name of the desired resource.<a name="line.125"></a> 126 * @return The resource converted to a string, or <jk>null</jk> if the resource could not be found.<a name="line.126"></a> 127 * @throws IOException<a name="line.127"></a> 128 */<a name="line.128"></a> 129 public String getString(String name) throws IOException {<a name="line.129"></a> 130 return getString(baseClass, name, null);<a name="line.130"></a> 131 }<a name="line.131"></a> 132<a name="line.132"></a> 133 /**<a name="line.133"></a> 134 * Finds the resource with the given name and converts it to a simple string.<a name="line.134"></a> 135 *<a name="line.135"></a> 136 * @param baseClass<a name="line.136"></a> 137 * Overrides the default class to use for retrieving the classpath resource.<a name="line.137"></a> 138 * If <jk>null<jk>, uses the base class passed in through the constructor of this class.<a name="line.138"></a> 139 * @param name Name of the desired resource.<a name="line.139"></a> 140 * @return The resource converted to a string, or <jk>null</jk> if the resource could not be found.<a name="line.140"></a> 141 * @throws IOException<a name="line.141"></a> 142 */<a name="line.142"></a> 143 public String getString(Class<?> baseClass, String name) throws IOException {<a name="line.143"></a> 144 return getString(baseClass, name, null);<a name="line.144"></a> 145 }<a name="line.145"></a> 146<a name="line.146"></a> 147 /**<a name="line.147"></a> 148 * Finds the resource with the given name and converts it to a simple string.<a name="line.148"></a> 149 *<a name="line.149"></a> 150 * @param name Name of the desired resource.<a name="line.150"></a> 151 * @param locale The locale. Can be <jk>null</jk>.<a name="line.151"></a> 152 * @return The resource converted to a string, or <jk>null</jk> if the resource could not be found.<a name="line.152"></a> 153 * @throws IOException<a name="line.153"></a> 154 */<a name="line.154"></a> 155 public String getString(String name, Locale locale) throws IOException {<a name="line.155"></a> 156 return getString(baseClass, name, locale);<a name="line.156"></a> 157 }<a name="line.157"></a> 158<a name="line.158"></a> 159 /**<a name="line.159"></a> 160 * Finds the resource with the given name and converts it to a simple string.<a name="line.160"></a> 161 *<a name="line.161"></a> 162 * @param baseClass<a name="line.162"></a> 163 * Overrides the default class to use for retrieving the classpath resource.<a name="line.163"></a> 164 * If <jk>null<jk>, uses the base class passed in through the constructor of this class.<a name="line.164"></a> 165 * @param name Name of the desired resource.<a name="line.165"></a> 166 * @param locale The locale. Can be <jk>null</jk>.<a name="line.166"></a> 167 * @return The resource converted to a string, or <jk>null</jk> if the resource could not be found.<a name="line.167"></a> 168 * @throws IOException<a name="line.168"></a> 169 */<a name="line.169"></a> 170 public String getString(Class<?> baseClass, String name, Locale locale) throws IOException {<a name="line.170"></a> 171<a name="line.171"></a> 172 if (baseClass == null)<a name="line.172"></a> 173 baseClass = this.baseClass;<a name="line.173"></a> 174<a name="line.174"></a> 175 if (! useCache) {<a name="line.175"></a> 176 try (InputStream is = resourceFinder.findResource(baseClass, name, locale)) {<a name="line.176"></a> 177 return IOUtils.read(is, IOUtils.UTF8);<a name="line.177"></a> 178 }<a name="line.178"></a> 179 }<a name="line.179"></a> 180<a name="line.180"></a> 181 ResourceKey key = new ResourceKey(name, locale);<a name="line.181"></a> 182<a name="line.182"></a> 183 String r = stringCache.get(key);<a name="line.183"></a> 184 if (r == null) {<a name="line.184"></a> 185 try (InputStream is = resourceFinder.findResource(baseClass, name, locale)) {<a name="line.185"></a> 186 if (is != null)<a name="line.186"></a> 187 stringCache.putIfAbsent(key, IOUtils.read(is, IOUtils.UTF8));<a name="line.187"></a> 188 }<a name="line.188"></a> 189 }<a name="line.189"></a> 190<a name="line.190"></a> 191 return stringCache.get(key);<a name="line.191"></a> 192 }<a name="line.192"></a> 193<a name="line.193"></a> 194 private class ResourceKey {<a name="line.194"></a> 195 final String name;<a name="line.195"></a> 196 final Locale locale;<a name="line.196"></a> 197<a name="line.197"></a> 198 ResourceKey(String name, Locale locale) {<a name="line.198"></a> 199 this.name = name;<a name="line.199"></a> 200 this.locale = locale;<a name="line.200"></a> 201 }<a name="line.201"></a> 202<a name="line.202"></a> 203 @Override<a name="line.203"></a> 204 public int hashCode() {<a name="line.204"></a> 205 return name.hashCode() + (locale == null ? 0 : locale.hashCode());<a name="line.205"></a> 206 }<a name="line.206"></a> 207<a name="line.207"></a> 208 @Override<a name="line.208"></a> 209 public boolean equals(Object o) {<a name="line.209"></a> 210 if (o == null)<a name="line.210"></a> 211 return false;<a name="line.211"></a> 212 ResourceKey ok = (ResourceKey)o;<a name="line.212"></a> 213 return ObjectUtils.equals(name, ok.name) && ObjectUtils.equals(locale, ok.locale);<a name="line.213"></a> 214 }<a name="line.214"></a> 215 }<a name="line.215"></a> 216}<a name="line.216"></a> </pre> </div> </body> </html>

content/site/apidocs-8.0.0/src-html/org/apache/juneau/utils/ClasspathResourceManager.html (228 lines of code) (raw):