| <!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>SAMLDelegationHandler (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="SAMLDelegationHandler (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/SAMLDelegationHandler.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/sts/token/delegation/HOKDelegationHandler.html" title="class in org.apache.cxf.sts.token.delegation"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../../../org/apache/cxf/sts/token/delegation/TokenDelegationHandler.html" title="interface in org.apache.cxf.sts.token.delegation"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/cxf/sts/token/delegation/SAMLDelegationHandler.html" target="_top">Frames</a></li> |
| <li><a href="SAMLDelegationHandler.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><a href="#constructor_summary">Constr</a> | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor_detail">Constr</a> | </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.sts.token.delegation</div> |
| <h2 title="Class SAMLDelegationHandler" class="title">Class SAMLDelegationHandler</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>org.apache.cxf.sts.token.delegation.SAMLDelegationHandler</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><a href="../../../../../../org/apache/cxf/sts/token/delegation/TokenDelegationHandler.html" title="interface in org.apache.cxf.sts.token.delegation">TokenDelegationHandler</a></dd> |
| </dl> |
| <dl> |
| <dt>Direct Known Subclasses:</dt> |
| <dd><a href="../../../../../../org/apache/cxf/sts/token/delegation/HOKDelegationHandler.html" title="class in org.apache.cxf.sts.token.delegation">HOKDelegationHandler</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public class <span class="strong">SAMLDelegationHandler</span> |
| extends <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> |
| implements <a href="../../../../../../org/apache/cxf/sts/token/delegation/TokenDelegationHandler.html" title="interface in org.apache.cxf.sts.token.delegation">TokenDelegationHandler</a></pre> |
| <div class="block">The SAML TokenDelegationHandler implementation. It disallows ActAs or OnBehalfOf for |
| all cases apart from the case of a Bearer SAML Token. In addition, the AppliesTo |
| address (if supplied) must match an AudienceRestriction address (if in token), if the |
| "checkAudienceRestriction" property is set to "true".</div> |
| </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"> </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/sts/token/delegation/SAMLDelegationHandler.html#SAMLDelegationHandler()">SAMLDelegationHandler</a></strong>()</code> </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"> </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>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../org/apache/cxf/sts/token/delegation/SAMLDelegationHandler.html#canHandleToken(org.apache.cxf.sts.request.ReceivedToken)">canHandleToken</a></strong>(<a href="../../../../../../org/apache/cxf/sts/request/ReceivedToken.html" title="class in org.apache.cxf.sts.request">ReceivedToken</a> delegateTarget)</code> |
| <div class="block">Return true if this TokenDelegationHandler implementation is capable of handling the |
| ReceivedToken argument.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected <a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<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>></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../org/apache/cxf/sts/token/delegation/SAMLDelegationHandler.html#getAudienceRestrictions(org.apache.wss4j.common.saml.SamlAssertionWrapper)">getAudienceRestrictions</a></strong>(org.apache.wss4j.common.saml.SamlAssertionWrapper assertion)</code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../org/apache/cxf/sts/token/delegation/SAMLDelegationHandler.html#isCheckAudienceRestriction()">isCheckAudienceRestriction</a></strong>()</code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../org/apache/cxf/sts/token/delegation/SAMLDelegationHandler.html#isDelegationAllowed(org.apache.cxf.sts.request.ReceivedToken,%20java.lang.String)">isDelegationAllowed</a></strong>(<a href="../../../../../../org/apache/cxf/sts/request/ReceivedToken.html" title="class in org.apache.cxf.sts.request">ReceivedToken</a> receivedToken, |
| <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> appliesToAddress)</code> |
| <div class="block">Is Delegation allowed for a particular token</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/cxf/sts/token/delegation/TokenDelegationResponse.html" title="class in org.apache.cxf.sts.token.delegation">TokenDelegationResponse</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../org/apache/cxf/sts/token/delegation/SAMLDelegationHandler.html#isDelegationAllowed(org.apache.cxf.sts.token.delegation.TokenDelegationParameters)">isDelegationAllowed</a></strong>(<a href="../../../../../../org/apache/cxf/sts/token/delegation/TokenDelegationParameters.html" title="class in org.apache.cxf.sts.token.delegation">TokenDelegationParameters</a> tokenParameters)</code> |
| <div class="block">See if delegation is allowed for a Token using the given TokenDelegationParameters.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../org/apache/cxf/sts/token/delegation/SAMLDelegationHandler.html#setCheckAudienceRestriction(boolean)">setCheckAudienceRestriction</a></strong>(boolean checkAudienceRestriction)</code> |
| <div class="block">Set whether to perform a check that the received AppliesTo address is contained in the |
| token as one of the AudienceRestriction URIs.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class 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="SAMLDelegationHandler()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>SAMLDelegationHandler</h4> |
| <pre>public SAMLDelegationHandler()</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method_detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="canHandleToken(org.apache.cxf.sts.request.ReceivedToken)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>canHandleToken</h4> |
| <pre>public boolean canHandleToken(<a href="../../../../../../org/apache/cxf/sts/request/ReceivedToken.html" title="class in org.apache.cxf.sts.request">ReceivedToken</a> delegateTarget)</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../../../org/apache/cxf/sts/token/delegation/TokenDelegationHandler.html#canHandleToken(org.apache.cxf.sts.request.ReceivedToken)">TokenDelegationHandler</a></code></strong></div> |
| <div class="block">Return true if this TokenDelegationHandler implementation is capable of handling the |
| ReceivedToken argument.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../../../org/apache/cxf/sts/token/delegation/TokenDelegationHandler.html#canHandleToken(org.apache.cxf.sts.request.ReceivedToken)">canHandleToken</a></code> in interface <code><a href="../../../../../../org/apache/cxf/sts/token/delegation/TokenDelegationHandler.html" title="interface in org.apache.cxf.sts.token.delegation">TokenDelegationHandler</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isDelegationAllowed(org.apache.cxf.sts.token.delegation.TokenDelegationParameters)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isDelegationAllowed</h4> |
| <pre>public <a href="../../../../../../org/apache/cxf/sts/token/delegation/TokenDelegationResponse.html" title="class in org.apache.cxf.sts.token.delegation">TokenDelegationResponse</a> isDelegationAllowed(<a href="../../../../../../org/apache/cxf/sts/token/delegation/TokenDelegationParameters.html" title="class in org.apache.cxf.sts.token.delegation">TokenDelegationParameters</a> tokenParameters)</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../../../org/apache/cxf/sts/token/delegation/TokenDelegationHandler.html#isDelegationAllowed(org.apache.cxf.sts.token.delegation.TokenDelegationParameters)">TokenDelegationHandler</a></code></strong></div> |
| <div class="block">See if delegation is allowed for a Token using the given TokenDelegationParameters.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../../../org/apache/cxf/sts/token/delegation/TokenDelegationHandler.html#isDelegationAllowed(org.apache.cxf.sts.token.delegation.TokenDelegationParameters)">isDelegationAllowed</a></code> in interface <code><a href="../../../../../../org/apache/cxf/sts/token/delegation/TokenDelegationHandler.html" title="interface in org.apache.cxf.sts.token.delegation">TokenDelegationHandler</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isDelegationAllowed(org.apache.cxf.sts.request.ReceivedToken, java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isDelegationAllowed</h4> |
| <pre>protected boolean isDelegationAllowed(<a href="../../../../../../org/apache/cxf/sts/request/ReceivedToken.html" title="class in org.apache.cxf.sts.request">ReceivedToken</a> receivedToken, |
| <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> appliesToAddress)</pre> |
| <div class="block">Is Delegation allowed for a particular token</div> |
| </li> |
| </ul> |
| <a name="getAudienceRestrictions(org.apache.wss4j.common.saml.SamlAssertionWrapper)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getAudienceRestrictions</h4> |
| <pre>protected <a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<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>> getAudienceRestrictions(org.apache.wss4j.common.saml.SamlAssertionWrapper assertion)</pre> |
| </li> |
| </ul> |
| <a name="isCheckAudienceRestriction()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isCheckAudienceRestriction</h4> |
| <pre>public boolean isCheckAudienceRestriction()</pre> |
| </li> |
| </ul> |
| <a name="setCheckAudienceRestriction(boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>setCheckAudienceRestriction</h4> |
| <pre>public void setCheckAudienceRestriction(boolean checkAudienceRestriction)</pre> |
| <div class="block">Set whether to perform a check that the received AppliesTo address is contained in the |
| token as one of the AudienceRestriction URIs. The default is false.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>checkAudienceRestriction</code> - whether to perform an audience restriction check or not</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/SAMLDelegationHandler.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/sts/token/delegation/HOKDelegationHandler.html" title="class in org.apache.cxf.sts.token.delegation"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../../../org/apache/cxf/sts/token/delegation/TokenDelegationHandler.html" title="interface in org.apache.cxf.sts.token.delegation"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/cxf/sts/token/delegation/SAMLDelegationHandler.html" target="_top">Frames</a></li> |
| <li><a href="SAMLDelegationHandler.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><a href="#constructor_summary">Constr</a> | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor_detail">Constr</a> | </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> |
