| <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> /**<a name="line.21"></a> |
| <FONT color="green">022</FONT> * A <code>Serializer</code> converts objects to raw binary data and vice versa, enabling persistent storage<a name="line.22"></a> |
| <FONT color="green">023</FONT> * of objects to files, HTTP cookies, or other mechanism.<a name="line.23"></a> |
| <FONT color="green">024</FONT> * <p/><a name="line.24"></a> |
| <FONT color="green">025</FONT> * A <code>Serializer</code> should only do conversion, never change the data, such as encoding/decoding or<a name="line.25"></a> |
| <FONT color="green">026</FONT> * encryption. These orthogonal concerns are handled elsewhere by Shiro, for example, via<a name="line.26"></a> |
| <FONT color="green">027</FONT> * {@link org.apache.shiro.codec.CodecSupport CodecSupport} and {@link org.apache.shiro.crypto.CipherService CipherService}s.<a name="line.27"></a> |
| <FONT color="green">028</FONT> *<a name="line.28"></a> |
| <FONT color="green">029</FONT> * @param <T> The type of the object being serialized and deserialized.<a name="line.29"></a> |
| <FONT color="green">030</FONT> * @since 0.9<a name="line.30"></a> |
| <FONT color="green">031</FONT> */<a name="line.31"></a> |
| <FONT color="green">032</FONT> public interface Serializer<T> {<a name="line.32"></a> |
| <FONT color="green">033</FONT> <a name="line.33"></a> |
| <FONT color="green">034</FONT> /**<a name="line.34"></a> |
| <FONT color="green">035</FONT> * Converts the specified Object into a byte[] array. This byte[] array must be able to be reconstructed<a name="line.35"></a> |
| <FONT color="green">036</FONT> * back into the original Object form via the {@link #deserialize(byte[]) deserialize} method.<a name="line.36"></a> |
| <FONT color="green">037</FONT> *<a name="line.37"></a> |
| <FONT color="green">038</FONT> * @param o the Object to convert into a byte[] array.<a name="line.38"></a> |
| <FONT color="green">039</FONT> * @return a byte[] array representing the Object's state that can be restored later.<a name="line.39"></a> |
| <FONT color="green">040</FONT> * @throws SerializationException if an error occurrs converting the Object into a byte[] array.<a name="line.40"></a> |
| <FONT color="green">041</FONT> */<a name="line.41"></a> |
| <FONT color="green">042</FONT> byte[] serialize(T o) throws SerializationException;<a name="line.42"></a> |
| <FONT color="green">043</FONT> <a name="line.43"></a> |
| <FONT color="green">044</FONT> /**<a name="line.44"></a> |
| <FONT color="green">045</FONT> * Converts the specified raw byte[] array back into an original Object form. This byte[] array is expected to<a name="line.45"></a> |
| <FONT color="green">046</FONT> * be the output of a previous {@link #serialize(Object) serialize} method call.<a name="line.46"></a> |
| <FONT color="green">047</FONT> *<a name="line.47"></a> |
| <FONT color="green">048</FONT> * @param serialized the raw data resulting from a previous {@link #serialize(Object) serialize} call.<a name="line.48"></a> |
| <FONT color="green">049</FONT> * @return the Object that was previously serialized into the raw byte[] array.<a name="line.49"></a> |
| <FONT color="green">050</FONT> * @throws SerializationException if an error occurrs converting the raw byte[] array back into an Object.<a name="line.50"></a> |
| <FONT color="green">051</FONT> */<a name="line.51"></a> |
| <FONT color="green">052</FONT> T deserialize(byte[] serialized) throws SerializationException;<a name="line.52"></a> |
| <FONT color="green">053</FONT> }<a name="line.53"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </PRE> |
| </BODY> |
| </HTML> |
