| <HTML> |
| <BODY BGCOLOR="white"> |
| <PRE> |
| <FONT color="green">001</FONT> /*<a name="line.1"></a> |
| <FONT color="green">002</FONT> * Licensed to the Apache Software Foundation (ASF) under one<a name="line.2"></a> |
| <FONT color="green">003</FONT> * or more contributor license agreements. See the NOTICE file<a name="line.3"></a> |
| <FONT color="green">004</FONT> * distributed with this work for additional information<a name="line.4"></a> |
| <FONT color="green">005</FONT> * regarding copyright ownership. The ASF licenses this file<a name="line.5"></a> |
| <FONT color="green">006</FONT> * to you under the Apache License, Version 2.0 (the<a name="line.6"></a> |
| <FONT color="green">007</FONT> * "License"); you may not use this file except in compliance<a name="line.7"></a> |
| <FONT color="green">008</FONT> * with the License. You may obtain a copy of the License at<a name="line.8"></a> |
| <FONT color="green">009</FONT> *<a name="line.9"></a> |
| <FONT color="green">010</FONT> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.10"></a> |
| <FONT color="green">011</FONT> *<a name="line.11"></a> |
| <FONT color="green">012</FONT> * Unless required by applicable law or agreed to in writing,<a name="line.12"></a> |
| <FONT color="green">013</FONT> * software distributed under the License is distributed on an<a name="line.13"></a> |
| <FONT color="green">014</FONT> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY<a name="line.14"></a> |
| <FONT color="green">015</FONT> * KIND, either express or implied. See the License for the<a name="line.15"></a> |
| <FONT color="green">016</FONT> * specific language governing permissions and limitations<a name="line.16"></a> |
| <FONT color="green">017</FONT> * under the License.<a name="line.17"></a> |
| <FONT color="green">018</FONT> */<a name="line.18"></a> |
| <FONT color="green">019</FONT> package org.apache.shiro.io;<a name="line.19"></a> |
| <FONT color="green">020</FONT> <a name="line.20"></a> |
| <FONT color="green">021</FONT> import org.apache.shiro.util.ClassUtils;<a name="line.21"></a> |
| <FONT color="green">022</FONT> import org.slf4j.Logger;<a name="line.22"></a> |
| <FONT color="green">023</FONT> import org.slf4j.LoggerFactory;<a name="line.23"></a> |
| <FONT color="green">024</FONT> <a name="line.24"></a> |
| <FONT color="green">025</FONT> import java.io.FileInputStream;<a name="line.25"></a> |
| <FONT color="green">026</FONT> import java.io.IOException;<a name="line.26"></a> |
| <FONT color="green">027</FONT> import java.io.InputStream;<a name="line.27"></a> |
| <FONT color="green">028</FONT> import java.net.URL;<a name="line.28"></a> |
| <FONT color="green">029</FONT> <a name="line.29"></a> |
| <FONT color="green">030</FONT> /**<a name="line.30"></a> |
| <FONT color="green">031</FONT> * Static helper methods for loading {@code Stream}-backed resources.<a name="line.31"></a> |
| <FONT color="green">032</FONT> *<a name="line.32"></a> |
| <FONT color="green">033</FONT> * @see #getInputStreamForPath(String)<a name="line.33"></a> |
| <FONT color="green">034</FONT> * @since 0.2<a name="line.34"></a> |
| <FONT color="green">035</FONT> */<a name="line.35"></a> |
| <FONT color="green">036</FONT> public class ResourceUtils {<a name="line.36"></a> |
| <FONT color="green">037</FONT> <a name="line.37"></a> |
| <FONT color="green">038</FONT> /**<a name="line.38"></a> |
| <FONT color="green">039</FONT> * Resource path prefix that specifies to load from a classpath location, value is <b>{@code classpath:}</b><a name="line.39"></a> |
| <FONT color="green">040</FONT> */<a name="line.40"></a> |
| <FONT color="green">041</FONT> public static final String CLASSPATH_PREFIX = "classpath:";<a name="line.41"></a> |
| <FONT color="green">042</FONT> /**<a name="line.42"></a> |
| <FONT color="green">043</FONT> * Resource path prefix that specifies to load from a url location, value is <b>{@code url:}</b><a name="line.43"></a> |
| <FONT color="green">044</FONT> */<a name="line.44"></a> |
| <FONT color="green">045</FONT> public static final String URL_PREFIX = "url:";<a name="line.45"></a> |
| <FONT color="green">046</FONT> /**<a name="line.46"></a> |
| <FONT color="green">047</FONT> * Resource path prefix that specifies to load from a file location, value is <b>{@code file:}</b><a name="line.47"></a> |
| <FONT color="green">048</FONT> */<a name="line.48"></a> |
| <FONT color="green">049</FONT> public static final String FILE_PREFIX = "file:";<a name="line.49"></a> |
| <FONT color="green">050</FONT> <a name="line.50"></a> |
| <FONT color="green">051</FONT> /**<a name="line.51"></a> |
| <FONT color="green">052</FONT> * Private internal log instance.<a name="line.52"></a> |
| <FONT color="green">053</FONT> */<a name="line.53"></a> |
| <FONT color="green">054</FONT> private static final Logger log = LoggerFactory.getLogger(ResourceUtils.class);<a name="line.54"></a> |
| <FONT color="green">055</FONT> <a name="line.55"></a> |
| <FONT color="green">056</FONT> /**<a name="line.56"></a> |
| <FONT color="green">057</FONT> * Prevent instantiation.<a name="line.57"></a> |
| <FONT color="green">058</FONT> */<a name="line.58"></a> |
| <FONT color="green">059</FONT> private ResourceUtils() {<a name="line.59"></a> |
| <FONT color="green">060</FONT> }<a name="line.60"></a> |
| <FONT color="green">061</FONT> <a name="line.61"></a> |
| <FONT color="green">062</FONT> /**<a name="line.62"></a> |
| <FONT color="green">063</FONT> * Returns {@code true} if the resource path is not null and starts with one of the recognized<a name="line.63"></a> |
| <FONT color="green">064</FONT> * resource prefixes ({@link #CLASSPATH_PREFIX CLASSPATH_PREFIX},<a name="line.64"></a> |
| <FONT color="green">065</FONT> * {@link #URL_PREFIX URL_PREFIX}, or {@link #FILE_PREFIX FILE_PREFIX}), {@code false} otherwise.<a name="line.65"></a> |
| <FONT color="green">066</FONT> *<a name="line.66"></a> |
| <FONT color="green">067</FONT> * @param resourcePath the resource path to check<a name="line.67"></a> |
| <FONT color="green">068</FONT> * @return {@code true} if the resource path is not null and starts with one of the recognized<a name="line.68"></a> |
| <FONT color="green">069</FONT> * resource prefixes, {@code false} otherwise.<a name="line.69"></a> |
| <FONT color="green">070</FONT> * @since 0.9<a name="line.70"></a> |
| <FONT color="green">071</FONT> */<a name="line.71"></a> |
| <FONT color="green">072</FONT> @SuppressWarnings({"UnusedDeclaration"})<a name="line.72"></a> |
| <FONT color="green">073</FONT> public static boolean hasResourcePrefix(String resourcePath) {<a name="line.73"></a> |
| <FONT color="green">074</FONT> return resourcePath != null &&<a name="line.74"></a> |
| <FONT color="green">075</FONT> (resourcePath.startsWith(CLASSPATH_PREFIX) ||<a name="line.75"></a> |
| <FONT color="green">076</FONT> resourcePath.startsWith(URL_PREFIX) ||<a name="line.76"></a> |
| <FONT color="green">077</FONT> resourcePath.startsWith(FILE_PREFIX));<a name="line.77"></a> |
| <FONT color="green">078</FONT> }<a name="line.78"></a> |
| <FONT color="green">079</FONT> <a name="line.79"></a> |
| <FONT color="green">080</FONT> /**<a name="line.80"></a> |
| <FONT color="green">081</FONT> * Returns {@code true} if the resource at the specified path exists, {@code false} otherwise. This<a name="line.81"></a> |
| <FONT color="green">082</FONT> * method supports scheme prefixes on the path as defined in {@link #getInputStreamForPath(String)}.<a name="line.82"></a> |
| <FONT color="green">083</FONT> *<a name="line.83"></a> |
| <FONT color="green">084</FONT> * @param resourcePath the path of the resource to check.<a name="line.84"></a> |
| <FONT color="green">085</FONT> * @return {@code true} if the resource at the specified path exists, {@code false} otherwise.<a name="line.85"></a> |
| <FONT color="green">086</FONT> * @since 0.9<a name="line.86"></a> |
| <FONT color="green">087</FONT> */<a name="line.87"></a> |
| <FONT color="green">088</FONT> public static boolean resourceExists(String resourcePath) {<a name="line.88"></a> |
| <FONT color="green">089</FONT> InputStream stream = null;<a name="line.89"></a> |
| <FONT color="green">090</FONT> boolean exists = false;<a name="line.90"></a> |
| <FONT color="green">091</FONT> <a name="line.91"></a> |
| <FONT color="green">092</FONT> try {<a name="line.92"></a> |
| <FONT color="green">093</FONT> stream = getInputStreamForPath(resourcePath);<a name="line.93"></a> |
| <FONT color="green">094</FONT> exists = true;<a name="line.94"></a> |
| <FONT color="green">095</FONT> } catch (IOException e) {<a name="line.95"></a> |
| <FONT color="green">096</FONT> stream = null;<a name="line.96"></a> |
| <FONT color="green">097</FONT> } finally {<a name="line.97"></a> |
| <FONT color="green">098</FONT> if (stream != null) {<a name="line.98"></a> |
| <FONT color="green">099</FONT> try {<a name="line.99"></a> |
| <FONT color="green">100</FONT> stream.close();<a name="line.100"></a> |
| <FONT color="green">101</FONT> } catch (IOException ignored) {<a name="line.101"></a> |
| <FONT color="green">102</FONT> }<a name="line.102"></a> |
| <FONT color="green">103</FONT> }<a name="line.103"></a> |
| <FONT color="green">104</FONT> }<a name="line.104"></a> |
| <FONT color="green">105</FONT> <a name="line.105"></a> |
| <FONT color="green">106</FONT> return exists;<a name="line.106"></a> |
| <FONT color="green">107</FONT> }<a name="line.107"></a> |
| <FONT color="green">108</FONT> <a name="line.108"></a> |
| <FONT color="green">109</FONT> <a name="line.109"></a> |
| <FONT color="green">110</FONT> /**<a name="line.110"></a> |
| <FONT color="green">111</FONT> * Returns the InputStream for the resource represented by the specified path, supporting scheme<a name="line.111"></a> |
| <FONT color="green">112</FONT> * prefixes that direct how to acquire the input stream<a name="line.112"></a> |
| <FONT color="green">113</FONT> * ({@link #CLASSPATH_PREFIX CLASSPATH_PREFIX},<a name="line.113"></a> |
| <FONT color="green">114</FONT> * {@link #URL_PREFIX URL_PREFIX}, or {@link #FILE_PREFIX FILE_PREFIX}). If the path is not prefixed by one<a name="line.114"></a> |
| <FONT color="green">115</FONT> * of these schemes, the path is assumed to be a file-based path that can be loaded with a<a name="line.115"></a> |
| <FONT color="green">116</FONT> * {@link FileInputStream FileInputStream}.<a name="line.116"></a> |
| <FONT color="green">117</FONT> *<a name="line.117"></a> |
| <FONT color="green">118</FONT> * @param resourcePath the String path representing the resource to obtain.<a name="line.118"></a> |
| <FONT color="green">119</FONT> * @return the InputStraem for the specified resource.<a name="line.119"></a> |
| <FONT color="green">120</FONT> * @throws IOException if there is a problem acquiring the resource at the specified path.<a name="line.120"></a> |
| <FONT color="green">121</FONT> */<a name="line.121"></a> |
| <FONT color="green">122</FONT> public static InputStream getInputStreamForPath(String resourcePath) throws IOException {<a name="line.122"></a> |
| <FONT color="green">123</FONT> <a name="line.123"></a> |
| <FONT color="green">124</FONT> InputStream is;<a name="line.124"></a> |
| <FONT color="green">125</FONT> if (resourcePath.startsWith(CLASSPATH_PREFIX)) {<a name="line.125"></a> |
| <FONT color="green">126</FONT> is = loadFromClassPath(stripPrefix(resourcePath));<a name="line.126"></a> |
| <FONT color="green">127</FONT> <a name="line.127"></a> |
| <FONT color="green">128</FONT> } else if (resourcePath.startsWith(URL_PREFIX)) {<a name="line.128"></a> |
| <FONT color="green">129</FONT> is = loadFromUrl(stripPrefix(resourcePath));<a name="line.129"></a> |
| <FONT color="green">130</FONT> <a name="line.130"></a> |
| <FONT color="green">131</FONT> } else if (resourcePath.startsWith(FILE_PREFIX)) {<a name="line.131"></a> |
| <FONT color="green">132</FONT> is = loadFromFile(stripPrefix(resourcePath));<a name="line.132"></a> |
| <FONT color="green">133</FONT> <a name="line.133"></a> |
| <FONT color="green">134</FONT> } else {<a name="line.134"></a> |
| <FONT color="green">135</FONT> is = loadFromFile(resourcePath);<a name="line.135"></a> |
| <FONT color="green">136</FONT> }<a name="line.136"></a> |
| <FONT color="green">137</FONT> <a name="line.137"></a> |
| <FONT color="green">138</FONT> if (is == null) {<a name="line.138"></a> |
| <FONT color="green">139</FONT> throw new IOException("Resource [" + resourcePath + "] could not be found.");<a name="line.139"></a> |
| <FONT color="green">140</FONT> }<a name="line.140"></a> |
| <FONT color="green">141</FONT> <a name="line.141"></a> |
| <FONT color="green">142</FONT> return is;<a name="line.142"></a> |
| <FONT color="green">143</FONT> }<a name="line.143"></a> |
| <FONT color="green">144</FONT> <a name="line.144"></a> |
| <FONT color="green">145</FONT> private static InputStream loadFromFile(String path) throws IOException {<a name="line.145"></a> |
| <FONT color="green">146</FONT> if (log.isDebugEnabled()) {<a name="line.146"></a> |
| <FONT color="green">147</FONT> log.debug("Opening file [" + path + "]...");<a name="line.147"></a> |
| <FONT color="green">148</FONT> }<a name="line.148"></a> |
| <FONT color="green">149</FONT> return new FileInputStream(path);<a name="line.149"></a> |
| <FONT color="green">150</FONT> }<a name="line.150"></a> |
| <FONT color="green">151</FONT> <a name="line.151"></a> |
| <FONT color="green">152</FONT> private static InputStream loadFromUrl(String urlPath) throws IOException {<a name="line.152"></a> |
| <FONT color="green">153</FONT> log.debug("Opening url {}", urlPath);<a name="line.153"></a> |
| <FONT color="green">154</FONT> URL url = new URL(urlPath);<a name="line.154"></a> |
| <FONT color="green">155</FONT> return url.openStream();<a name="line.155"></a> |
| <FONT color="green">156</FONT> }<a name="line.156"></a> |
| <FONT color="green">157</FONT> <a name="line.157"></a> |
| <FONT color="green">158</FONT> private static InputStream loadFromClassPath(String path) {<a name="line.158"></a> |
| <FONT color="green">159</FONT> log.debug("Opening resource from class path [{}]", path);<a name="line.159"></a> |
| <FONT color="green">160</FONT> return ClassUtils.getResourceAsStream(path);<a name="line.160"></a> |
| <FONT color="green">161</FONT> }<a name="line.161"></a> |
| <FONT color="green">162</FONT> <a name="line.162"></a> |
| <FONT color="green">163</FONT> private static String stripPrefix(String resourcePath) {<a name="line.163"></a> |
| <FONT color="green">164</FONT> return resourcePath.substring(resourcePath.indexOf(":") + 1);<a name="line.164"></a> |
| <FONT color="green">165</FONT> }<a name="line.165"></a> |
| <FONT color="green">166</FONT> <a name="line.166"></a> |
| <FONT color="green">167</FONT> /**<a name="line.167"></a> |
| <FONT color="green">168</FONT> * Convenience method that closes the specified {@link InputStream InputStream}, logging any<a name="line.168"></a> |
| <FONT color="green">169</FONT> * {@link IOException IOException} that might occur. If the {@code InputStream}<a name="line.169"></a> |
| <FONT color="green">170</FONT> * argument is {@code null}, this method does nothing. It returns quietly in all cases.<a name="line.170"></a> |
| <FONT color="green">171</FONT> *<a name="line.171"></a> |
| <FONT color="green">172</FONT> * @param is the {@code InputStream} to close, logging any {@code IOException} that might occur.<a name="line.172"></a> |
| <FONT color="green">173</FONT> */<a name="line.173"></a> |
| <FONT color="green">174</FONT> public static void close(InputStream is) {<a name="line.174"></a> |
| <FONT color="green">175</FONT> if (is != null) {<a name="line.175"></a> |
| <FONT color="green">176</FONT> try {<a name="line.176"></a> |
| <FONT color="green">177</FONT> is.close();<a name="line.177"></a> |
| <FONT color="green">178</FONT> } catch (IOException e) {<a name="line.178"></a> |
| <FONT color="green">179</FONT> log.warn("Error closing input stream.", e);<a name="line.179"></a> |
| <FONT color="green">180</FONT> }<a name="line.180"></a> |
| <FONT color="green">181</FONT> }<a name="line.181"></a> |
| <FONT color="green">182</FONT> }<a name="line.182"></a> |
| <FONT color="green">183</FONT> }<a name="line.183"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </PRE> |
| </BODY> |
| </HTML> |
