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