blob: 6dc71665193b58c37ea6fbd6de367eae0614598b [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.io;<a name="line.19"></a>
<FONT color="green">020</FONT> <a name="line.20"></a>
<FONT color="green">021</FONT> import java.beans.XMLDecoder;<a name="line.21"></a>
<FONT color="green">022</FONT> import java.beans.XMLEncoder;<a name="line.22"></a>
<FONT color="green">023</FONT> import java.io.BufferedInputStream;<a name="line.23"></a>
<FONT color="green">024</FONT> import java.io.BufferedOutputStream;<a name="line.24"></a>
<FONT color="green">025</FONT> import java.io.ByteArrayInputStream;<a name="line.25"></a>
<FONT color="green">026</FONT> import java.io.ByteArrayOutputStream;<a name="line.26"></a>
<FONT color="green">027</FONT> <a name="line.27"></a>
<FONT color="green">028</FONT> /**<a name="line.28"></a>
<FONT color="green">029</FONT> * Serializer implementation that uses the JavaBeans<a name="line.29"></a>
<FONT color="green">030</FONT> * {@link java.beans.XMLEncoder XMLEncoder} and {@link java.beans.XMLDecoder XMLDecoder} to serialize<a name="line.30"></a>
<FONT color="green">031</FONT> * and deserialize, respectively.<a name="line.31"></a>
<FONT color="green">032</FONT> * &lt;p/&gt;<a name="line.32"></a>
<FONT color="green">033</FONT> * &lt;b&gt;NOTE:&lt;/b&gt; The JavaBeans XMLEncoder/XMLDecoder only successfully encode/decode objects when they are<a name="line.33"></a>
<FONT color="green">034</FONT> * JavaBeans compatible!<a name="line.34"></a>
<FONT color="green">035</FONT> * <a name="line.35"></a>
<FONT color="green">036</FONT> * @since 0.9<a name="line.36"></a>
<FONT color="green">037</FONT> */<a name="line.37"></a>
<FONT color="green">038</FONT> public class XmlSerializer implements Serializer {<a name="line.38"></a>
<FONT color="green">039</FONT> <a name="line.39"></a>
<FONT color="green">040</FONT> /**<a name="line.40"></a>
<FONT color="green">041</FONT> * Serializes the specified &lt;code&gt;source&lt;/code&gt; into a byte[] array by using the<a name="line.41"></a>
<FONT color="green">042</FONT> * {@link java.beans.XMLEncoder XMLEncoder} to encode the object out to a<a name="line.42"></a>
<FONT color="green">043</FONT> * {@link java.io.ByteArrayOutputStream ByteArrayOutputStream}, where the resulting byte[] array is returned.<a name="line.43"></a>
<FONT color="green">044</FONT> * @param source the Object to convert into a byte[] array.<a name="line.44"></a>
<FONT color="green">045</FONT> * @return the byte[] array representation of the XML encoded output.<a name="line.45"></a>
<FONT color="green">046</FONT> */<a name="line.46"></a>
<FONT color="green">047</FONT> public byte[] serialize(Object source) {<a name="line.47"></a>
<FONT color="green">048</FONT> if (source == null) {<a name="line.48"></a>
<FONT color="green">049</FONT> String msg = "argument cannot be null.";<a name="line.49"></a>
<FONT color="green">050</FONT> throw new IllegalArgumentException(msg);<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> ByteArrayOutputStream bos = new ByteArrayOutputStream();<a name="line.53"></a>
<FONT color="green">054</FONT> XMLEncoder encoder = new XMLEncoder(new BufferedOutputStream(bos));<a name="line.54"></a>
<FONT color="green">055</FONT> encoder.writeObject(source);<a name="line.55"></a>
<FONT color="green">056</FONT> encoder.close();<a name="line.56"></a>
<FONT color="green">057</FONT> <a name="line.57"></a>
<FONT color="green">058</FONT> return bos.toByteArray();<a name="line.58"></a>
<FONT color="green">059</FONT> }<a name="line.59"></a>
<FONT color="green">060</FONT> <a name="line.60"></a>
<FONT color="green">061</FONT> /**<a name="line.61"></a>
<FONT color="green">062</FONT> * Deserializes the specified &lt;code&gt;serialized&lt;/code&gt; source back into an Object by using a<a name="line.62"></a>
<FONT color="green">063</FONT> * {@link java.io.ByteArrayInputStream ByteArrayInputStream} to wrap the argument and then decode this<a name="line.63"></a>
<FONT color="green">064</FONT> * stream via an {@link java.beans.XMLDecoder XMLDecoder}, where the<a name="line.64"></a>
<FONT color="green">065</FONT> * {@link java.beans.XMLDecoder#readObject() readObject} call results in the original Object to return.<a name="line.65"></a>
<FONT color="green">066</FONT> * @param serialized the byte[] array representation of the XML encoded output.<a name="line.66"></a>
<FONT color="green">067</FONT> * @return the original source Object in reconstituted form.<a name="line.67"></a>
<FONT color="green">068</FONT> */<a name="line.68"></a>
<FONT color="green">069</FONT> public Object deserialize(byte[] serialized) {<a name="line.69"></a>
<FONT color="green">070</FONT> if (serialized == null) {<a name="line.70"></a>
<FONT color="green">071</FONT> throw new IllegalArgumentException("Argument cannot be null.");<a name="line.71"></a>
<FONT color="green">072</FONT> }<a name="line.72"></a>
<FONT color="green">073</FONT> ByteArrayInputStream bis = new ByteArrayInputStream(serialized);<a name="line.73"></a>
<FONT color="green">074</FONT> XMLDecoder decoder = new XMLDecoder(new BufferedInputStream(bis));<a name="line.74"></a>
<FONT color="green">075</FONT> Object o = decoder.readObject();<a name="line.75"></a>
<FONT color="green">076</FONT> decoder.close();<a name="line.76"></a>
<FONT color="green">077</FONT> return o;<a name="line.77"></a>
<FONT color="green">078</FONT> }<a name="line.78"></a>
<FONT color="green">079</FONT> }<a name="line.79"></a>
</PRE>
</BODY>
</HTML>