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