| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> |
| <title>SPStateManager (Apache CXF JavaDoc 3.1.0 API)</title> |
| <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="SPStateManager (Apache CXF JavaDoc 3.1.0 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/SPStateManager.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 class="aboutLanguage"><em>Apache CXF API</em></div> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../../../../org/apache/cxf/rs/security/saml/sso/state/ResponseState.html" title="class in org.apache.cxf.rs.security.saml.sso.state"><span class="strong">Prev Class</span></a></li> |
| <li>Next Class</li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../../../index.html?org/apache/cxf/rs/security/saml/sso/state/SPStateManager.html" target="_top">Frames</a></li> |
| <li><a href="SPStateManager.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.cxf.rs.security.saml.sso.state</div> |
| <h2 title="Interface SPStateManager" class="title">Interface SPStateManager</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Superinterfaces:</dt> |
| <dd><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/AutoCloseable.html?is-external=true" title="class or interface in java.lang">AutoCloseable</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/io/Closeable.html?is-external=true" title="class or interface in java.io">Closeable</a></dd> |
| </dl> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><a href="../../../../../../../../org/apache/cxf/rs/security/saml/sso/state/EHCacheSPStateManager.html" title="class in org.apache.cxf.rs.security.saml.sso.state">EHCacheSPStateManager</a>, <a href="../../../../../../../../org/apache/cxf/rs/security/saml/sso/state/HTTPSPStateManager.html" title="class in org.apache.cxf.rs.security.saml.sso.state">HTTPSPStateManager</a>, <a href="../../../../../../../../org/apache/cxf/rs/security/saml/sso/state/MemorySPStateManager.html" title="class in org.apache.cxf.rs.security.saml.sso.state">MemorySPStateManager</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="strong">SPStateManager</span> |
| extends <a href="http://docs.oracle.com/javase/7/docs/api/java/io/Closeable.html?is-external=true" title="class or interface in java.io">Closeable</a></pre> |
| <div class="block">SSO Service Provider State Manager. |
| |
| TODO: review the possibility of working with the Servlet HTTPSession |
| instead; in that case it can be tricky to configure various containers |
| (Tomcat, Jetty) to make sure the cookies are shared across multiple |
| war contexts which will be needed if RequestAssertionConsumerService |
| needs to be run in its own war file instead of having every application |
| war on the SP side have a dedicated RequestAssertionConsumerService endpoint</div> |
| </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>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../../../org/apache/cxf/rs/security/saml/sso/state/SPStateManager.html#close()">close</a></strong>()</code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../../../../org/apache/cxf/rs/security/saml/sso/state/ResponseState.html" title="class in org.apache.cxf.rs.security.saml.sso.state">ResponseState</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../../../org/apache/cxf/rs/security/saml/sso/state/SPStateManager.html#getResponseState(java.lang.String)">getResponseState</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> contextKey)</code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../../../../org/apache/cxf/rs/security/saml/sso/state/RequestState.html" title="class in org.apache.cxf.rs.security.saml.sso.state">RequestState</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../../../org/apache/cxf/rs/security/saml/sso/state/SPStateManager.html#removeRequestState(java.lang.String)">removeRequestState</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> relayState)</code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../../../../org/apache/cxf/rs/security/saml/sso/state/ResponseState.html" title="class in org.apache.cxf.rs.security.saml.sso.state">ResponseState</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../../../org/apache/cxf/rs/security/saml/sso/state/SPStateManager.html#removeResponseState(java.lang.String)">removeResponseState</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> contextKey)</code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../../../org/apache/cxf/rs/security/saml/sso/state/SPStateManager.html#setRequestState(java.lang.String,%20org.apache.cxf.rs.security.saml.sso.state.RequestState)">setRequestState</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> relayState, |
| <a href="../../../../../../../../org/apache/cxf/rs/security/saml/sso/state/RequestState.html" title="class in org.apache.cxf.rs.security.saml.sso.state">RequestState</a> state)</code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../../../org/apache/cxf/rs/security/saml/sso/state/SPStateManager.html#setResponseState(java.lang.String,%20org.apache.cxf.rs.security.saml.sso.state.ResponseState)">setResponseState</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> contextKey, |
| <a href="../../../../../../../../org/apache/cxf/rs/security/saml/sso/state/ResponseState.html" title="class in org.apache.cxf.rs.security.saml.sso.state">ResponseState</a> state)</code> </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="setRequestState(java.lang.String, org.apache.cxf.rs.security.saml.sso.state.RequestState)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setRequestState</h4> |
| <pre>void setRequestState(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> relayState, |
| <a href="../../../../../../../../org/apache/cxf/rs/security/saml/sso/state/RequestState.html" title="class in org.apache.cxf.rs.security.saml.sso.state">RequestState</a> state)</pre> |
| </li> |
| </ul> |
| <a name="removeRequestState(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>removeRequestState</h4> |
| <pre><a href="../../../../../../../../org/apache/cxf/rs/security/saml/sso/state/RequestState.html" title="class in org.apache.cxf.rs.security.saml.sso.state">RequestState</a> removeRequestState(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> relayState)</pre> |
| </li> |
| </ul> |
| <a name="setResponseState(java.lang.String, org.apache.cxf.rs.security.saml.sso.state.ResponseState)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setResponseState</h4> |
| <pre>void setResponseState(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> contextKey, |
| <a href="../../../../../../../../org/apache/cxf/rs/security/saml/sso/state/ResponseState.html" title="class in org.apache.cxf.rs.security.saml.sso.state">ResponseState</a> state)</pre> |
| </li> |
| </ul> |
| <a name="getResponseState(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getResponseState</h4> |
| <pre><a href="../../../../../../../../org/apache/cxf/rs/security/saml/sso/state/ResponseState.html" title="class in org.apache.cxf.rs.security.saml.sso.state">ResponseState</a> getResponseState(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> contextKey)</pre> |
| </li> |
| </ul> |
| <a name="removeResponseState(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>removeResponseState</h4> |
| <pre><a href="../../../../../../../../org/apache/cxf/rs/security/saml/sso/state/ResponseState.html" title="class in org.apache.cxf.rs.security.saml.sso.state">ResponseState</a> removeResponseState(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> contextKey)</pre> |
| </li> |
| </ul> |
| <a name="close()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>close</h4> |
| <pre>void close() |
| throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/AutoCloseable.html?is-external=true#close()" title="class or interface in java.lang">close</a></code> in interface <code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/AutoCloseable.html?is-external=true" title="class or interface in java.lang">AutoCloseable</a></code></dd> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/Closeable.html?is-external=true#close()" title="class or interface in java.io">close</a></code> in interface <code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/Closeable.html?is-external=true" title="class or interface in java.io">Closeable</a></code></dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></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/SPStateManager.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 class="aboutLanguage"><em>Apache CXF API</em></div> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../../../../org/apache/cxf/rs/security/saml/sso/state/ResponseState.html" title="class in org.apache.cxf.rs.security.saml.sso.state"><span class="strong">Prev Class</span></a></li> |
| <li>Next Class</li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../../../index.html?org/apache/cxf/rs/security/saml/sso/state/SPStateManager.html" target="_top">Frames</a></li> |
| <li><a href="SPStateManager.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>Apache CXF</small></p> |
| </body> |
| </html> |
