| <!DOCTYPE HTML> |
| <html lang> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>Serialized Form (Apache Rampart)</title> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="description" content="serialized forms"> |
| <meta name="generator" content="javadoc/SerializedFormWriterImpl"> |
| <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="script-dir/jquery-ui.min.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="jquery-ui.overrides.css" title="Style"> |
| <script type="text/javascript" src="script.js"></script> |
| <script type="text/javascript" src="script-dir/jquery-3.6.1.min.js"></script> |
| <script type="text/javascript" src="script-dir/jquery-ui.min.js"></script> |
| </head> |
| <body class="serialized-form-page"> |
| <script type="text/javascript">var pathtoroot = "./"; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <div class="flex-box"> |
| <header role="banner" class="flex-header"> |
| <nav role="navigation"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="top-nav" id="navbar-top"> |
| <div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> |
| <ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> |
| <li><a href="index.html">Overview</a></li> |
| <li>Package</li> |
| <li>Class</li> |
| <li>Use</li> |
| <li><a href="overview-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#serialized-form">Help</a></li> |
| </ul> |
| </div> |
| <div class="sub-nav"> |
| <div class="nav-list-search"><label for="search-input">SEARCH:</label> |
| <input type="text" id="search-input" value="search" disabled="disabled"> |
| <input type="reset" id="reset-button" value="reset" disabled="disabled"> |
| </div> |
| </div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <span class="skip-nav" id="skip-navbar-top"></span></nav> |
| </header> |
| <div class="flex-content"> |
| <main role="main"> |
| <div class="header"> |
| <h1 title="Serialized Form" class="title">Serialized Form</h1> |
| </div> |
| <ul class="block-list"> |
| <li> |
| <section class="serialized-package-container"> |
| <h2 title="Package">Package <a href="org/apache/rahas/package-summary.html">org.apache.rahas</a></h2> |
| <ul class="block-list"> |
| <li> |
| <section class="serialized-class-details" id="org.apache.rahas.EncryptedKeyToken"> |
| <h3>Class <a href="org/apache/rahas/EncryptedKeyToken.html" title="class in org.apache.rahas">org.apache.rahas.EncryptedKeyToken</a></h3> |
| <div class="type-signature">class EncryptedKeyToken extends <a href="org/apache/rahas/Token.html" title="class in org.apache.rahas">Token</a> implements <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/Externalizable.html" title="class or interface in java.io" class="external-link">Externalizable</a></div> |
| <ul class="block-list"> |
| <li> |
| <section class="detail"> |
| <h4>Serialization Methods</h4> |
| <ul class="block-list"> |
| <li class="block-list"> |
| <h5>readExternal</h5> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">readExternal</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/ObjectInput.html" title="class or interface in java.io" class="external-link">ObjectInput</a> in)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/ClassNotFoundException.html" title="class or interface in java.lang" class="external-link">ClassNotFoundException</a>, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>in</code> - Stream which used to read data.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code> - If unable to de-serialize particular data member.</dd> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/ClassNotFoundException.html" title="class or interface in java.lang" class="external-link">ClassNotFoundException</a></code></dd> |
| </dl> |
| </li> |
| <li class="block-list"> |
| <h5>writeExternal</h5> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">writeExternal</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/ObjectOutput.html" title="class or interface in java.io" class="external-link">ObjectOutput</a> out)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>out</code> - Stream which writes serialized bytes.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code> - If unable to serialize particular member.</dd> |
| </dl> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <li> |
| <section class="serialized-class-details" id="org.apache.rahas.SimpleTokenStore"> |
| <h3>Class <a href="org/apache/rahas/SimpleTokenStore.html" title="class in org.apache.rahas">org.apache.rahas.SimpleTokenStore</a></h3> |
| <div class="type-signature">class SimpleTokenStore extends <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> implements <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/Serializable.html" title="class or interface in java.io" class="external-link">Serializable</a></div> |
| <ul class="block-list"> |
| <li> |
| <section class="detail"> |
| <h4>Serialized Fields</h4> |
| <ul class="block-list"> |
| <li class="block-list"> |
| <h5>readLock</h5> |
| <pre><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/locks/Lock.html" title="class or interface in java.util.concurrent.locks" class="external-link">Lock</a> readLock</pre> |
| </li> |
| <li class="block-list"> |
| <h5>readWriteLock</h5> |
| <pre><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/locks/ReadWriteLock.html" title="class or interface in java.util.concurrent.locks" class="external-link">ReadWriteLock</a> readWriteLock</pre> |
| <div class="block">We use a read write lock to improve concurrency while avoiding concurrent modification |
| exceptions. We allow concurrent reads and avoid concurrent reads and modifications |
| ReentrantReadWriteLock supports a maximum of 65535 recursive write locks and 65535 read locks</div> |
| </li> |
| <li class="block-list"> |
| <h5>tokens</h5> |
| <pre><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a> tokens</pre> |
| </li> |
| <li class="block-list"> |
| <h5>writeLock</h5> |
| <pre><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/locks/Lock.html" title="class or interface in java.util.concurrent.locks" class="external-link">Lock</a> writeLock</pre> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <li> |
| <section class="serialized-class-details" id="org.apache.rahas.Token"> |
| <h3>Class <a href="org/apache/rahas/Token.html" title="class in org.apache.rahas">org.apache.rahas.Token</a></h3> |
| <div class="type-signature">class Token extends <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> implements <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/Externalizable.html" title="class or interface in java.io" class="external-link">Externalizable</a></div> |
| <ul class="block-list"> |
| <li> |
| <section class="detail"> |
| <h4>Serialization Methods</h4> |
| <ul class="block-list"> |
| <li class="block-list"> |
| <h5>readExternal</h5> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">readExternal</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/ObjectInput.html" title="class or interface in java.io" class="external-link">ObjectInput</a> in)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a>, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/ClassNotFoundException.html" title="class or interface in java.lang" class="external-link">ClassNotFoundException</a></span></div> |
| <div class="block">Implementing de-serialization logic in accordance with the serialization logic.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>in</code> - Stream which used to read data.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code> - If unable to de-serialize particular data member.</dd> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/ClassNotFoundException.html" title="class or interface in java.lang" class="external-link">ClassNotFoundException</a></code></dd> |
| </dl> |
| </li> |
| <li class="block-list"> |
| <h5>writeExternal</h5> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">writeExternal</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/ObjectOutput.html" title="class or interface in java.io" class="external-link">ObjectOutput</a> out)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div> |
| <div class="block">Implementing serialize logic according to our own protocol. We had to follow this, because |
| OMElement class is not serializable. Making OMElement serializable will have an huge impact |
| on other components. Therefore implementing serialization logic according to a manual |
| protocol.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>out</code> - Stream which writes serialized bytes.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code> - If unable to serialize particular member.</dd> |
| </dl> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <li> |
| <section class="serialized-class-details" id="org.apache.rahas.TrustException"> |
| <h3>Exception <a href="org/apache/rahas/TrustException.html" title="class in org.apache.rahas">org.apache.rahas.TrustException</a></h3> |
| <div class="type-signature">class TrustException extends <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html" title="class or interface in java.lang" class="external-link">Exception</a> implements <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/Serializable.html" title="class or interface in java.io" class="external-link">Serializable</a></div> |
| <dl class="name-value"> |
| <dt>serialVersionUID:</dt> |
| <dd>-445341784514373965L</dd> |
| </dl> |
| <ul class="block-list"> |
| <li> |
| <section class="detail"> |
| <h4>Serialized Fields</h4> |
| <ul class="block-list"> |
| <li class="block-list"> |
| <h5>faultCode</h5> |
| <pre><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> faultCode</pre> |
| </li> |
| <li class="block-list"> |
| <h5>faultString</h5> |
| <pre><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> faultString</pre> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <li> |
| <section class="serialized-package-container"> |
| <h2 title="Package">Package <a href="org/apache/rampart/package-summary.html">org.apache.rampart</a></h2> |
| <ul class="block-list"> |
| <li> |
| <section class="serialized-class-details" id="org.apache.rampart.RampartException"> |
| <h3>Exception <a href="org/apache/rampart/RampartException.html" title="class in org.apache.rampart">org.apache.rampart.RampartException</a></h3> |
| <div class="type-signature">class RampartException extends <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html" title="class or interface in java.lang" class="external-link">Exception</a> implements <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/Serializable.html" title="class or interface in java.io" class="external-link">Serializable</a></div> |
| <dl class="name-value"> |
| <dt>serialVersionUID:</dt> |
| <dd>8674795537585339704L</dd> |
| </dl> |
| <ul class="block-list"> |
| <li> |
| <section class="detail"> |
| <h4>Serialized Fields</h4> |
| <ul class="block-list"> |
| <li class="block-list"> |
| <h5>faultCode</h5> |
| <pre><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> faultCode</pre> |
| </li> |
| <li class="block-list"> |
| <h5>faultString</h5> |
| <pre><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> faultString</pre> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <li> |
| <section class="serialized-package-container"> |
| <h2 title="Package">Package <a href="org/apache/ws/secpolicy/package-summary.html">org.apache.ws.secpolicy</a></h2> |
| <ul class="block-list"> |
| <li> |
| <section class="serialized-class-details" id="org.apache.ws.secpolicy.WSSPolicyException"> |
| <h3>Exception <a href="org/apache/ws/secpolicy/WSSPolicyException.html" title="class in org.apache.ws.secpolicy">org.apache.ws.secpolicy.WSSPolicyException</a></h3> |
| <div class="type-signature">class WSSPolicyException extends <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html" title="class or interface in java.lang" class="external-link">Exception</a> implements <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/Serializable.html" title="class or interface in java.io" class="external-link">Serializable</a></div> |
| <dl class="name-value"> |
| <dt>serialVersionUID:</dt> |
| <dd>5904800255533588133L</dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </main> |
| <footer role="contentinfo"> |
| <hr> |
| <p class="legal-copy"><small>Copyright © <a href="http://www.apache.org">Apache Software Foundation</a>. All Rights Reserved.</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |
