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