| <!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.util;<a name="line.19"></a> |
| <span class="sourceLineNo">020</span><a name="line.20"></a> |
| <span class="sourceLineNo">021</span>import java.io.File;<a name="line.21"></a> |
| <span class="sourceLineNo">022</span>import java.io.InputStream;<a name="line.22"></a> |
| <span class="sourceLineNo">023</span><a name="line.23"></a> |
| <span class="sourceLineNo">024</span>/**<a name="line.24"></a> |
| <span class="sourceLineNo">025</span> * A {@code ByteSource} wraps a byte array and provides additional encoding operations. Most users will find the<a name="line.25"></a> |
| <span class="sourceLineNo">026</span> * {@link Util} inner class sufficient to construct ByteSource instances.<a name="line.26"></a> |
| <span class="sourceLineNo">027</span> *<a name="line.27"></a> |
| <span class="sourceLineNo">028</span> * @since 1.0<a name="line.28"></a> |
| <span class="sourceLineNo">029</span> */<a name="line.29"></a> |
| <span class="sourceLineNo">030</span>public interface ByteSource {<a name="line.30"></a> |
| <span class="sourceLineNo">031</span><a name="line.31"></a> |
| <span class="sourceLineNo">032</span> /**<a name="line.32"></a> |
| <span class="sourceLineNo">033</span> * Returns the wrapped byte array.<a name="line.33"></a> |
| <span class="sourceLineNo">034</span> *<a name="line.34"></a> |
| <span class="sourceLineNo">035</span> * @return the wrapped byte array.<a name="line.35"></a> |
| <span class="sourceLineNo">036</span> */<a name="line.36"></a> |
| <span class="sourceLineNo">037</span> byte[] getBytes();<a name="line.37"></a> |
| <span class="sourceLineNo">038</span><a name="line.38"></a> |
| <span class="sourceLineNo">039</span> /**<a name="line.39"></a> |
| <span class="sourceLineNo">040</span> * Returns the <a href="http://en.wikipedia.org/wiki/Hexadecimal">Hex</a>-formatted String representation of the<a name="line.40"></a> |
| <span class="sourceLineNo">041</span> * underlying wrapped byte array.<a name="line.41"></a> |
| <span class="sourceLineNo">042</span> *<a name="line.42"></a> |
| <span class="sourceLineNo">043</span> * @return the <a href="http://en.wikipedia.org/wiki/Hexadecimal">Hex</a>-formatted String representation of the<a name="line.43"></a> |
| <span class="sourceLineNo">044</span> * underlying wrapped byte array.<a name="line.44"></a> |
| <span class="sourceLineNo">045</span> */<a name="line.45"></a> |
| <span class="sourceLineNo">046</span> String toHex();<a name="line.46"></a> |
| <span class="sourceLineNo">047</span><a name="line.47"></a> |
| <span class="sourceLineNo">048</span> /**<a name="line.48"></a> |
| <span class="sourceLineNo">049</span> * Returns the <a href="http://en.wikipedia.org/wiki/Base64">Base 64</a>-formatted String representation of the<a name="line.49"></a> |
| <span class="sourceLineNo">050</span> * underlying wrapped byte array.<a name="line.50"></a> |
| <span class="sourceLineNo">051</span> *<a name="line.51"></a> |
| <span class="sourceLineNo">052</span> * @return the <a href="http://en.wikipedia.org/wiki/Base64">Base 64</a>-formatted String representation of the<a name="line.52"></a> |
| <span class="sourceLineNo">053</span> * underlying wrapped byte array.<a name="line.53"></a> |
| <span class="sourceLineNo">054</span> */<a name="line.54"></a> |
| <span class="sourceLineNo">055</span> String toBase64();<a name="line.55"></a> |
| <span class="sourceLineNo">056</span><a name="line.56"></a> |
| <span class="sourceLineNo">057</span> /**<a name="line.57"></a> |
| <span class="sourceLineNo">058</span> * Returns {@code true} if the underlying wrapped byte array is null or empty (zero length), {@code false}<a name="line.58"></a> |
| <span class="sourceLineNo">059</span> * otherwise.<a name="line.59"></a> |
| <span class="sourceLineNo">060</span> *<a name="line.60"></a> |
| <span class="sourceLineNo">061</span> * @return {@code true} if the underlying wrapped byte array is null or empty (zero length), {@code false}<a name="line.61"></a> |
| <span class="sourceLineNo">062</span> * otherwise.<a name="line.62"></a> |
| <span class="sourceLineNo">063</span> * @since 1.2<a name="line.63"></a> |
| <span class="sourceLineNo">064</span> */<a name="line.64"></a> |
| <span class="sourceLineNo">065</span> boolean isEmpty();<a name="line.65"></a> |
| <span class="sourceLineNo">066</span><a name="line.66"></a> |
| <span class="sourceLineNo">067</span> /**<a name="line.67"></a> |
| <span class="sourceLineNo">068</span> * Utility class that can construct ByteSource instances. This is slightly nicer than needing to know the<a name="line.68"></a> |
| <span class="sourceLineNo">069</span> * {@code ByteSource} implementation class to use.<a name="line.69"></a> |
| <span class="sourceLineNo">070</span> *<a name="line.70"></a> |
| <span class="sourceLineNo">071</span> * @since 1.2<a name="line.71"></a> |
| <span class="sourceLineNo">072</span> */<a name="line.72"></a> |
| <span class="sourceLineNo">073</span> public static final class Util {<a name="line.73"></a> |
| <span class="sourceLineNo">074</span><a name="line.74"></a> |
| <span class="sourceLineNo">075</span> /**<a name="line.75"></a> |
| <span class="sourceLineNo">076</span> * Returns a new {@code ByteSource} instance representing the specified byte array.<a name="line.76"></a> |
| <span class="sourceLineNo">077</span> *<a name="line.77"></a> |
| <span class="sourceLineNo">078</span> * @param bytes the bytes to represent as a {@code ByteSource} instance.<a name="line.78"></a> |
| <span class="sourceLineNo">079</span> * @return a new {@code ByteSource} instance representing the specified byte array.<a name="line.79"></a> |
| <span class="sourceLineNo">080</span> */<a name="line.80"></a> |
| <span class="sourceLineNo">081</span> public static ByteSource bytes(byte[] bytes) {<a name="line.81"></a> |
| <span class="sourceLineNo">082</span> return new SimpleByteSource(bytes);<a name="line.82"></a> |
| <span class="sourceLineNo">083</span> }<a name="line.83"></a> |
| <span class="sourceLineNo">084</span><a name="line.84"></a> |
| <span class="sourceLineNo">085</span> /**<a name="line.85"></a> |
| <span class="sourceLineNo">086</span> * Returns a new {@code ByteSource} instance representing the specified character array's bytes. The byte<a name="line.86"></a> |
| <span class="sourceLineNo">087</span> * array is obtained assuming {@code UTF-8} encoding.<a name="line.87"></a> |
| <span class="sourceLineNo">088</span> *<a name="line.88"></a> |
| <span class="sourceLineNo">089</span> * @param chars the character array to represent as a {@code ByteSource} instance.<a name="line.89"></a> |
| <span class="sourceLineNo">090</span> * @return a new {@code ByteSource} instance representing the specified character array's bytes.<a name="line.90"></a> |
| <span class="sourceLineNo">091</span> */<a name="line.91"></a> |
| <span class="sourceLineNo">092</span> public static ByteSource bytes(char[] chars) {<a name="line.92"></a> |
| <span class="sourceLineNo">093</span> return new SimpleByteSource(chars);<a name="line.93"></a> |
| <span class="sourceLineNo">094</span> }<a name="line.94"></a> |
| <span class="sourceLineNo">095</span><a name="line.95"></a> |
| <span class="sourceLineNo">096</span> /**<a name="line.96"></a> |
| <span class="sourceLineNo">097</span> * Returns a new {@code ByteSource} instance representing the specified string's bytes. The byte<a name="line.97"></a> |
| <span class="sourceLineNo">098</span> * array is obtained assuming {@code UTF-8} encoding.<a name="line.98"></a> |
| <span class="sourceLineNo">099</span> *<a name="line.99"></a> |
| <span class="sourceLineNo">100</span> * @param string the string to represent as a {@code ByteSource} instance.<a name="line.100"></a> |
| <span class="sourceLineNo">101</span> * @return a new {@code ByteSource} instance representing the specified string's bytes.<a name="line.101"></a> |
| <span class="sourceLineNo">102</span> */<a name="line.102"></a> |
| <span class="sourceLineNo">103</span> public static ByteSource bytes(String string) {<a name="line.103"></a> |
| <span class="sourceLineNo">104</span> return new SimpleByteSource(string);<a name="line.104"></a> |
| <span class="sourceLineNo">105</span> }<a name="line.105"></a> |
| <span class="sourceLineNo">106</span><a name="line.106"></a> |
| <span class="sourceLineNo">107</span> /**<a name="line.107"></a> |
| <span class="sourceLineNo">108</span> * Returns a new {@code ByteSource} instance representing the specified ByteSource.<a name="line.108"></a> |
| <span class="sourceLineNo">109</span> *<a name="line.109"></a> |
| <span class="sourceLineNo">110</span> * @param source the ByteSource to represent as a new {@code ByteSource} instance.<a name="line.110"></a> |
| <span class="sourceLineNo">111</span> * @return a new {@code ByteSource} instance representing the specified ByteSource.<a name="line.111"></a> |
| <span class="sourceLineNo">112</span> */<a name="line.112"></a> |
| <span class="sourceLineNo">113</span> public static ByteSource bytes(ByteSource source) {<a name="line.113"></a> |
| <span class="sourceLineNo">114</span> return new SimpleByteSource(source);<a name="line.114"></a> |
| <span class="sourceLineNo">115</span> }<a name="line.115"></a> |
| <span class="sourceLineNo">116</span><a name="line.116"></a> |
| <span class="sourceLineNo">117</span> /**<a name="line.117"></a> |
| <span class="sourceLineNo">118</span> * Returns a new {@code ByteSource} instance representing the specified File's bytes.<a name="line.118"></a> |
| <span class="sourceLineNo">119</span> *<a name="line.119"></a> |
| <span class="sourceLineNo">120</span> * @param file the file to represent as a {@code ByteSource} instance.<a name="line.120"></a> |
| <span class="sourceLineNo">121</span> * @return a new {@code ByteSource} instance representing the specified File's bytes.<a name="line.121"></a> |
| <span class="sourceLineNo">122</span> */<a name="line.122"></a> |
| <span class="sourceLineNo">123</span> public static ByteSource bytes(File file) {<a name="line.123"></a> |
| <span class="sourceLineNo">124</span> return new SimpleByteSource(file);<a name="line.124"></a> |
| <span class="sourceLineNo">125</span> }<a name="line.125"></a> |
| <span class="sourceLineNo">126</span><a name="line.126"></a> |
| <span class="sourceLineNo">127</span> /**<a name="line.127"></a> |
| <span class="sourceLineNo">128</span> * Returns a new {@code ByteSource} instance representing the specified InputStream's bytes.<a name="line.128"></a> |
| <span class="sourceLineNo">129</span> *<a name="line.129"></a> |
| <span class="sourceLineNo">130</span> * @param stream the InputStream to represent as a {@code ByteSource} instance.<a name="line.130"></a> |
| <span class="sourceLineNo">131</span> * @return a new {@code ByteSource} instance representing the specified InputStream's bytes.<a name="line.131"></a> |
| <span class="sourceLineNo">132</span> */<a name="line.132"></a> |
| <span class="sourceLineNo">133</span> public static ByteSource bytes(InputStream stream) {<a name="line.133"></a> |
| <span class="sourceLineNo">134</span> return new SimpleByteSource(stream);<a name="line.134"></a> |
| <span class="sourceLineNo">135</span> }<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> * Returns {@code true} if the specified object can be easily represented as a {@code ByteSource} using<a name="line.138"></a> |
| <span class="sourceLineNo">139</span> * the {@link ByteSource.Util}'s default heuristics, {@code false} otherwise.<a name="line.139"></a> |
| <span class="sourceLineNo">140</span> * <p/><a name="line.140"></a> |
| <span class="sourceLineNo">141</span> * This implementation merely returns {@link SimpleByteSource}.{@link SimpleByteSource#isCompatible(Object) isCompatible(source)}.<a name="line.141"></a> |
| <span class="sourceLineNo">142</span> *<a name="line.142"></a> |
| <span class="sourceLineNo">143</span> * @param source the object to test to see if it can be easily converted to ByteSource instances using default<a name="line.143"></a> |
| <span class="sourceLineNo">144</span> * heuristics.<a name="line.144"></a> |
| <span class="sourceLineNo">145</span> * @return {@code true} if the specified object can be easily represented as a {@code ByteSource} using<a name="line.145"></a> |
| <span class="sourceLineNo">146</span> * the {@link ByteSource.Util}'s default heuristics, {@code false} otherwise.<a name="line.146"></a> |
| <span class="sourceLineNo">147</span> */<a name="line.147"></a> |
| <span class="sourceLineNo">148</span> public static boolean isCompatible(Object source) {<a name="line.148"></a> |
| <span class="sourceLineNo">149</span> return SimpleByteSource.isCompatible(source);<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> /**<a name="line.152"></a> |
| <span class="sourceLineNo">153</span> * Returns a {@code ByteSource} instance representing the specified byte source argument. If the argument<a name="line.153"></a> |
| <span class="sourceLineNo">154</span> * <em>cannot</em> be easily converted to bytes (as is indicated by the {@link #isCompatible(Object)} JavaDoc),<a name="line.154"></a> |
| <span class="sourceLineNo">155</span> * this method will throw an {@link IllegalArgumentException}.<a name="line.155"></a> |
| <span class="sourceLineNo">156</span> *<a name="line.156"></a> |
| <span class="sourceLineNo">157</span> * @param source the byte-backed instance that should be represented as a {@code ByteSource} instance.<a name="line.157"></a> |
| <span class="sourceLineNo">158</span> * @return a {@code ByteSource} instance representing the specified byte source argument.<a name="line.158"></a> |
| <span class="sourceLineNo">159</span> * @throws IllegalArgumentException if the argument <em>cannot</em> be easily converted to bytes<a name="line.159"></a> |
| <span class="sourceLineNo">160</span> * (as indicated by the {@link #isCompatible(Object)} JavaDoc)<a name="line.160"></a> |
| <span class="sourceLineNo">161</span> */<a name="line.161"></a> |
| <span class="sourceLineNo">162</span> public static ByteSource bytes(Object source) throws IllegalArgumentException {<a name="line.162"></a> |
| <span class="sourceLineNo">163</span> if (source == null) {<a name="line.163"></a> |
| <span class="sourceLineNo">164</span> return null;<a name="line.164"></a> |
| <span class="sourceLineNo">165</span> }<a name="line.165"></a> |
| <span class="sourceLineNo">166</span> if (!isCompatible(source)) {<a name="line.166"></a> |
| <span class="sourceLineNo">167</span> String msg = "Unable to heuristically acquire bytes for object of type [" +<a name="line.167"></a> |
| <span class="sourceLineNo">168</span> source.getClass().getName() + "]. If this type is indeed a byte-backed data type, you might " +<a name="line.168"></a> |
| <span class="sourceLineNo">169</span> "want to write your own ByteSource implementation to extract its bytes explicitly.";<a name="line.169"></a> |
| <span class="sourceLineNo">170</span> throw new IllegalArgumentException(msg);<a name="line.170"></a> |
| <span class="sourceLineNo">171</span> }<a name="line.171"></a> |
| <span class="sourceLineNo">172</span> if (source instanceof byte[]) {<a name="line.172"></a> |
| <span class="sourceLineNo">173</span> return bytes((byte[]) source);<a name="line.173"></a> |
| <span class="sourceLineNo">174</span> } else if (source instanceof ByteSource) {<a name="line.174"></a> |
| <span class="sourceLineNo">175</span> return (ByteSource) source;<a name="line.175"></a> |
| <span class="sourceLineNo">176</span> } else if (source instanceof char[]) {<a name="line.176"></a> |
| <span class="sourceLineNo">177</span> return bytes((char[]) source);<a name="line.177"></a> |
| <span class="sourceLineNo">178</span> } else if (source instanceof String) {<a name="line.178"></a> |
| <span class="sourceLineNo">179</span> return bytes((String) source);<a name="line.179"></a> |
| <span class="sourceLineNo">180</span> } else if (source instanceof File) {<a name="line.180"></a> |
| <span class="sourceLineNo">181</span> return bytes((File) source);<a name="line.181"></a> |
| <span class="sourceLineNo">182</span> } else if (source instanceof InputStream) {<a name="line.182"></a> |
| <span class="sourceLineNo">183</span> return bytes((InputStream) source);<a name="line.183"></a> |
| <span class="sourceLineNo">184</span> } else {<a name="line.184"></a> |
| <span class="sourceLineNo">185</span> throw new IllegalStateException("Encountered unexpected byte source. This is a bug - please notify " +<a name="line.185"></a> |
| <span class="sourceLineNo">186</span> "the Shiro developer list asap (the isCompatible implementation does not reflect this " +<a name="line.186"></a> |
| <span class="sourceLineNo">187</span> "method's implementation).");<a name="line.187"></a> |
| <span class="sourceLineNo">188</span> }<a name="line.188"></a> |
| <span class="sourceLineNo">189</span> }<a name="line.189"></a> |
| <span class="sourceLineNo">190</span> }<a name="line.190"></a> |
| <span class="sourceLineNo">191</span>}<a name="line.191"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |
