blob: 1c1007557aaae54aeb050757ce6e90275d6058f8 [file] [log] [blame]
<!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>RequestAssertionConsumerService (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="RequestAssertionConsumerService (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/RequestAssertionConsumerService.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/RequestAssertionConsumerFilter.html" title="class in org.apache.cxf.rs.security.saml.sso"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../../../org/apache/cxf/rs/security/saml/sso/SamlPostBindingFilter.html" title="class in org.apache.cxf.rs.security.saml.sso"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../index.html?org/apache/cxf/rs/security/saml/sso/RequestAssertionConsumerService.html" target="_top">Frames</a></li>
<li><a href="RequestAssertionConsumerService.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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</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</div>
<h2 title="Class RequestAssertionConsumerService" class="title">Class RequestAssertionConsumerService</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li><a href="../../../../../../../org/apache/cxf/rs/security/saml/sso/AbstractSSOSpHandler.html" title="class in org.apache.cxf.rs.security.saml.sso">org.apache.cxf.rs.security.saml.sso.AbstractSSOSpHandler</a></li>
<li>
<ul class="inheritance">
<li><a href="../../../../../../../org/apache/cxf/rs/security/saml/sso/AbstractRequestAssertionConsumerHandler.html" title="class in org.apache.cxf.rs.security.saml.sso">org.apache.cxf.rs.security.saml.sso.AbstractRequestAssertionConsumerHandler</a></li>
<li>
<ul class="inheritance">
<li>org.apache.cxf.rs.security.saml.sso.RequestAssertionConsumerService</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>@Path(value="sso")
public class <span class="strong">RequestAssertionConsumerService</span>
extends <a href="../../../../../../../org/apache/cxf/rs/security/saml/sso/AbstractRequestAssertionConsumerHandler.html" title="class in org.apache.cxf.rs.security.saml.sso">AbstractRequestAssertionConsumerHandler</a></pre>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../../../../../org/apache/cxf/rs/security/saml/sso/RequestAssertionConsumerService.html#RequestAssertionConsumerService()">RequestAssertionConsumerService</a></strong>()</code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ========== 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">&nbsp;</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>javax.ws.rs.core.Response</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/cxf/rs/security/saml/sso/RequestAssertionConsumerService.html#getSamlResponse(java.lang.String,%20java.lang.String)">getSamlResponse</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>&nbsp;encodedSamlResponse,
<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>&nbsp;relayState)</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>javax.ws.rs.core.Response</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/cxf/rs/security/saml/sso/RequestAssertionConsumerService.html#processSamlResponse(java.lang.String,%20java.lang.String)">processSamlResponse</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>&nbsp;encodedSamlResponse,
<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>&nbsp;relayState)</code>&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_org.apache.cxf.rs.security.saml.sso.AbstractRequestAssertionConsumerHandler">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.cxf.rs.security.saml.sso.<a href="../../../../../../../org/apache/cxf/rs/security/saml/sso/AbstractRequestAssertionConsumerHandler.html" title="class in org.apache.cxf.rs.security.saml.sso">AbstractRequestAssertionConsumerHandler</a></h3>
<code><a href="../../../../../../../org/apache/cxf/rs/security/saml/sso/AbstractRequestAssertionConsumerHandler.html#close()">close</a>, <a href="../../../../../../../org/apache/cxf/rs/security/saml/sso/AbstractRequestAssertionConsumerHandler.html#createSecurityContext(org.apache.cxf.rs.security.saml.sso.state.RequestState,%20java.lang.String,%20java.lang.String,%20boolean)">createSecurityContext</a>, <a href="../../../../../../../org/apache/cxf/rs/security/saml/sso/AbstractRequestAssertionConsumerHandler.html#doProcessSamlResponse(java.lang.String,%20java.lang.String,%20boolean)">doProcessSamlResponse</a>, <a href="../../../../../../../org/apache/cxf/rs/security/saml/sso/AbstractRequestAssertionConsumerHandler.html#getReplayCache()">getReplayCache</a>, <a href="../../../../../../../org/apache/cxf/rs/security/saml/sso/AbstractRequestAssertionConsumerHandler.html#isSupportBase64Encoding()">isSupportBase64Encoding</a>, <a href="../../../../../../../org/apache/cxf/rs/security/saml/sso/AbstractRequestAssertionConsumerHandler.html#isSupportDeflateEncoding()">isSupportDeflateEncoding</a>, <a href="../../../../../../../org/apache/cxf/rs/security/saml/sso/AbstractRequestAssertionConsumerHandler.html#processRelayState(java.lang.String)">processRelayState</a>, <a href="../../../../../../../org/apache/cxf/rs/security/saml/sso/AbstractRequestAssertionConsumerHandler.html#reportError(java.lang.String)">reportError</a>, <a href="../../../../../../../org/apache/cxf/rs/security/saml/sso/AbstractRequestAssertionConsumerHandler.html#setEnforceAssertionsSigned(boolean)">setEnforceAssertionsSigned</a>, <a href="../../../../../../../org/apache/cxf/rs/security/saml/sso/AbstractRequestAssertionConsumerHandler.html#setEnforceKnownIssuer(boolean)">setEnforceKnownIssuer</a>, <a href="../../../../../../../org/apache/cxf/rs/security/saml/sso/AbstractRequestAssertionConsumerHandler.html#setKeyInfoMustBeAvailable(boolean)">setKeyInfoMustBeAvailable</a>, <a href="../../../../../../../org/apache/cxf/rs/security/saml/sso/AbstractRequestAssertionConsumerHandler.html#setMessageContext(org.apache.cxf.jaxrs.ext.MessageContext)">setMessageContext</a>, <a href="../../../../../../../org/apache/cxf/rs/security/saml/sso/AbstractRequestAssertionConsumerHandler.html#setReplayCache(org.apache.cxf.rs.security.saml.sso.TokenReplayCache)">setReplayCache</a>, <a href="../../../../../../../org/apache/cxf/rs/security/saml/sso/AbstractRequestAssertionConsumerHandler.html#setSupportBase64Encoding(boolean)">setSupportBase64Encoding</a>, <a href="../../../../../../../org/apache/cxf/rs/security/saml/sso/AbstractRequestAssertionConsumerHandler.html#setSupportDeflateEncoding(boolean)">setSupportDeflateEncoding</a>, <a href="../../../../../../../org/apache/cxf/rs/security/saml/sso/AbstractRequestAssertionConsumerHandler.html#validateSamlResponseProtocol(org.opensaml.saml.saml2.core.Response)">validateSamlResponseProtocol</a>, <a href="../../../../../../../org/apache/cxf/rs/security/saml/sso/AbstractRequestAssertionConsumerHandler.html#validateSamlSSOResponse(boolean,%20org.opensaml.saml.saml2.core.Response,%20org.apache.cxf.rs.security.saml.sso.state.RequestState)">validateSamlSSOResponse</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_org.apache.cxf.rs.security.saml.sso.AbstractSSOSpHandler">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.cxf.rs.security.saml.sso.<a href="../../../../../../../org/apache/cxf/rs/security/saml/sso/AbstractSSOSpHandler.html" title="class in org.apache.cxf.rs.security.saml.sso">AbstractSSOSpHandler</a></h3>
<code><a href="../../../../../../../org/apache/cxf/rs/security/saml/sso/AbstractSSOSpHandler.html#createCookie(java.lang.String,%20java.lang.String,%20java.lang.String,%20java.lang.String)">createCookie</a>, <a href="../../../../../../../org/apache/cxf/rs/security/saml/sso/AbstractSSOSpHandler.html#getCallbackHandler()">getCallbackHandler</a>, <a href="../../../../../../../org/apache/cxf/rs/security/saml/sso/AbstractSSOSpHandler.html#getSignatureCrypto()">getSignatureCrypto</a>, <a href="../../../../../../../org/apache/cxf/rs/security/saml/sso/AbstractSSOSpHandler.html#getSignatureUsername()">getSignatureUsername</a>, <a href="../../../../../../../org/apache/cxf/rs/security/saml/sso/AbstractSSOSpHandler.html#getStateProvider()">getStateProvider</a>, <a href="../../../../../../../org/apache/cxf/rs/security/saml/sso/AbstractSSOSpHandler.html#getStateTimeToLive()">getStateTimeToLive</a>, <a href="../../../../../../../org/apache/cxf/rs/security/saml/sso/AbstractSSOSpHandler.html#isStateExpired(long,%20long)">isStateExpired</a>, <a href="../../../../../../../org/apache/cxf/rs/security/saml/sso/AbstractSSOSpHandler.html#setCallbackHandler(javax.security.auth.callback.CallbackHandler)">setCallbackHandler</a>, <a href="../../../../../../../org/apache/cxf/rs/security/saml/sso/AbstractSSOSpHandler.html#setCallbackHandlerClass(java.lang.String)">setCallbackHandlerClass</a>, <a href="../../../../../../../org/apache/cxf/rs/security/saml/sso/AbstractSSOSpHandler.html#setSignatureCrypto(org.apache.wss4j.common.crypto.Crypto)">setSignatureCrypto</a>, <a href="../../../../../../../org/apache/cxf/rs/security/saml/sso/AbstractSSOSpHandler.html#setSignaturePropertiesFile(java.lang.String)">setSignaturePropertiesFile</a>, <a href="../../../../../../../org/apache/cxf/rs/security/saml/sso/AbstractSSOSpHandler.html#setSignatureUsername(java.lang.String)">setSignatureUsername</a>, <a href="../../../../../../../org/apache/cxf/rs/security/saml/sso/AbstractSSOSpHandler.html#setStateProvider(org.apache.cxf.rs.security.saml.sso.state.SPStateManager)">setStateProvider</a>, <a href="../../../../../../../org/apache/cxf/rs/security/saml/sso/AbstractSSOSpHandler.html#setStateTimeToLive(long)">setStateTimeToLive</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait(long,%20int)" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="RequestAssertionConsumerService()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>RequestAssertionConsumerService</h4>
<pre>public&nbsp;RequestAssertionConsumerService()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="processSamlResponse(java.lang.String, java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>processSamlResponse</h4>
<pre>@POST
@Produces(value="application/x-www-form-urlencoded")
public&nbsp;javax.ws.rs.core.Response&nbsp;processSamlResponse(@FormParam(value="SAMLResponse")
<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>&nbsp;encodedSamlResponse,
@FormParam(value="RelayState")
<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>&nbsp;relayState)</pre>
</li>
</ul>
<a name="getSamlResponse(java.lang.String, java.lang.String)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getSamlResponse</h4>
<pre>@GET
public&nbsp;javax.ws.rs.core.Response&nbsp;getSamlResponse(@QueryParam(value="SAMLResponse")
<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>&nbsp;encodedSamlResponse,
@QueryParam(value="RelayState")
<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>&nbsp;relayState)</pre>
</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/RequestAssertionConsumerService.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/RequestAssertionConsumerFilter.html" title="class in org.apache.cxf.rs.security.saml.sso"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../../../org/apache/cxf/rs/security/saml/sso/SamlPostBindingFilter.html" title="class in org.apache.cxf.rs.security.saml.sso"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../index.html?org/apache/cxf/rs/security/saml/sso/RequestAssertionConsumerService.html" target="_top">Frames</a></li>
<li><a href="RequestAssertionConsumerService.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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</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>