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