| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (version 1.7.0_25) on Wed May 25 23:25:55 EDT 2016 --> |
| <meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> |
| <title>Serializer (Apache Shiro 1.2.5 API)</title> |
| <meta name="date" content="2016-05-25"> |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="Serializer (Apache Shiro 1.2.5 API)"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar_top"> |
| <!-- --> |
| </a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/Serializer.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../org/apache/shiro/io/SerializationException.html" title="class in org.apache.shiro.io"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/shiro/io/XmlSerializer.html" title="class in org.apache.shiro.io"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/shiro/io/Serializer.html" target="_top">Frames</a></li> |
| <li><a href="Serializer.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method_detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip-navbar_top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.apache.shiro.io</div> |
| <h2 title="Interface Serializer" class="title">Interface Serializer<T></h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl><dt><span class="strong">Type Parameters:</span></dt><dd><code>T</code> - The type of the object being serialized and deserialized.</dd></dl> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><a href="../../../../org/apache/shiro/io/DefaultSerializer.html" title="class in org.apache.shiro.io">DefaultSerializer</a>, <a href="../../../../org/apache/shiro/io/XmlSerializer.html" title="class in org.apache.shiro.io">XmlSerializer</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <a href="../../../../src-html/org/apache/shiro/io/Serializer.html#line.32">Serializer</a><T></pre> |
| <div class="block">A <code>Serializer</code> converts objects to raw binary data and vice versa, enabling persistent storage |
| of objects to files, HTTP cookies, or other mechanism. |
| <p/> |
| A <code>Serializer</code> should only do conversion, never change the data, such as encoding/decoding or |
| encryption. These orthogonal concerns are handled elsewhere by Shiro, for example, via |
| <a href="../../../../org/apache/shiro/codec/CodecSupport.html" title="class in org.apache.shiro.codec"><code>CodecSupport</code></a> and <a href="../../../../org/apache/shiro/crypto/CipherService.html" title="interface in org.apache.shiro.crypto"><code>CipherService</code></a>s.</div> |
| <dl><dt><span class="strong">Since:</span></dt> |
| <dd>0.9</dd></dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method_summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span>Methods</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/shiro/io/Serializer.html" title="type parameter in Serializer">T</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/shiro/io/Serializer.html#deserialize(byte[])">deserialize</a></strong>(byte[] serialized)</code> |
| <div class="block">Converts the specified raw byte[] array back into an original Object form.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>byte[]</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/shiro/io/Serializer.html#serialize(T)">serialize</a></strong>(<a href="../../../../org/apache/shiro/io/Serializer.html" title="type parameter in Serializer">T</a> o)</code> |
| <div class="block">Converts the specified Object into a byte[] array.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method_detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="serialize(java.lang.Object)"> |
| <!-- --> |
| </a><a name="serialize(T)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>serialize</h4> |
| <pre>byte[] <a href="../../../../src-html/org/apache/shiro/io/Serializer.html#line.42">serialize</a>(<a href="../../../../org/apache/shiro/io/Serializer.html" title="type parameter in Serializer">T</a> o) |
| throws <a href="../../../../org/apache/shiro/io/SerializationException.html" title="class in org.apache.shiro.io">SerializationException</a></pre> |
| <div class="block">Converts the specified Object into a byte[] array. This byte[] array must be able to be reconstructed |
| back into the original Object form via the <a href="../../../../org/apache/shiro/io/Serializer.html#deserialize(byte[])"><code>deserialize</code></a> method.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>o</code> - the Object to convert into a byte[] array.</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>a byte[] array representing the Object's state that can be restored later.</dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="../../../../org/apache/shiro/io/SerializationException.html" title="class in org.apache.shiro.io">SerializationException</a></code> - if an error occurrs converting the Object into a byte[] array.</dd></dl> |
| </li> |
| </ul> |
| <a name="deserialize(byte[])"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>deserialize</h4> |
| <pre><a href="../../../../org/apache/shiro/io/Serializer.html" title="type parameter in Serializer">T</a> <a href="../../../../src-html/org/apache/shiro/io/Serializer.html#line.52">deserialize</a>(byte[] serialized) |
| throws <a href="../../../../org/apache/shiro/io/SerializationException.html" title="class in org.apache.shiro.io">SerializationException</a></pre> |
| <div class="block">Converts the specified raw byte[] array back into an original Object form. This byte[] array is expected to |
| be the output of a previous <a href="../../../../org/apache/shiro/io/Serializer.html#serialize(T)"><code>serialize</code></a> method call.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>serialized</code> - the raw data resulting from a previous <a href="../../../../org/apache/shiro/io/Serializer.html#serialize(T)"><code>serialize</code></a> call.</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>the Object that was previously serialized into the raw byte[] array.</dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="../../../../org/apache/shiro/io/SerializationException.html" title="class in org.apache.shiro.io">SerializationException</a></code> - if an error occurrs converting the raw byte[] array back into an Object.</dd></dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar_bottom"> |
| <!-- --> |
| </a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/Serializer.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../org/apache/shiro/io/SerializationException.html" title="class in org.apache.shiro.io"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/shiro/io/XmlSerializer.html" title="class in org.apache.shiro.io"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/shiro/io/Serializer.html" target="_top">Frames</a></li> |
| <li><a href="Serializer.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method_detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip-navbar_bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small>Copyright © 2004-2016 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.</small></p> |
| </body> |
| </html> |
