| <!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 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>SAMLTokenProvider (Apache CXF JavaDoc 3.2.0 API)</title> |
| <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../../../../script.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="SAMLTokenProvider (Apache CXF JavaDoc 3.2.0 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <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/SAMLTokenProvider.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">Apache CXF API</div> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../../org/apache/cxf/sts/token/provider/SamlCustomHandler.html" title="interface in org.apache.cxf.sts.token.provider"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../org/apache/cxf/sts/token/provider/SCTProvider.html" title="class in org.apache.cxf.sts.token.provider"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/cxf/sts/token/provider/SAMLTokenProvider.html" target="_top">Frames</a></li> |
| <li><a href="SAMLTokenProvider.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.provider</div> |
| <h2 title="Class SAMLTokenProvider" class="title">Class SAMLTokenProvider</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="http://docs.oracle.com/javase/8/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/sts/token/provider/AbstractSAMLTokenProvider.html" title="class in org.apache.cxf.sts.token.provider">org.apache.cxf.sts.token.provider.AbstractSAMLTokenProvider</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.cxf.sts.token.provider.SAMLTokenProvider</li> |
| </ul> |
| </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/provider/TokenProvider.html" title="interface in org.apache.cxf.sts.token.provider">TokenProvider</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public class <span class="typeNameLabel">SAMLTokenProvider</span> |
| extends <a href="../../../../../../org/apache/cxf/sts/token/provider/AbstractSAMLTokenProvider.html" title="class in org.apache.cxf.sts.token.provider">AbstractSAMLTokenProvider</a> |
| implements <a href="../../../../../../org/apache/cxf/sts/token/provider/TokenProvider.html" title="interface in org.apache.cxf.sts.token.provider">TokenProvider</a></pre> |
| <div class="block">A TokenProvider implementation that provides a SAML Token.</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="memberSummary" 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><span class="memberNameLink"><a href="../../../../../../org/apache/cxf/sts/token/provider/SAMLTokenProvider.html#SAMLTokenProvider--">SAMLTokenProvider</a></span>()</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="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/cxf/sts/token/provider/SAMLTokenProvider.html#canHandleToken-java.lang.String-">canHandleToken</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> tokenType)</code> |
| <div class="block">Return true if this TokenProvider implementation is capable of providing a token |
| that corresponds to the given TokenType.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/cxf/sts/token/provider/SAMLTokenProvider.html#canHandleToken-java.lang.String-java.lang.String-">canHandleToken</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> tokenType, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> realm)</code> |
| <div class="block">Return true if this TokenProvider implementation is capable of providing a token |
| that corresponds to the given TokenType in a given realm.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/cxf/sts/token/provider/SamlCallbackHandler.html" title="class in org.apache.cxf.sts.token.provider">SamlCallbackHandler</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/cxf/sts/token/provider/SAMLTokenProvider.html#createCallbackHandler-org.apache.cxf.sts.token.provider.TokenProviderParameters-byte:A-org.apache.cxf.sts.token.realm.RealmProperties-org.w3c.dom.Document-">createCallbackHandler</a></span>(<a href="../../../../../../org/apache/cxf/sts/token/provider/TokenProviderParameters.html" title="class in org.apache.cxf.sts.token.provider">TokenProviderParameters</a> tokenParameters, |
| byte[] secret, |
| <a href="../../../../../../org/apache/cxf/sts/token/realm/RealmProperties.html" title="class in org.apache.cxf.sts.token.realm">RealmProperties</a> samlRealm, |
| <a href="http://docs.oracle.com/javase/8/docs/api/org/w3c/dom/Document.html?is-external=true" title="class or interface in org.w3c.dom">Document</a> doc)</code> </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/cxf/sts/token/provider/TokenProviderResponse.html" title="class in org.apache.cxf.sts.token.provider">TokenProviderResponse</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/cxf/sts/token/provider/SAMLTokenProvider.html#createToken-org.apache.cxf.sts.token.provider.TokenProviderParameters-">createToken</a></span>(<a href="../../../../../../org/apache/cxf/sts/token/provider/TokenProviderParameters.html" title="class in org.apache.cxf.sts.token.provider">TokenProviderParameters</a> tokenParameters)</code> |
| <div class="block">Create a token given a TokenProviderParameters</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../../../org/apache/cxf/sts/token/provider/AttributeStatementProvider.html" title="interface in org.apache.cxf.sts.token.provider">AttributeStatementProvider</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/cxf/sts/token/provider/SAMLTokenProvider.html#getAttributeStatementProviders--">getAttributeStatementProviders</a></span>()</code> |
| <div class="block">Get the List of AttributeStatementProviders.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../../../org/apache/cxf/sts/token/provider/AuthDecisionStatementProvider.html" title="interface in org.apache.cxf.sts.token.provider">AuthDecisionStatementProvider</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/cxf/sts/token/provider/SAMLTokenProvider.html#getAuthDecisionStatementProviders--">getAuthDecisionStatementProviders</a></span>()</code> |
| <div class="block">Get the List of AuthDecisionStatementProviders.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../../../org/apache/cxf/sts/token/provider/AuthenticationStatementProvider.html" title="interface in org.apache.cxf.sts.token.provider">AuthenticationStatementProvider</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/cxf/sts/token/provider/SAMLTokenProvider.html#getAuthenticationStatementProviders--">getAuthenticationStatementProviders</a></span>()</code> |
| <div class="block">Get the List of AuthenticationStatementProviders.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/cxf/sts/token/provider/ConditionsProvider.html" title="interface in org.apache.cxf.sts.token.provider">ConditionsProvider</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/cxf/sts/token/provider/SAMLTokenProvider.html#getConditionsProvider--">getConditionsProvider</a></span>()</code> |
| <div class="block">Get the ConditionsProvider</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="../../../../../../org/apache/cxf/sts/token/realm/RealmProperties.html" title="class in org.apache.cxf.sts.token.realm">RealmProperties</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/cxf/sts/token/provider/SAMLTokenProvider.html#getRealmMap--">getRealmMap</a></span>()</code> |
| <div class="block">Get the map of realm->RealmProperties for this token provider</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/cxf/sts/token/provider/SubjectProvider.html" title="interface in org.apache.cxf.sts.token.provider">SubjectProvider</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/cxf/sts/token/provider/SAMLTokenProvider.html#getSubjectProvider--">getSubjectProvider</a></span>()</code> |
| <div class="block">Get the SubjectProvider.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/cxf/sts/token/provider/SAMLTokenProvider.html#isSignToken--">isSignToken</a></span>()</code> |
| <div class="block">Return whether the provided token will be signed or not.</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/cxf/sts/token/provider/SAMLTokenProvider.html#setAttributeStatementProviders-java.util.List-">setAttributeStatementProviders</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../../../org/apache/cxf/sts/token/provider/AttributeStatementProvider.html" title="interface in org.apache.cxf.sts.token.provider">AttributeStatementProvider</a>> attributeStatementProviders)</code> |
| <div class="block">Set the List of AttributeStatementProviders.</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/cxf/sts/token/provider/SAMLTokenProvider.html#setAuthDecisionStatementProviders-java.util.List-">setAuthDecisionStatementProviders</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../../../org/apache/cxf/sts/token/provider/AuthDecisionStatementProvider.html" title="interface in org.apache.cxf.sts.token.provider">AuthDecisionStatementProvider</a>> authDecisionStatementProviders)</code> |
| <div class="block">Set the List of AuthDecisionStatementProviders.</div> |
| </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/cxf/sts/token/provider/SAMLTokenProvider.html#setAuthenticationStatementProviders-java.util.List-">setAuthenticationStatementProviders</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../../../org/apache/cxf/sts/token/provider/AuthenticationStatementProvider.html" title="interface in org.apache.cxf.sts.token.provider">AuthenticationStatementProvider</a>> authnStatementProviders)</code> |
| <div class="block">Set the List of AuthenticationStatementProviders.</div> |
| </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/cxf/sts/token/provider/SAMLTokenProvider.html#setConditionsProvider-org.apache.cxf.sts.token.provider.ConditionsProvider-">setConditionsProvider</a></span>(<a href="../../../../../../org/apache/cxf/sts/token/provider/ConditionsProvider.html" title="interface in org.apache.cxf.sts.token.provider">ConditionsProvider</a> conditionsProvider)</code> |
| <div class="block">Set the ConditionsProvider</div> |
| </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/cxf/sts/token/provider/SAMLTokenProvider.html#setRealmMap-java.util.Map-">setRealmMap</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,? extends <a href="../../../../../../org/apache/cxf/sts/token/realm/RealmProperties.html" title="class in org.apache.cxf.sts.token.realm">RealmProperties</a>> realms)</code> |
| <div class="block">Set the map of realm->RealmProperties for this token provider</div> |
| </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/cxf/sts/token/provider/SAMLTokenProvider.html#setSamlCustomHandler-org.apache.cxf.sts.token.provider.SamlCustomHandler-">setSamlCustomHandler</a></span>(<a href="../../../../../../org/apache/cxf/sts/token/provider/SamlCustomHandler.html" title="interface in org.apache.cxf.sts.token.provider">SamlCustomHandler</a> samlCustomHandler)</code> </td> |
| </tr> |
| <tr id="i17" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/cxf/sts/token/provider/SAMLTokenProvider.html#setSignToken-boolean-">setSignToken</a></span>(boolean signToken)</code> |
| <div class="block">Set whether the provided token will be signed or not.</div> |
| </td> |
| </tr> |
| <tr id="i18" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/cxf/sts/token/provider/SAMLTokenProvider.html#setSubjectProvider-org.apache.cxf.sts.token.provider.SubjectProvider-">setSubjectProvider</a></span>(<a href="../../../../../../org/apache/cxf/sts/token/provider/SubjectProvider.html" title="interface in org.apache.cxf.sts.token.provider">SubjectProvider</a> subjectProvider)</code> |
| <div class="block">Set the SubjectProvider.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.cxf.sts.token.provider.AbstractSAMLTokenProvider"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.apache.cxf.sts.token.provider.<a href="../../../../../../org/apache/cxf/sts/token/provider/AbstractSAMLTokenProvider.html" title="class in org.apache.cxf.sts.token.provider">AbstractSAMLTokenProvider</a></h3> |
| <code><a href="../../../../../../org/apache/cxf/sts/token/provider/AbstractSAMLTokenProvider.html#signToken-org.apache.wss4j.common.saml.SamlAssertionWrapper-org.apache.cxf.sts.token.realm.RealmProperties-org.apache.cxf.sts.STSPropertiesMBean-org.apache.cxf.sts.request.KeyRequirements-">signToken</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 java.lang.<a href="http://docs.oracle.com/javase/8/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/8/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/8/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/8/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/8/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/8/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/8/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/8/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/8/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/8/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/8/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/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" 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="SAMLTokenProvider--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>SAMLTokenProvider</h4> |
| <pre>public SAMLTokenProvider()</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-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>canHandleToken</h4> |
| <pre>public boolean canHandleToken(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> tokenType)</pre> |
| <div class="block">Return true if this TokenProvider implementation is capable of providing a token |
| that corresponds to the given TokenType.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../org/apache/cxf/sts/token/provider/TokenProvider.html#canHandleToken-java.lang.String-">canHandleToken</a></code> in interface <code><a href="../../../../../../org/apache/cxf/sts/token/provider/TokenProvider.html" title="interface in org.apache.cxf.sts.token.provider">TokenProvider</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="canHandleToken-java.lang.String-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>canHandleToken</h4> |
| <pre>public boolean canHandleToken(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> tokenType, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> realm)</pre> |
| <div class="block">Return true if this TokenProvider implementation is capable of providing a token |
| that corresponds to the given TokenType in a given realm.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../org/apache/cxf/sts/token/provider/TokenProvider.html#canHandleToken-java.lang.String-java.lang.String-">canHandleToken</a></code> in interface <code><a href="../../../../../../org/apache/cxf/sts/token/provider/TokenProvider.html" title="interface in org.apache.cxf.sts.token.provider">TokenProvider</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="createToken-org.apache.cxf.sts.token.provider.TokenProviderParameters-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createToken</h4> |
| <pre>public <a href="../../../../../../org/apache/cxf/sts/token/provider/TokenProviderResponse.html" title="class in org.apache.cxf.sts.token.provider">TokenProviderResponse</a> createToken(<a href="../../../../../../org/apache/cxf/sts/token/provider/TokenProviderParameters.html" title="class in org.apache.cxf.sts.token.provider">TokenProviderParameters</a> tokenParameters)</pre> |
| <div class="block">Create a token given a TokenProviderParameters</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../org/apache/cxf/sts/token/provider/TokenProvider.html#createToken-org.apache.cxf.sts.token.provider.TokenProviderParameters-">createToken</a></code> in interface <code><a href="../../../../../../org/apache/cxf/sts/token/provider/TokenProvider.html" title="interface in org.apache.cxf.sts.token.provider">TokenProvider</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setAttributeStatementProviders-java.util.List-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setAttributeStatementProviders</h4> |
| <pre>public void setAttributeStatementProviders(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../../../org/apache/cxf/sts/token/provider/AttributeStatementProvider.html" title="interface in org.apache.cxf.sts.token.provider">AttributeStatementProvider</a>> attributeStatementProviders)</pre> |
| <div class="block">Set the List of AttributeStatementProviders.</div> |
| </li> |
| </ul> |
| <a name="getAttributeStatementProviders--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getAttributeStatementProviders</h4> |
| <pre>public <a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../../../org/apache/cxf/sts/token/provider/AttributeStatementProvider.html" title="interface in org.apache.cxf.sts.token.provider">AttributeStatementProvider</a>> getAttributeStatementProviders()</pre> |
| <div class="block">Get the List of AttributeStatementProviders.</div> |
| </li> |
| </ul> |
| <a name="setAuthenticationStatementProviders-java.util.List-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setAuthenticationStatementProviders</h4> |
| <pre>public void setAuthenticationStatementProviders(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../../../org/apache/cxf/sts/token/provider/AuthenticationStatementProvider.html" title="interface in org.apache.cxf.sts.token.provider">AuthenticationStatementProvider</a>> authnStatementProviders)</pre> |
| <div class="block">Set the List of AuthenticationStatementProviders.</div> |
| </li> |
| </ul> |
| <a name="getAuthenticationStatementProviders--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getAuthenticationStatementProviders</h4> |
| <pre>public <a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../../../org/apache/cxf/sts/token/provider/AuthenticationStatementProvider.html" title="interface in org.apache.cxf.sts.token.provider">AuthenticationStatementProvider</a>> getAuthenticationStatementProviders()</pre> |
| <div class="block">Get the List of AuthenticationStatementProviders.</div> |
| </li> |
| </ul> |
| <a name="setAuthDecisionStatementProviders-java.util.List-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setAuthDecisionStatementProviders</h4> |
| <pre>public void setAuthDecisionStatementProviders(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../../../org/apache/cxf/sts/token/provider/AuthDecisionStatementProvider.html" title="interface in org.apache.cxf.sts.token.provider">AuthDecisionStatementProvider</a>> authDecisionStatementProviders)</pre> |
| <div class="block">Set the List of AuthDecisionStatementProviders.</div> |
| </li> |
| </ul> |
| <a name="getAuthDecisionStatementProviders--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getAuthDecisionStatementProviders</h4> |
| <pre>public <a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../../../org/apache/cxf/sts/token/provider/AuthDecisionStatementProvider.html" title="interface in org.apache.cxf.sts.token.provider">AuthDecisionStatementProvider</a>> getAuthDecisionStatementProviders()</pre> |
| <div class="block">Get the List of AuthDecisionStatementProviders.</div> |
| </li> |
| </ul> |
| <a name="setSubjectProvider-org.apache.cxf.sts.token.provider.SubjectProvider-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setSubjectProvider</h4> |
| <pre>public void setSubjectProvider(<a href="../../../../../../org/apache/cxf/sts/token/provider/SubjectProvider.html" title="interface in org.apache.cxf.sts.token.provider">SubjectProvider</a> subjectProvider)</pre> |
| <div class="block">Set the SubjectProvider.</div> |
| </li> |
| </ul> |
| <a name="getSubjectProvider--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSubjectProvider</h4> |
| <pre>public <a href="../../../../../../org/apache/cxf/sts/token/provider/SubjectProvider.html" title="interface in org.apache.cxf.sts.token.provider">SubjectProvider</a> getSubjectProvider()</pre> |
| <div class="block">Get the SubjectProvider.</div> |
| </li> |
| </ul> |
| <a name="setConditionsProvider-org.apache.cxf.sts.token.provider.ConditionsProvider-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setConditionsProvider</h4> |
| <pre>public void setConditionsProvider(<a href="../../../../../../org/apache/cxf/sts/token/provider/ConditionsProvider.html" title="interface in org.apache.cxf.sts.token.provider">ConditionsProvider</a> conditionsProvider)</pre> |
| <div class="block">Set the ConditionsProvider</div> |
| </li> |
| </ul> |
| <a name="getConditionsProvider--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getConditionsProvider</h4> |
| <pre>public <a href="../../../../../../org/apache/cxf/sts/token/provider/ConditionsProvider.html" title="interface in org.apache.cxf.sts.token.provider">ConditionsProvider</a> getConditionsProvider()</pre> |
| <div class="block">Get the ConditionsProvider</div> |
| </li> |
| </ul> |
| <a name="isSignToken--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isSignToken</h4> |
| <pre>public boolean isSignToken()</pre> |
| <div class="block">Return whether the provided token will be signed or not. Default is true.</div> |
| </li> |
| </ul> |
| <a name="setSignToken-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setSignToken</h4> |
| <pre>public void setSignToken(boolean signToken)</pre> |
| <div class="block">Set whether the provided token will be signed or not. Default is true.</div> |
| </li> |
| </ul> |
| <a name="setRealmMap-java.util.Map-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setRealmMap</h4> |
| <pre>public void setRealmMap(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,? extends <a href="../../../../../../org/apache/cxf/sts/token/realm/RealmProperties.html" title="class in org.apache.cxf.sts.token.realm">RealmProperties</a>> realms)</pre> |
| <div class="block">Set the map of realm->RealmProperties for this token provider</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>realms</code> - the map of realm->RealmProperties for this token provider</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getRealmMap--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getRealmMap</h4> |
| <pre>public <a href="http://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="../../../../../../org/apache/cxf/sts/token/realm/RealmProperties.html" title="class in org.apache.cxf.sts.token.realm">RealmProperties</a>> getRealmMap()</pre> |
| <div class="block">Get the map of realm->RealmProperties for this token provider</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the map of realm->RealmProperties for this token provider</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setSamlCustomHandler-org.apache.cxf.sts.token.provider.SamlCustomHandler-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setSamlCustomHandler</h4> |
| <pre>public void setSamlCustomHandler(<a href="../../../../../../org/apache/cxf/sts/token/provider/SamlCustomHandler.html" title="interface in org.apache.cxf.sts.token.provider">SamlCustomHandler</a> samlCustomHandler)</pre> |
| </li> |
| </ul> |
| <a name="createCallbackHandler-org.apache.cxf.sts.token.provider.TokenProviderParameters-byte:A-org.apache.cxf.sts.token.realm.RealmProperties-org.w3c.dom.Document-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>createCallbackHandler</h4> |
| <pre>public <a href="../../../../../../org/apache/cxf/sts/token/provider/SamlCallbackHandler.html" title="class in org.apache.cxf.sts.token.provider">SamlCallbackHandler</a> createCallbackHandler(<a href="../../../../../../org/apache/cxf/sts/token/provider/TokenProviderParameters.html" title="class in org.apache.cxf.sts.token.provider">TokenProviderParameters</a> tokenParameters, |
| byte[] secret, |
| <a href="../../../../../../org/apache/cxf/sts/token/realm/RealmProperties.html" title="class in org.apache.cxf.sts.token.realm">RealmProperties</a> samlRealm, |
| <a href="http://docs.oracle.com/javase/8/docs/api/org/w3c/dom/Document.html?is-external=true" title="class or interface in org.w3c.dom">Document</a> doc) |
| throws <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</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> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <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/SAMLTokenProvider.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">Apache CXF API</div> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../../org/apache/cxf/sts/token/provider/SamlCustomHandler.html" title="interface in org.apache.cxf.sts.token.provider"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../org/apache/cxf/sts/token/provider/SCTProvider.html" title="class in org.apache.cxf.sts.token.provider"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/cxf/sts/token/provider/SAMLTokenProvider.html" target="_top">Frames</a></li> |
| <li><a href="SAMLTokenProvider.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> |