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