| <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.codec;<a name="line.19"></a> |
| <FONT color="green">020</FONT> <a name="line.20"></a> |
| <FONT color="green">021</FONT> import org.apache.shiro.util.ByteSource;<a name="line.21"></a> |
| <FONT color="green">022</FONT> <a name="line.22"></a> |
| <FONT color="green">023</FONT> import java.io.*;<a name="line.23"></a> |
| <FONT color="green">024</FONT> <a name="line.24"></a> |
| <FONT color="green">025</FONT> /**<a name="line.25"></a> |
| <FONT color="green">026</FONT> * Base abstract class that provides useful encoding and decoding operations, especially for character data.<a name="line.26"></a> |
| <FONT color="green">027</FONT> *<a name="line.27"></a> |
| <FONT color="green">028</FONT> * @since 0.9<a name="line.28"></a> |
| <FONT color="green">029</FONT> */<a name="line.29"></a> |
| <FONT color="green">030</FONT> public abstract class CodecSupport {<a name="line.30"></a> |
| <FONT color="green">031</FONT> <a name="line.31"></a> |
| <FONT color="green">032</FONT> /**<a name="line.32"></a> |
| <FONT color="green">033</FONT> * Shiro's default preferred character encoding, equal to <b><code>UTF-8</code></b>.<a name="line.33"></a> |
| <FONT color="green">034</FONT> */<a name="line.34"></a> |
| <FONT color="green">035</FONT> public static final String PREFERRED_ENCODING = "UTF-8";<a name="line.35"></a> |
| <FONT color="green">036</FONT> <a name="line.36"></a> |
| <FONT color="green">037</FONT> /**<a name="line.37"></a> |
| <FONT color="green">038</FONT> * Converts the specified character array to a byte array using the Shiro's preferred encoding (UTF-8).<a name="line.38"></a> |
| <FONT color="green">039</FONT> * <p/><a name="line.39"></a> |
| <FONT color="green">040</FONT> * This is a convenience method equivalent to calling the {@link #toBytes(String,String)} method with a<a name="line.40"></a> |
| <FONT color="green">041</FONT> * a wrapping String and {@link CodecSupport#PREFERRED_ENCODING PREFERRED_ENCODING}, i.e.<a name="line.41"></a> |
| <FONT color="green">042</FONT> * <p/><a name="line.42"></a> |
| <FONT color="green">043</FONT> * <code>toBytes( new String(chars), {@link CodecSupport#PREFERRED_ENCODING PREFERRED_ENCODING} );</code><a name="line.43"></a> |
| <FONT color="green">044</FONT> *<a name="line.44"></a> |
| <FONT color="green">045</FONT> * @param chars the character array to be converted to a byte array.<a name="line.45"></a> |
| <FONT color="green">046</FONT> * @return the byte array of the UTF-8 encoded character array.<a name="line.46"></a> |
| <FONT color="green">047</FONT> */<a name="line.47"></a> |
| <FONT color="green">048</FONT> public static byte[] toBytes(char[] chars) {<a name="line.48"></a> |
| <FONT color="green">049</FONT> return toBytes(new String(chars), PREFERRED_ENCODING);<a name="line.49"></a> |
| <FONT color="green">050</FONT> }<a name="line.50"></a> |
| <FONT color="green">051</FONT> <a name="line.51"></a> |
| <FONT color="green">052</FONT> /**<a name="line.52"></a> |
| <FONT color="green">053</FONT> * Converts the specified character array into a byte array using the specified character encoding.<a name="line.53"></a> |
| <FONT color="green">054</FONT> * <p/><a name="line.54"></a> |
| <FONT color="green">055</FONT> * This is a convenience method equivalent to calling the {@link #toBytes(String,String)} method with a<a name="line.55"></a> |
| <FONT color="green">056</FONT> * a wrapping String and the specified encoding, i.e.<a name="line.56"></a> |
| <FONT color="green">057</FONT> * <p/><a name="line.57"></a> |
| <FONT color="green">058</FONT> * <code>toBytes( new String(chars), encoding );</code><a name="line.58"></a> |
| <FONT color="green">059</FONT> *<a name="line.59"></a> |
| <FONT color="green">060</FONT> * @param chars the character array to be converted to a byte array<a name="line.60"></a> |
| <FONT color="green">061</FONT> * @param encoding the character encoding to use to when converting to bytes.<a name="line.61"></a> |
| <FONT color="green">062</FONT> * @return the bytes of the specified character array under the specified encoding.<a name="line.62"></a> |
| <FONT color="green">063</FONT> * @throws CodecException if the JVM does not support the specified encoding.<a name="line.63"></a> |
| <FONT color="green">064</FONT> */<a name="line.64"></a> |
| <FONT color="green">065</FONT> public static byte[] toBytes(char[] chars, String encoding) throws CodecException {<a name="line.65"></a> |
| <FONT color="green">066</FONT> return toBytes(new String(chars), encoding);<a name="line.66"></a> |
| <FONT color="green">067</FONT> }<a name="line.67"></a> |
| <FONT color="green">068</FONT> <a name="line.68"></a> |
| <FONT color="green">069</FONT> /**<a name="line.69"></a> |
| <FONT color="green">070</FONT> * Converts the specified source argument to a byte array with Shiro's<a name="line.70"></a> |
| <FONT color="green">071</FONT> * {@link CodecSupport#PREFERRED_ENCODING PREFERRED_ENCODING}.<a name="line.71"></a> |
| <FONT color="green">072</FONT> *<a name="line.72"></a> |
| <FONT color="green">073</FONT> * @param source the string to convert to a byte array.<a name="line.73"></a> |
| <FONT color="green">074</FONT> * @return the bytes representing the specified string under the {@link CodecSupport#PREFERRED_ENCODING PREFERRED_ENCODING}.<a name="line.74"></a> |
| <FONT color="green">075</FONT> * @see #toBytes(String, String)<a name="line.75"></a> |
| <FONT color="green">076</FONT> */<a name="line.76"></a> |
| <FONT color="green">077</FONT> public static byte[] toBytes(String source) {<a name="line.77"></a> |
| <FONT color="green">078</FONT> return toBytes(source, PREFERRED_ENCODING);<a name="line.78"></a> |
| <FONT color="green">079</FONT> }<a name="line.79"></a> |
| <FONT color="green">080</FONT> <a name="line.80"></a> |
| <FONT color="green">081</FONT> /**<a name="line.81"></a> |
| <FONT color="green">082</FONT> * Converts the specified source to a byte array via the specified encoding, throwing a<a name="line.82"></a> |
| <FONT color="green">083</FONT> * {@link CodecException CodecException} if the encoding fails.<a name="line.83"></a> |
| <FONT color="green">084</FONT> *<a name="line.84"></a> |
| <FONT color="green">085</FONT> * @param source the source string to convert to a byte array.<a name="line.85"></a> |
| <FONT color="green">086</FONT> * @param encoding the encoding to use to use.<a name="line.86"></a> |
| <FONT color="green">087</FONT> * @return the byte array of the specified source with the given encoding.<a name="line.87"></a> |
| <FONT color="green">088</FONT> * @throws CodecException if the JVM does not support the specified encoding.<a name="line.88"></a> |
| <FONT color="green">089</FONT> */<a name="line.89"></a> |
| <FONT color="green">090</FONT> public static byte[] toBytes(String source, String encoding) throws CodecException {<a name="line.90"></a> |
| <FONT color="green">091</FONT> try {<a name="line.91"></a> |
| <FONT color="green">092</FONT> return source.getBytes(encoding);<a name="line.92"></a> |
| <FONT color="green">093</FONT> } catch (UnsupportedEncodingException e) {<a name="line.93"></a> |
| <FONT color="green">094</FONT> String msg = "Unable to convert source [" + source + "] to byte array using " +<a name="line.94"></a> |
| <FONT color="green">095</FONT> "encoding '" + encoding + "'";<a name="line.95"></a> |
| <FONT color="green">096</FONT> throw new CodecException(msg, e);<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> <a name="line.99"></a> |
| <FONT color="green">100</FONT> /**<a name="line.100"></a> |
| <FONT color="green">101</FONT> * Converts the specified byte array to a String using the {@link CodecSupport#PREFERRED_ENCODING PREFERRED_ENCODING}.<a name="line.101"></a> |
| <FONT color="green">102</FONT> *<a name="line.102"></a> |
| <FONT color="green">103</FONT> * @param bytes the byte array to turn into a String.<a name="line.103"></a> |
| <FONT color="green">104</FONT> * @return the specified byte array as an encoded String ({@link CodecSupport#PREFERRED_ENCODING PREFERRED_ENCODING}).<a name="line.104"></a> |
| <FONT color="green">105</FONT> * @see #toString(byte[], String)<a name="line.105"></a> |
| <FONT color="green">106</FONT> */<a name="line.106"></a> |
| <FONT color="green">107</FONT> public static String toString(byte[] bytes) {<a name="line.107"></a> |
| <FONT color="green">108</FONT> return toString(bytes, PREFERRED_ENCODING);<a name="line.108"></a> |
| <FONT color="green">109</FONT> }<a name="line.109"></a> |
| <FONT color="green">110</FONT> <a name="line.110"></a> |
| <FONT color="green">111</FONT> /**<a name="line.111"></a> |
| <FONT color="green">112</FONT> * Converts the specified byte array to a String using the specified character encoding. This implementation<a name="line.112"></a> |
| <FONT color="green">113</FONT> * does the same thing as <code>new {@link String#String(byte[], String) String(byte[], encoding)}</code>, but will<a name="line.113"></a> |
| <FONT color="green">114</FONT> * wrap any {@link UnsupportedEncodingException} with a nicer runtime {@link CodecException}, allowing you to<a name="line.114"></a> |
| <FONT color="green">115</FONT> * decide whether or not you want to catch the exception or let it propagate.<a name="line.115"></a> |
| <FONT color="green">116</FONT> *<a name="line.116"></a> |
| <FONT color="green">117</FONT> * @param bytes the byte array to convert to a String<a name="line.117"></a> |
| <FONT color="green">118</FONT> * @param encoding the character encoding used to encode the String.<a name="line.118"></a> |
| <FONT color="green">119</FONT> * @return the specified byte array as an encoded String<a name="line.119"></a> |
| <FONT color="green">120</FONT> * @throws CodecException if the JVM does not support the specified encoding.<a name="line.120"></a> |
| <FONT color="green">121</FONT> */<a name="line.121"></a> |
| <FONT color="green">122</FONT> public static String toString(byte[] bytes, String encoding) throws CodecException {<a name="line.122"></a> |
| <FONT color="green">123</FONT> try {<a name="line.123"></a> |
| <FONT color="green">124</FONT> return new String(bytes, encoding);<a name="line.124"></a> |
| <FONT color="green">125</FONT> } catch (UnsupportedEncodingException e) {<a name="line.125"></a> |
| <FONT color="green">126</FONT> String msg = "Unable to convert byte array to String with encoding '" + encoding + "'.";<a name="line.126"></a> |
| <FONT color="green">127</FONT> throw new CodecException(msg, e);<a name="line.127"></a> |
| <FONT color="green">128</FONT> }<a name="line.128"></a> |
| <FONT color="green">129</FONT> }<a name="line.129"></a> |
| <FONT color="green">130</FONT> <a name="line.130"></a> |
| <FONT color="green">131</FONT> /**<a name="line.131"></a> |
| <FONT color="green">132</FONT> * Returns the specified byte array as a character array using the<a name="line.132"></a> |
| <FONT color="green">133</FONT> * {@link CodecSupport#PREFERRED_ENCODING PREFERRED_ENCODING}.<a name="line.133"></a> |
| <FONT color="green">134</FONT> *<a name="line.134"></a> |
| <FONT color="green">135</FONT> * @param bytes the byte array to convert to a char array<a name="line.135"></a> |
| <FONT color="green">136</FONT> * @return the specified byte array encoded as a character array ({@link CodecSupport#PREFERRED_ENCODING PREFERRED_ENCODING}).<a name="line.136"></a> |
| <FONT color="green">137</FONT> * @see #toChars(byte[], String)<a name="line.137"></a> |
| <FONT color="green">138</FONT> */<a name="line.138"></a> |
| <FONT color="green">139</FONT> public static char[] toChars(byte[] bytes) {<a name="line.139"></a> |
| <FONT color="green">140</FONT> return toChars(bytes, PREFERRED_ENCODING);<a name="line.140"></a> |
| <FONT color="green">141</FONT> }<a name="line.141"></a> |
| <FONT color="green">142</FONT> <a name="line.142"></a> |
| <FONT color="green">143</FONT> /**<a name="line.143"></a> |
| <FONT color="green">144</FONT> * Converts the specified byte array to a character array using the specified character encoding.<a name="line.144"></a> |
| <FONT color="green">145</FONT> * <p/><a name="line.145"></a> |
| <FONT color="green">146</FONT> * Effectively calls <code>{@link #toString(byte[], String) toString(bytes,encoding)}.{@link String#toCharArray() toCharArray()};</code><a name="line.146"></a> |
| <FONT color="green">147</FONT> *<a name="line.147"></a> |
| <FONT color="green">148</FONT> * @param bytes the byte array to convert to a String<a name="line.148"></a> |
| <FONT color="green">149</FONT> * @param encoding the character encoding used to encode the bytes.<a name="line.149"></a> |
| <FONT color="green">150</FONT> * @return the specified byte array as an encoded char array<a name="line.150"></a> |
| <FONT color="green">151</FONT> * @throws CodecException if the JVM does not support the specified encoding.<a name="line.151"></a> |
| <FONT color="green">152</FONT> */<a name="line.152"></a> |
| <FONT color="green">153</FONT> public static char[] toChars(byte[] bytes, String encoding) throws CodecException {<a name="line.153"></a> |
| <FONT color="green">154</FONT> return toString(bytes, encoding).toCharArray();<a name="line.154"></a> |
| <FONT color="green">155</FONT> }<a name="line.155"></a> |
| <FONT color="green">156</FONT> <a name="line.156"></a> |
| <FONT color="green">157</FONT> /**<a name="line.157"></a> |
| <FONT color="green">158</FONT> * Returns {@code true} if the specified object can be easily converted to bytes by instances of this class,<a name="line.158"></a> |
| <FONT color="green">159</FONT> * {@code false} otherwise.<a name="line.159"></a> |
| <FONT color="green">160</FONT> * <p/><a name="line.160"></a> |
| <FONT color="green">161</FONT> * The default implementation returns {@code true} IFF the specified object is an instance of one of the following<a name="line.161"></a> |
| <FONT color="green">162</FONT> * types:<a name="line.162"></a> |
| <FONT color="green">163</FONT> * <ul><a name="line.163"></a> |
| <FONT color="green">164</FONT> * <li>{@code byte[]}</li><a name="line.164"></a> |
| <FONT color="green">165</FONT> * <li>{@code char[]}</li><a name="line.165"></a> |
| <FONT color="green">166</FONT> * <li>{@link ByteSource}</li><a name="line.166"></a> |
| <FONT color="green">167</FONT> * <li>{@link String}</li><a name="line.167"></a> |
| <FONT color="green">168</FONT> * <li>{@link File}</li><a name="line.168"></a> |
| <FONT color="green">169</FONT> * </li>{@link InputStream}</li><a name="line.169"></a> |
| <FONT color="green">170</FONT> * </ul><a name="line.170"></a> |
| <FONT color="green">171</FONT> *<a name="line.171"></a> |
| <FONT color="green">172</FONT> * @param o the object to test to see if it can be easily converted to a byte array<a name="line.172"></a> |
| <FONT color="green">173</FONT> * @return {@code true} if the specified object can be easily converted to bytes by instances of this class,<a name="line.173"></a> |
| <FONT color="green">174</FONT> * {@code false} otherwise.<a name="line.174"></a> |
| <FONT color="green">175</FONT> * @since 1.0<a name="line.175"></a> |
| <FONT color="green">176</FONT> */<a name="line.176"></a> |
| <FONT color="green">177</FONT> protected boolean isByteSource(Object o) {<a name="line.177"></a> |
| <FONT color="green">178</FONT> return o instanceof byte[] || o instanceof char[] || o instanceof String ||<a name="line.178"></a> |
| <FONT color="green">179</FONT> o instanceof ByteSource || o instanceof File || o instanceof InputStream;<a name="line.179"></a> |
| <FONT color="green">180</FONT> }<a name="line.180"></a> |
| <FONT color="green">181</FONT> <a name="line.181"></a> |
| <FONT color="green">182</FONT> /**<a name="line.182"></a> |
| <FONT color="green">183</FONT> * Converts the specified Object into a byte array.<a name="line.183"></a> |
| <FONT color="green">184</FONT> * <p/><a name="line.184"></a> |
| <FONT color="green">185</FONT> * If the argument is a {@code byte[]}, {@code char[]}, {@link ByteSource}, {@link String}, {@link File}, or<a name="line.185"></a> |
| <FONT color="green">186</FONT> * {@link InputStream}, it will be converted automatically and returned.}<a name="line.186"></a> |
| <FONT color="green">187</FONT> * <p/><a name="line.187"></a> |
| <FONT color="green">188</FONT> * If the argument is anything other than these types, it is passed to the<a name="line.188"></a> |
| <FONT color="green">189</FONT> * {@link #objectToBytes(Object) objectToBytes} method which must be overridden by subclasses.<a name="line.189"></a> |
| <FONT color="green">190</FONT> *<a name="line.190"></a> |
| <FONT color="green">191</FONT> * @param o the Object to convert into a byte array<a name="line.191"></a> |
| <FONT color="green">192</FONT> * @return a byte array representation of the Object argument.<a name="line.192"></a> |
| <FONT color="green">193</FONT> */<a name="line.193"></a> |
| <FONT color="green">194</FONT> protected byte[] toBytes(Object o) {<a name="line.194"></a> |
| <FONT color="green">195</FONT> if (o == null) {<a name="line.195"></a> |
| <FONT color="green">196</FONT> String msg = "Argument for byte conversion cannot be null.";<a name="line.196"></a> |
| <FONT color="green">197</FONT> throw new IllegalArgumentException(msg);<a name="line.197"></a> |
| <FONT color="green">198</FONT> }<a name="line.198"></a> |
| <FONT color="green">199</FONT> if (o instanceof byte[]) {<a name="line.199"></a> |
| <FONT color="green">200</FONT> return (byte[]) o;<a name="line.200"></a> |
| <FONT color="green">201</FONT> } else if (o instanceof ByteSource) {<a name="line.201"></a> |
| <FONT color="green">202</FONT> return ((ByteSource) o).getBytes();<a name="line.202"></a> |
| <FONT color="green">203</FONT> } else if (o instanceof char[]) {<a name="line.203"></a> |
| <FONT color="green">204</FONT> return toBytes((char[]) o);<a name="line.204"></a> |
| <FONT color="green">205</FONT> } else if (o instanceof String) {<a name="line.205"></a> |
| <FONT color="green">206</FONT> return toBytes((String) o);<a name="line.206"></a> |
| <FONT color="green">207</FONT> } else if (o instanceof File) {<a name="line.207"></a> |
| <FONT color="green">208</FONT> return toBytes((File) o);<a name="line.208"></a> |
| <FONT color="green">209</FONT> } else if (o instanceof InputStream) {<a name="line.209"></a> |
| <FONT color="green">210</FONT> return toBytes((InputStream) o);<a name="line.210"></a> |
| <FONT color="green">211</FONT> } else {<a name="line.211"></a> |
| <FONT color="green">212</FONT> return objectToBytes(o);<a name="line.212"></a> |
| <FONT color="green">213</FONT> }<a name="line.213"></a> |
| <FONT color="green">214</FONT> }<a name="line.214"></a> |
| <FONT color="green">215</FONT> <a name="line.215"></a> |
| <FONT color="green">216</FONT> /**<a name="line.216"></a> |
| <FONT color="green">217</FONT> * Converts the specified Object into a String.<a name="line.217"></a> |
| <FONT color="green">218</FONT> * <p/><a name="line.218"></a> |
| <FONT color="green">219</FONT> * If the argument is a {@code byte[]} or {@code char[]} it will be converted to a String using the<a name="line.219"></a> |
| <FONT color="green">220</FONT> * {@link #PREFERRED_ENCODING}. If a String, it will be returned as is.<a name="line.220"></a> |
| <FONT color="green">221</FONT> * <p/><a name="line.221"></a> |
| <FONT color="green">222</FONT> * If the argument is anything other than these three types, it is passed to the<a name="line.222"></a> |
| <FONT color="green">223</FONT> * {@link #objectToString(Object) objectToString} method.<a name="line.223"></a> |
| <FONT color="green">224</FONT> *<a name="line.224"></a> |
| <FONT color="green">225</FONT> * @param o the Object to convert into a byte array<a name="line.225"></a> |
| <FONT color="green">226</FONT> * @return a byte array representation of the Object argument.<a name="line.226"></a> |
| <FONT color="green">227</FONT> */<a name="line.227"></a> |
| <FONT color="green">228</FONT> protected String toString(Object o) {<a name="line.228"></a> |
| <FONT color="green">229</FONT> if (o == null) {<a name="line.229"></a> |
| <FONT color="green">230</FONT> String msg = "Argument for String conversion cannot be null.";<a name="line.230"></a> |
| <FONT color="green">231</FONT> throw new IllegalArgumentException(msg);<a name="line.231"></a> |
| <FONT color="green">232</FONT> }<a name="line.232"></a> |
| <FONT color="green">233</FONT> if (o instanceof byte[]) {<a name="line.233"></a> |
| <FONT color="green">234</FONT> return toString((byte[]) o);<a name="line.234"></a> |
| <FONT color="green">235</FONT> } else if (o instanceof char[]) {<a name="line.235"></a> |
| <FONT color="green">236</FONT> return new String((char[]) o);<a name="line.236"></a> |
| <FONT color="green">237</FONT> } else if (o instanceof String) {<a name="line.237"></a> |
| <FONT color="green">238</FONT> return (String) o;<a name="line.238"></a> |
| <FONT color="green">239</FONT> } else {<a name="line.239"></a> |
| <FONT color="green">240</FONT> return objectToString(o);<a name="line.240"></a> |
| <FONT color="green">241</FONT> }<a name="line.241"></a> |
| <FONT color="green">242</FONT> }<a name="line.242"></a> |
| <FONT color="green">243</FONT> <a name="line.243"></a> |
| <FONT color="green">244</FONT> protected byte[] toBytes(File file) {<a name="line.244"></a> |
| <FONT color="green">245</FONT> if (file == null) {<a name="line.245"></a> |
| <FONT color="green">246</FONT> throw new IllegalArgumentException("File argument cannot be null.");<a name="line.246"></a> |
| <FONT color="green">247</FONT> }<a name="line.247"></a> |
| <FONT color="green">248</FONT> try {<a name="line.248"></a> |
| <FONT color="green">249</FONT> return toBytes(new FileInputStream(file));<a name="line.249"></a> |
| <FONT color="green">250</FONT> } catch (FileNotFoundException e) {<a name="line.250"></a> |
| <FONT color="green">251</FONT> String msg = "Unable to acquire InputStream for file [" + file + "]";<a name="line.251"></a> |
| <FONT color="green">252</FONT> throw new CodecException(msg, e);<a name="line.252"></a> |
| <FONT color="green">253</FONT> }<a name="line.253"></a> |
| <FONT color="green">254</FONT> }<a name="line.254"></a> |
| <FONT color="green">255</FONT> <a name="line.255"></a> |
| <FONT color="green">256</FONT> /**<a name="line.256"></a> |
| <FONT color="green">257</FONT> * Converts the specified {@link InputStream InputStream} into a byte array.<a name="line.257"></a> |
| <FONT color="green">258</FONT> *<a name="line.258"></a> |
| <FONT color="green">259</FONT> * @param in the InputStream to convert to a byte array<a name="line.259"></a> |
| <FONT color="green">260</FONT> * @return the bytes of the input stream<a name="line.260"></a> |
| <FONT color="green">261</FONT> * @throws IllegalArgumentException if the {@code InputStream} argument is {@code null}.<a name="line.261"></a> |
| <FONT color="green">262</FONT> * @throws CodecException if there is any problem reading from the {@link InputStream}.<a name="line.262"></a> |
| <FONT color="green">263</FONT> * @since 1.0<a name="line.263"></a> |
| <FONT color="green">264</FONT> */<a name="line.264"></a> |
| <FONT color="green">265</FONT> protected byte[] toBytes(InputStream in) {<a name="line.265"></a> |
| <FONT color="green">266</FONT> if (in == null) {<a name="line.266"></a> |
| <FONT color="green">267</FONT> throw new IllegalArgumentException("InputStream argument cannot be null.");<a name="line.267"></a> |
| <FONT color="green">268</FONT> }<a name="line.268"></a> |
| <FONT color="green">269</FONT> final int BUFFER_SIZE = 512;<a name="line.269"></a> |
| <FONT color="green">270</FONT> ByteArrayOutputStream out = new ByteArrayOutputStream(BUFFER_SIZE);<a name="line.270"></a> |
| <FONT color="green">271</FONT> byte[] buffer = new byte[BUFFER_SIZE];<a name="line.271"></a> |
| <FONT color="green">272</FONT> int bytesRead;<a name="line.272"></a> |
| <FONT color="green">273</FONT> try {<a name="line.273"></a> |
| <FONT color="green">274</FONT> while ((bytesRead = in.read(buffer)) != -1) {<a name="line.274"></a> |
| <FONT color="green">275</FONT> out.write(buffer, 0, bytesRead);<a name="line.275"></a> |
| <FONT color="green">276</FONT> }<a name="line.276"></a> |
| <FONT color="green">277</FONT> return out.toByteArray();<a name="line.277"></a> |
| <FONT color="green">278</FONT> } catch (IOException ioe) {<a name="line.278"></a> |
| <FONT color="green">279</FONT> throw new CodecException(ioe);<a name="line.279"></a> |
| <FONT color="green">280</FONT> } finally {<a name="line.280"></a> |
| <FONT color="green">281</FONT> try {<a name="line.281"></a> |
| <FONT color="green">282</FONT> in.close();<a name="line.282"></a> |
| <FONT color="green">283</FONT> } catch (IOException ignored) {<a name="line.283"></a> |
| <FONT color="green">284</FONT> }<a name="line.284"></a> |
| <FONT color="green">285</FONT> try {<a name="line.285"></a> |
| <FONT color="green">286</FONT> out.close();<a name="line.286"></a> |
| <FONT color="green">287</FONT> } catch (IOException ignored) {<a name="line.287"></a> |
| <FONT color="green">288</FONT> }<a name="line.288"></a> |
| <FONT color="green">289</FONT> }<a name="line.289"></a> |
| <FONT color="green">290</FONT> }<a name="line.290"></a> |
| <FONT color="green">291</FONT> <a name="line.291"></a> |
| <FONT color="green">292</FONT> /**<a name="line.292"></a> |
| <FONT color="green">293</FONT> * Default implementation throws a CodecException immediately since it can't infer how to convert the Object<a name="line.293"></a> |
| <FONT color="green">294</FONT> * to a byte array. This method must be overridden by subclasses if anything other than the three default<a name="line.294"></a> |
| <FONT color="green">295</FONT> * types (listed in the {@link #toBytes(Object) toBytes(Object)} JavaDoc) are to be converted to a byte array.<a name="line.295"></a> |
| <FONT color="green">296</FONT> *<a name="line.296"></a> |
| <FONT color="green">297</FONT> * @param o the Object to convert to a byte array.<a name="line.297"></a> |
| <FONT color="green">298</FONT> * @return a byte array representation of the Object argument.<a name="line.298"></a> |
| <FONT color="green">299</FONT> */<a name="line.299"></a> |
| <FONT color="green">300</FONT> protected byte[] objectToBytes(Object o) {<a name="line.300"></a> |
| <FONT color="green">301</FONT> String msg = "The " + getClass().getName() + " implementation only supports conversion to " +<a name="line.301"></a> |
| <FONT color="green">302</FONT> "byte[] if the source is of type byte[], char[], String, " + ByteSource.class.getName() +<a name="line.302"></a> |
| <FONT color="green">303</FONT> " File or InputStream. The instance provided as a method " +<a name="line.303"></a> |
| <FONT color="green">304</FONT> "argument is of type [" + o.getClass().getName() + "]. If you would like to convert " +<a name="line.304"></a> |
| <FONT color="green">305</FONT> "this argument type to a byte[], you can 1) convert the argument to one of the supported types " +<a name="line.305"></a> |
| <FONT color="green">306</FONT> "yourself and then use that as the method argument or 2) subclass " + getClass().getName() +<a name="line.306"></a> |
| <FONT color="green">307</FONT> "and override the objectToBytes(Object o) method.";<a name="line.307"></a> |
| <FONT color="green">308</FONT> throw new CodecException(msg);<a name="line.308"></a> |
| <FONT color="green">309</FONT> }<a name="line.309"></a> |
| <FONT color="green">310</FONT> <a name="line.310"></a> |
| <FONT color="green">311</FONT> /**<a name="line.311"></a> |
| <FONT color="green">312</FONT> * Default implementation merely returns <code>objectArgument.toString()</code>. Subclasses can override this<a name="line.312"></a> |
| <FONT color="green">313</FONT> * method for different mechanisms of converting an object to a String.<a name="line.313"></a> |
| <FONT color="green">314</FONT> *<a name="line.314"></a> |
| <FONT color="green">315</FONT> * @param o the Object to convert to a byte array.<a name="line.315"></a> |
| <FONT color="green">316</FONT> * @return a String representation of the Object argument.<a name="line.316"></a> |
| <FONT color="green">317</FONT> */<a name="line.317"></a> |
| <FONT color="green">318</FONT> protected String objectToString(Object o) {<a name="line.318"></a> |
| <FONT color="green">319</FONT> return o.toString();<a name="line.319"></a> |
| <FONT color="green">320</FONT> }<a name="line.320"></a> |
| <FONT color="green">321</FONT> }<a name="line.321"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </PRE> |
| </BODY> |
| </HTML> |
