blob: 2240d085be9f544ed2195e494c396d0bfed96439 [file] [log] [blame]
<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.util;<a name="line.19"></a>
<FONT color="green">020</FONT> <a name="line.20"></a>
<FONT color="green">021</FONT> import org.apache.shiro.codec.Base64;<a name="line.21"></a>
<FONT color="green">022</FONT> import org.apache.shiro.codec.CodecSupport;<a name="line.22"></a>
<FONT color="green">023</FONT> import org.apache.shiro.codec.Hex;<a name="line.23"></a>
<FONT color="green">024</FONT> <a name="line.24"></a>
<FONT color="green">025</FONT> import java.io.File;<a name="line.25"></a>
<FONT color="green">026</FONT> import java.io.InputStream;<a name="line.26"></a>
<FONT color="green">027</FONT> import java.util.Arrays;<a name="line.27"></a>
<FONT color="green">028</FONT> <a name="line.28"></a>
<FONT color="green">029</FONT> /**<a name="line.29"></a>
<FONT color="green">030</FONT> * Very simple {@link ByteSource ByteSource} implementation that maintains an internal {@code byte[]} array and uses the<a name="line.30"></a>
<FONT color="green">031</FONT> * {@link Hex Hex} and {@link Base64 Base64} codec classes to support the<a name="line.31"></a>
<FONT color="green">032</FONT> * {@link #toHex() toHex()} and {@link #toBase64() toBase64()} implementations.<a name="line.32"></a>
<FONT color="green">033</FONT> * &lt;p/&gt;<a name="line.33"></a>
<FONT color="green">034</FONT> * The constructors on this class accept the following implicit byte-backed data types and will convert them to<a name="line.34"></a>
<FONT color="green">035</FONT> * a byte-array automatically:<a name="line.35"></a>
<FONT color="green">036</FONT> * &lt;ul&gt;<a name="line.36"></a>
<FONT color="green">037</FONT> * &lt;li&gt;byte[]&lt;/li&gt;<a name="line.37"></a>
<FONT color="green">038</FONT> * &lt;li&gt;char[]&lt;/li&gt;<a name="line.38"></a>
<FONT color="green">039</FONT> * &lt;li&gt;String&lt;/li&gt;<a name="line.39"></a>
<FONT color="green">040</FONT> * &lt;li&gt;{@link ByteSource ByteSource}&lt;/li&gt;<a name="line.40"></a>
<FONT color="green">041</FONT> * &lt;li&gt;{@link File File}&lt;/li&gt;<a name="line.41"></a>
<FONT color="green">042</FONT> * &lt;li&gt;{@link InputStream InputStream}&lt;/li&gt;<a name="line.42"></a>
<FONT color="green">043</FONT> * &lt;/ul&gt;<a name="line.43"></a>
<FONT color="green">044</FONT> *<a name="line.44"></a>
<FONT color="green">045</FONT> * @since 1.0<a name="line.45"></a>
<FONT color="green">046</FONT> */<a name="line.46"></a>
<FONT color="green">047</FONT> public class SimpleByteSource implements ByteSource {<a name="line.47"></a>
<FONT color="green">048</FONT> <a name="line.48"></a>
<FONT color="green">049</FONT> private final byte[] bytes;<a name="line.49"></a>
<FONT color="green">050</FONT> private String cachedHex;<a name="line.50"></a>
<FONT color="green">051</FONT> private String cachedBase64;<a name="line.51"></a>
<FONT color="green">052</FONT> <a name="line.52"></a>
<FONT color="green">053</FONT> public SimpleByteSource(byte[] bytes) {<a name="line.53"></a>
<FONT color="green">054</FONT> this.bytes = bytes;<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> /**<a name="line.57"></a>
<FONT color="green">058</FONT> * Creates an instance by converting the characters to a byte array (assumes UTF-8 encoding).<a name="line.58"></a>
<FONT color="green">059</FONT> *<a name="line.59"></a>
<FONT color="green">060</FONT> * @param chars the source characters to use to create the underlying byte array.<a name="line.60"></a>
<FONT color="green">061</FONT> * @since 1.1<a name="line.61"></a>
<FONT color="green">062</FONT> */<a name="line.62"></a>
<FONT color="green">063</FONT> public SimpleByteSource(char[] chars) {<a name="line.63"></a>
<FONT color="green">064</FONT> this.bytes = CodecSupport.toBytes(chars);<a name="line.64"></a>
<FONT color="green">065</FONT> }<a name="line.65"></a>
<FONT color="green">066</FONT> <a name="line.66"></a>
<FONT color="green">067</FONT> /**<a name="line.67"></a>
<FONT color="green">068</FONT> * Creates an instance by converting the String to a byte array (assumes UTF-8 encoding).<a name="line.68"></a>
<FONT color="green">069</FONT> *<a name="line.69"></a>
<FONT color="green">070</FONT> * @param string the source string to convert to a byte array (assumes UTF-8 encoding).<a name="line.70"></a>
<FONT color="green">071</FONT> * @since 1.1<a name="line.71"></a>
<FONT color="green">072</FONT> */<a name="line.72"></a>
<FONT color="green">073</FONT> public SimpleByteSource(String string) {<a name="line.73"></a>
<FONT color="green">074</FONT> this.bytes = CodecSupport.toBytes(string);<a name="line.74"></a>
<FONT color="green">075</FONT> }<a name="line.75"></a>
<FONT color="green">076</FONT> <a name="line.76"></a>
<FONT color="green">077</FONT> /**<a name="line.77"></a>
<FONT color="green">078</FONT> * Creates an instance using the sources bytes directly - it does not create a copy of the<a name="line.78"></a>
<FONT color="green">079</FONT> * argument's byte array.<a name="line.79"></a>
<FONT color="green">080</FONT> *<a name="line.80"></a>
<FONT color="green">081</FONT> * @param source the source to use to populate the underlying byte array.<a name="line.81"></a>
<FONT color="green">082</FONT> * @since 1.1<a name="line.82"></a>
<FONT color="green">083</FONT> */<a name="line.83"></a>
<FONT color="green">084</FONT> public SimpleByteSource(ByteSource source) {<a name="line.84"></a>
<FONT color="green">085</FONT> this.bytes = source.getBytes();<a name="line.85"></a>
<FONT color="green">086</FONT> }<a name="line.86"></a>
<FONT color="green">087</FONT> <a name="line.87"></a>
<FONT color="green">088</FONT> /**<a name="line.88"></a>
<FONT color="green">089</FONT> * Creates an instance by converting the file to a byte array.<a name="line.89"></a>
<FONT color="green">090</FONT> *<a name="line.90"></a>
<FONT color="green">091</FONT> * @param file the file from which to acquire bytes.<a name="line.91"></a>
<FONT color="green">092</FONT> * @since 1.1<a name="line.92"></a>
<FONT color="green">093</FONT> */<a name="line.93"></a>
<FONT color="green">094</FONT> public SimpleByteSource(File file) {<a name="line.94"></a>
<FONT color="green">095</FONT> this.bytes = new BytesHelper().getBytes(file);<a name="line.95"></a>
<FONT color="green">096</FONT> }<a name="line.96"></a>
<FONT color="green">097</FONT> <a name="line.97"></a>
<FONT color="green">098</FONT> /**<a name="line.98"></a>
<FONT color="green">099</FONT> * Creates an instance by converting the stream to a byte array.<a name="line.99"></a>
<FONT color="green">100</FONT> *<a name="line.100"></a>
<FONT color="green">101</FONT> * @param stream the stream from which to acquire bytes.<a name="line.101"></a>
<FONT color="green">102</FONT> * @since 1.1<a name="line.102"></a>
<FONT color="green">103</FONT> */<a name="line.103"></a>
<FONT color="green">104</FONT> public SimpleByteSource(InputStream stream) {<a name="line.104"></a>
<FONT color="green">105</FONT> this.bytes = new BytesHelper().getBytes(stream);<a name="line.105"></a>
<FONT color="green">106</FONT> }<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> * Returns {@code true} if the specified object is a recognized data type that can be easily converted to<a name="line.109"></a>
<FONT color="green">110</FONT> * bytes by instances of this class, {@code false} otherwise.<a name="line.110"></a>
<FONT color="green">111</FONT> * &lt;p/&gt;<a name="line.111"></a>
<FONT color="green">112</FONT> * This implementation returns {@code true} IFF the specified object is an instance of one of the following<a name="line.112"></a>
<FONT color="green">113</FONT> * types:<a name="line.113"></a>
<FONT color="green">114</FONT> * &lt;ul&gt;<a name="line.114"></a>
<FONT color="green">115</FONT> * &lt;li&gt;{@code byte[]}&lt;/li&gt;<a name="line.115"></a>
<FONT color="green">116</FONT> * &lt;li&gt;{@code char[]}&lt;/li&gt;<a name="line.116"></a>
<FONT color="green">117</FONT> * &lt;li&gt;{@link ByteSource}&lt;/li&gt;<a name="line.117"></a>
<FONT color="green">118</FONT> * &lt;li&gt;{@link String}&lt;/li&gt;<a name="line.118"></a>
<FONT color="green">119</FONT> * &lt;li&gt;{@link File}&lt;/li&gt;<a name="line.119"></a>
<FONT color="green">120</FONT> * &lt;/li&gt;{@link InputStream}&lt;/li&gt;<a name="line.120"></a>
<FONT color="green">121</FONT> * &lt;/ul&gt;<a name="line.121"></a>
<FONT color="green">122</FONT> *<a name="line.122"></a>
<FONT color="green">123</FONT> * @param o the object to test to see if it can be easily converted to bytes by instances of this class.<a name="line.123"></a>
<FONT color="green">124</FONT> * @return {@code true} if the specified object can be easily converted to bytes by instances of this class,<a name="line.124"></a>
<FONT color="green">125</FONT> * {@code false} otherwise.<a name="line.125"></a>
<FONT color="green">126</FONT> * @since 1.2<a name="line.126"></a>
<FONT color="green">127</FONT> */<a name="line.127"></a>
<FONT color="green">128</FONT> public static boolean isCompatible(Object o) {<a name="line.128"></a>
<FONT color="green">129</FONT> return o instanceof byte[] || o instanceof char[] || o instanceof String ||<a name="line.129"></a>
<FONT color="green">130</FONT> o instanceof ByteSource || o instanceof File || o instanceof InputStream;<a name="line.130"></a>
<FONT color="green">131</FONT> }<a name="line.131"></a>
<FONT color="green">132</FONT> <a name="line.132"></a>
<FONT color="green">133</FONT> public byte[] getBytes() {<a name="line.133"></a>
<FONT color="green">134</FONT> return this.bytes;<a name="line.134"></a>
<FONT color="green">135</FONT> }<a name="line.135"></a>
<FONT color="green">136</FONT> <a name="line.136"></a>
<FONT color="green">137</FONT> public boolean isEmpty() {<a name="line.137"></a>
<FONT color="green">138</FONT> return this.bytes == null || this.bytes.length == 0;<a name="line.138"></a>
<FONT color="green">139</FONT> }<a name="line.139"></a>
<FONT color="green">140</FONT> <a name="line.140"></a>
<FONT color="green">141</FONT> public String toHex() {<a name="line.141"></a>
<FONT color="green">142</FONT> if ( this.cachedHex == null ) {<a name="line.142"></a>
<FONT color="green">143</FONT> this.cachedHex = Hex.encodeToString(getBytes());<a name="line.143"></a>
<FONT color="green">144</FONT> }<a name="line.144"></a>
<FONT color="green">145</FONT> return this.cachedHex;<a name="line.145"></a>
<FONT color="green">146</FONT> }<a name="line.146"></a>
<FONT color="green">147</FONT> <a name="line.147"></a>
<FONT color="green">148</FONT> public String toBase64() {<a name="line.148"></a>
<FONT color="green">149</FONT> if ( this.cachedBase64 == null ) {<a name="line.149"></a>
<FONT color="green">150</FONT> this.cachedBase64 = Base64.encodeToString(getBytes());<a name="line.150"></a>
<FONT color="green">151</FONT> }<a name="line.151"></a>
<FONT color="green">152</FONT> return this.cachedBase64;<a name="line.152"></a>
<FONT color="green">153</FONT> }<a name="line.153"></a>
<FONT color="green">154</FONT> <a name="line.154"></a>
<FONT color="green">155</FONT> public String toString() {<a name="line.155"></a>
<FONT color="green">156</FONT> return toBase64();<a name="line.156"></a>
<FONT color="green">157</FONT> }<a name="line.157"></a>
<FONT color="green">158</FONT> <a name="line.158"></a>
<FONT color="green">159</FONT> public int hashCode() {<a name="line.159"></a>
<FONT color="green">160</FONT> if (this.bytes == null || this.bytes.length == 0) {<a name="line.160"></a>
<FONT color="green">161</FONT> return 0;<a name="line.161"></a>
<FONT color="green">162</FONT> }<a name="line.162"></a>
<FONT color="green">163</FONT> return Arrays.hashCode(this.bytes);<a name="line.163"></a>
<FONT color="green">164</FONT> }<a name="line.164"></a>
<FONT color="green">165</FONT> <a name="line.165"></a>
<FONT color="green">166</FONT> public boolean equals(Object o) {<a name="line.166"></a>
<FONT color="green">167</FONT> if (o == this) {<a name="line.167"></a>
<FONT color="green">168</FONT> return true;<a name="line.168"></a>
<FONT color="green">169</FONT> }<a name="line.169"></a>
<FONT color="green">170</FONT> if (o instanceof ByteSource) {<a name="line.170"></a>
<FONT color="green">171</FONT> ByteSource bs = (ByteSource) o;<a name="line.171"></a>
<FONT color="green">172</FONT> return Arrays.equals(getBytes(), bs.getBytes());<a name="line.172"></a>
<FONT color="green">173</FONT> }<a name="line.173"></a>
<FONT color="green">174</FONT> return false;<a name="line.174"></a>
<FONT color="green">175</FONT> }<a name="line.175"></a>
<FONT color="green">176</FONT> <a name="line.176"></a>
<FONT color="green">177</FONT> //will probably be removed in Shiro 2.0. See SHIRO-203:<a name="line.177"></a>
<FONT color="green">178</FONT> //https://issues.apache.org/jira/browse/SHIRO-203<a name="line.178"></a>
<FONT color="green">179</FONT> private static final class BytesHelper extends CodecSupport {<a name="line.179"></a>
<FONT color="green">180</FONT> public byte[] getBytes(File file) {<a name="line.180"></a>
<FONT color="green">181</FONT> return toBytes(file);<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>
<FONT color="green">184</FONT> public byte[] getBytes(InputStream stream) {<a name="line.184"></a>
<FONT color="green">185</FONT> return toBytes(stream);<a name="line.185"></a>
<FONT color="green">186</FONT> }<a name="line.186"></a>
<FONT color="green">187</FONT> }<a name="line.187"></a>
<FONT color="green">188</FONT> }<a name="line.188"></a>
</PRE>
</BODY>
</HTML>