blob: 5beffed29f63c3c4f749b42cbddc40e39be5dace [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.io.*;<a name="line.21"></a>
<FONT color="green">022</FONT> <a name="line.22"></a>
<FONT color="green">023</FONT> /**<a name="line.23"></a>
<FONT color="green">024</FONT> * Serializer implementation that uses the default JVM serialization mechanism (Object Input/Output Streams).<a name="line.24"></a>
<FONT color="green">025</FONT> *<a name="line.25"></a>
<FONT color="green">026</FONT> * @since 0.9<a name="line.26"></a>
<FONT color="green">027</FONT> */<a name="line.27"></a>
<FONT color="green">028</FONT> public class DefaultSerializer&lt;T&gt; implements Serializer&lt;T&gt; {<a name="line.28"></a>
<FONT color="green">029</FONT> <a name="line.29"></a>
<FONT color="green">030</FONT> /**<a name="line.30"></a>
<FONT color="green">031</FONT> * This implementation serializes the Object by using an {@link ObjectOutputStream} backed by a<a name="line.31"></a>
<FONT color="green">032</FONT> * {@link ByteArrayOutputStream}. The {@code ByteArrayOutputStream}'s backing byte array is returned.<a name="line.32"></a>
<FONT color="green">033</FONT> *<a name="line.33"></a>
<FONT color="green">034</FONT> * @param o the Object to convert into a byte[] array.<a name="line.34"></a>
<FONT color="green">035</FONT> * @return the bytes representing the serialized object using standard JVM serialization.<a name="line.35"></a>
<FONT color="green">036</FONT> * @throws SerializationException wrapping a {@link IOException} if something goes wrong with the streams.<a name="line.36"></a>
<FONT color="green">037</FONT> */<a name="line.37"></a>
<FONT color="green">038</FONT> public byte[] serialize(T o) throws SerializationException {<a name="line.38"></a>
<FONT color="green">039</FONT> if (o == null) {<a name="line.39"></a>
<FONT color="green">040</FONT> String msg = "argument cannot be null.";<a name="line.40"></a>
<FONT color="green">041</FONT> throw new IllegalArgumentException(msg);<a name="line.41"></a>
<FONT color="green">042</FONT> }<a name="line.42"></a>
<FONT color="green">043</FONT> ByteArrayOutputStream baos = new ByteArrayOutputStream();<a name="line.43"></a>
<FONT color="green">044</FONT> BufferedOutputStream bos = new BufferedOutputStream(baos);<a name="line.44"></a>
<FONT color="green">045</FONT> <a name="line.45"></a>
<FONT color="green">046</FONT> try {<a name="line.46"></a>
<FONT color="green">047</FONT> ObjectOutputStream oos = new ObjectOutputStream(bos);<a name="line.47"></a>
<FONT color="green">048</FONT> oos.writeObject(o);<a name="line.48"></a>
<FONT color="green">049</FONT> oos.close();<a name="line.49"></a>
<FONT color="green">050</FONT> return baos.toByteArray();<a name="line.50"></a>
<FONT color="green">051</FONT> } catch (IOException e) {<a name="line.51"></a>
<FONT color="green">052</FONT> String msg = "Unable to serialize object [" + o + "]. " +<a name="line.52"></a>
<FONT color="green">053</FONT> "In order for the DefaultSerializer to serialize this object, the [" + o.getClass().getName() + "] " +<a name="line.53"></a>
<FONT color="green">054</FONT> "class must implement java.io.Serializable.";<a name="line.54"></a>
<FONT color="green">055</FONT> throw new SerializationException(msg, e);<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> <a name="line.58"></a>
<FONT color="green">059</FONT> /**<a name="line.59"></a>
<FONT color="green">060</FONT> * This implementation deserializes the byte array using a {@link ObjectInputStream} using a source<a name="line.60"></a>
<FONT color="green">061</FONT> * {@link ByteArrayInputStream} constructed with the argument byte array.<a name="line.61"></a>
<FONT color="green">062</FONT> *<a name="line.62"></a>
<FONT color="green">063</FONT> * @param serialized the raw data resulting from a previous {@link #serialize(Object) serialize} call.<a name="line.63"></a>
<FONT color="green">064</FONT> * @return the deserialized/reconstituted object based on the given byte array<a name="line.64"></a>
<FONT color="green">065</FONT> * @throws SerializationException if anything goes wrong using the streams.<a name="line.65"></a>
<FONT color="green">066</FONT> */<a name="line.66"></a>
<FONT color="green">067</FONT> public T deserialize(byte[] serialized) throws SerializationException {<a name="line.67"></a>
<FONT color="green">068</FONT> if (serialized == null) {<a name="line.68"></a>
<FONT color="green">069</FONT> String msg = "argument cannot be null.";<a name="line.69"></a>
<FONT color="green">070</FONT> throw new IllegalArgumentException(msg);<a name="line.70"></a>
<FONT color="green">071</FONT> }<a name="line.71"></a>
<FONT color="green">072</FONT> ByteArrayInputStream bais = new ByteArrayInputStream(serialized);<a name="line.72"></a>
<FONT color="green">073</FONT> BufferedInputStream bis = new BufferedInputStream(bais);<a name="line.73"></a>
<FONT color="green">074</FONT> try {<a name="line.74"></a>
<FONT color="green">075</FONT> ObjectInputStream ois = new ClassResolvingObjectInputStream(bis);<a name="line.75"></a>
<FONT color="green">076</FONT> @SuppressWarnings({"unchecked"})<a name="line.76"></a>
<FONT color="green">077</FONT> T deserialized = (T) ois.readObject();<a name="line.77"></a>
<FONT color="green">078</FONT> ois.close();<a name="line.78"></a>
<FONT color="green">079</FONT> return deserialized;<a name="line.79"></a>
<FONT color="green">080</FONT> } catch (Exception e) {<a name="line.80"></a>
<FONT color="green">081</FONT> String msg = "Unable to deserialze argument byte array.";<a name="line.81"></a>
<FONT color="green">082</FONT> throw new SerializationException(msg, e);<a name="line.82"></a>
<FONT color="green">083</FONT> }<a name="line.83"></a>
<FONT color="green">084</FONT> }<a name="line.84"></a>
<FONT color="green">085</FONT> }<a name="line.85"></a>
</PRE>
</BODY>
</HTML>