| <!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>STSPropertiesMBean (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="STSPropertiesMBean (Apache CXF JavaDoc 3.2.0 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6,"i11":6,"i12":6,"i13":6,"i14":6,"i15":6,"i16":6,"i17":6,"i18":6,"i19":6,"i20":6,"i21":6,"i22":6,"i23":6,"i24":6,"i25":6,"i26":6,"i27":6}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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/STSPropertiesMBean.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/STSConstants.html" title="class in org.apache.cxf.sts"><span class="typeNameLink">Prev Class</span></a></li> |
| <li>Next Class</li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/cxf/sts/STSPropertiesMBean.html" target="_top">Frames</a></li> |
| <li><a href="STSPropertiesMBean.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.sts</div> |
| <h2 title="Interface STSPropertiesMBean" class="title">Interface STSPropertiesMBean</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><a href="../../../../org/apache/cxf/sts/StaticSTSProperties.html" title="class in org.apache.cxf.sts">StaticSTSProperties</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="typeNameLabel">STSPropertiesMBean</span></pre> |
| <div class="block">This MBean represents the properties associated with the STS. It contains a single operation |
| "configureProperties()" which allows subclasses to perform any custom loading/processing of the |
| properties.</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="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="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract 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>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/cxf/sts/STSPropertiesMBean.html#configureProperties--">configureProperties</a></span>()</code> |
| <div class="block">Load/process the CallbackHandler, Crypto objects, etc.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/javax/security/auth/callback/CallbackHandler.html?is-external=true" title="class or interface in javax.security.auth.callback">CallbackHandler</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/cxf/sts/STSPropertiesMBean.html#getCallbackHandler--">getCallbackHandler</a></span>()</code> |
| <div class="block">Get the CallbackHandler object.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>org.apache.wss4j.common.crypto.Crypto</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/cxf/sts/STSPropertiesMBean.html#getEncryptionCrypto--">getEncryptionCrypto</a></span>()</code> |
| <div class="block">Get the encryption Crypto object</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/cxf/sts/service/EncryptionProperties.html" title="class in org.apache.cxf.sts.service">EncryptionProperties</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/cxf/sts/STSPropertiesMBean.html#getEncryptionProperties--">getEncryptionProperties</a></span>()</code> |
| <div class="block">Get the EncryptionProperties to use.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><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></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/cxf/sts/STSPropertiesMBean.html#getEncryptionUsername--">getEncryptionUsername</a></span>()</code> |
| <div class="block">Get the username/alias to use to encrypt any issued tokens.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/cxf/sts/IdentityMapper.html" title="interface in org.apache.cxf.sts">IdentityMapper</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/cxf/sts/STSPropertiesMBean.html#getIdentityMapper--">getIdentityMapper</a></span>()</code> |
| <div class="block">Get the IdentityMapper object to use.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code><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></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/cxf/sts/STSPropertiesMBean.html#getIssuer--">getIssuer</a></span>()</code> |
| <div class="block">Get the STS issuer name</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/cxf/sts/RealmParser.html" title="interface in org.apache.cxf.sts">RealmParser</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/cxf/sts/STSPropertiesMBean.html#getRealmParser--">getRealmParser</a></span>()</code> |
| <div class="block">Get the RealmParser object to use.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/cxf/sts/token/realm/RelationshipResolver.html" title="class in org.apache.cxf.sts.token.realm">RelationshipResolver</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/cxf/sts/STSPropertiesMBean.html#getRelationshipResolver--">getRelationshipResolver</a></span>()</code> |
| <div class="block">Get the RelationshipResolver objects to use.</div> |
| </td> |
| </tr> |
| <tr id="i9" 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/realm/Relationship.html" title="class in org.apache.cxf.sts.token.realm">Relationship</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/cxf/sts/STSPropertiesMBean.html#getRelationships--">getRelationships</a></span>()</code> |
| <div class="block">Get the list of Relationship objects to use.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/cxf/sts/token/realm/SAMLRealmCodec.html" title="interface in org.apache.cxf.sts.token.realm">SAMLRealmCodec</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/cxf/sts/STSPropertiesMBean.html#getSamlRealmCodec--">getSamlRealmCodec</a></span>()</code> |
| <div class="block">Get the SAML Realm Codec object to use.</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code>org.apache.wss4j.common.crypto.Crypto</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/cxf/sts/STSPropertiesMBean.html#getSignatureCrypto--">getSignatureCrypto</a></span>()</code> |
| <div class="block">Get the signature Crypto object</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/cxf/sts/SignatureProperties.html" title="class in org.apache.cxf.sts">SignatureProperties</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/cxf/sts/STSPropertiesMBean.html#getSignatureProperties--">getSignatureProperties</a></span>()</code> |
| <div class="block">Get the SignatureProperties to use.</div> |
| </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code><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></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/cxf/sts/STSPropertiesMBean.html#getSignatureUsername--">getSignatureUsername</a></span>()</code> |
| <div class="block">Get the username/alias to use to sign any issued tokens</div> |
| </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/cxf/sts/STSPropertiesMBean.html#isValidateUseKey--">isValidateUseKey</a></span>()</code> |
| <div class="block">Get whether to validate a client Public Key or Certificate presented as part of a |
| UseKey element.</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/STSPropertiesMBean.html#setCallbackHandler-javax.security.auth.callback.CallbackHandler-">setCallbackHandler</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/javax/security/auth/callback/CallbackHandler.html?is-external=true" title="class or interface in javax.security.auth.callback">CallbackHandler</a> callbackHandler)</code> |
| <div class="block">Set the CallbackHandler object.</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/STSPropertiesMBean.html#setEncryptionCrypto-org.apache.wss4j.common.crypto.Crypto-">setEncryptionCrypto</a></span>(org.apache.wss4j.common.crypto.Crypto encryptionCrypto)</code> |
| <div class="block">Set the encryption Crypto object</div> |
| </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/STSPropertiesMBean.html#setEncryptionProperties-org.apache.cxf.sts.service.EncryptionProperties-">setEncryptionProperties</a></span>(<a href="../../../../org/apache/cxf/sts/service/EncryptionProperties.html" title="class in org.apache.cxf.sts.service">EncryptionProperties</a> encryptionProperties)</code> |
| <div class="block">Set the EncryptionProperties to use.</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/STSPropertiesMBean.html#setEncryptionUsername-java.lang.String-">setEncryptionUsername</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> encryptionUsername)</code> |
| <div class="block">Set the username/alias to use to encrypt any issued tokens.</div> |
| </td> |
| </tr> |
| <tr id="i19" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/cxf/sts/STSPropertiesMBean.html#setIdentityMapper-org.apache.cxf.sts.IdentityMapper-">setIdentityMapper</a></span>(<a href="../../../../org/apache/cxf/sts/IdentityMapper.html" title="interface in org.apache.cxf.sts">IdentityMapper</a> identityMapper)</code> |
| <div class="block">Set the IdentityMapper object to use.</div> |
| </td> |
| </tr> |
| <tr id="i20" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/cxf/sts/STSPropertiesMBean.html#setIssuer-java.lang.String-">setIssuer</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> issuer)</code> |
| <div class="block">Set the STS issuer name</div> |
| </td> |
| </tr> |
| <tr id="i21" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/cxf/sts/STSPropertiesMBean.html#setRealmParser-org.apache.cxf.sts.RealmParser-">setRealmParser</a></span>(<a href="../../../../org/apache/cxf/sts/RealmParser.html" title="interface in org.apache.cxf.sts">RealmParser</a> realmParser)</code> |
| <div class="block">Set the RealmParser object to use.</div> |
| </td> |
| </tr> |
| <tr id="i22" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/cxf/sts/STSPropertiesMBean.html#setRelationships-java.util.List-">setRelationships</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/realm/Relationship.html" title="class in org.apache.cxf.sts.token.realm">Relationship</a>> relationships)</code> |
| <div class="block">Set the list of Relationship objects to use.</div> |
| </td> |
| </tr> |
| <tr id="i23" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/cxf/sts/STSPropertiesMBean.html#setSamlRealmCodec-org.apache.cxf.sts.token.realm.SAMLRealmCodec-">setSamlRealmCodec</a></span>(<a href="../../../../org/apache/cxf/sts/token/realm/SAMLRealmCodec.html" title="interface in org.apache.cxf.sts.token.realm">SAMLRealmCodec</a> samlRealmCodec)</code> |
| <div class="block">Set the SAML Realm Codec object to use.</div> |
| </td> |
| </tr> |
| <tr id="i24" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/cxf/sts/STSPropertiesMBean.html#setSignatureCrypto-org.apache.wss4j.common.crypto.Crypto-">setSignatureCrypto</a></span>(org.apache.wss4j.common.crypto.Crypto signatureCrypto)</code> |
| <div class="block">Set the signature Crypto object</div> |
| </td> |
| </tr> |
| <tr id="i25" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/cxf/sts/STSPropertiesMBean.html#setSignatureProperties-org.apache.cxf.sts.SignatureProperties-">setSignatureProperties</a></span>(<a href="../../../../org/apache/cxf/sts/SignatureProperties.html" title="class in org.apache.cxf.sts">SignatureProperties</a> signatureProperties)</code> |
| <div class="block">Set the SignatureProperties to use.</div> |
| </td> |
| </tr> |
| <tr id="i26" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/cxf/sts/STSPropertiesMBean.html#setSignatureUsername-java.lang.String-">setSignatureUsername</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> signatureUsername)</code> |
| <div class="block">Set the username/alias to use to sign any issued tokens</div> |
| </td> |
| </tr> |
| <tr id="i27" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/cxf/sts/STSPropertiesMBean.html#setValidateUseKey-boolean-">setValidateUseKey</a></span>(boolean validateUseKey)</code> |
| <div class="block">Set whether to validate a client Public Key or Certificate presented as part of a |
| UseKey element.</div> |
| </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="configureProperties--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>configureProperties</h4> |
| <pre>void configureProperties() |
| throws <a href="../../../../org/apache/cxf/ws/security/sts/provider/STSException.html" title="class in org.apache.cxf.ws.security.sts.provider">STSException</a></pre> |
| <div class="block">Load/process the CallbackHandler, Crypto objects, etc.</div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../org/apache/cxf/ws/security/sts/provider/STSException.html" title="class in org.apache.cxf.ws.security.sts.provider">STSException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setCallbackHandler-javax.security.auth.callback.CallbackHandler-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setCallbackHandler</h4> |
| <pre>void setCallbackHandler(<a href="http://docs.oracle.com/javase/8/docs/api/javax/security/auth/callback/CallbackHandler.html?is-external=true" title="class or interface in javax.security.auth.callback">CallbackHandler</a> callbackHandler)</pre> |
| <div class="block">Set the CallbackHandler object.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>callbackHandler</code> - the CallbackHandler object.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getCallbackHandler--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCallbackHandler</h4> |
| <pre><a href="http://docs.oracle.com/javase/8/docs/api/javax/security/auth/callback/CallbackHandler.html?is-external=true" title="class or interface in javax.security.auth.callback">CallbackHandler</a> getCallbackHandler()</pre> |
| <div class="block">Get the CallbackHandler object.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the CallbackHandler object.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setSignatureCrypto-org.apache.wss4j.common.crypto.Crypto-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setSignatureCrypto</h4> |
| <pre>void setSignatureCrypto(org.apache.wss4j.common.crypto.Crypto signatureCrypto)</pre> |
| <div class="block">Set the signature Crypto object</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>signatureCrypto</code> - the signature Crypto object</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getSignatureCrypto--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSignatureCrypto</h4> |
| <pre>org.apache.wss4j.common.crypto.Crypto getSignatureCrypto()</pre> |
| <div class="block">Get the signature Crypto object</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the signature Crypto object</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setSignatureUsername-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setSignatureUsername</h4> |
| <pre>void setSignatureUsername(<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> signatureUsername)</pre> |
| <div class="block">Set the username/alias to use to sign any issued tokens</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>signatureUsername</code> - the username/alias to use to sign any issued tokens</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getSignatureUsername--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSignatureUsername</h4> |
| <pre><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> getSignatureUsername()</pre> |
| <div class="block">Get the username/alias to use to sign any issued tokens</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the username/alias to use to sign any issued tokens</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setEncryptionCrypto-org.apache.wss4j.common.crypto.Crypto-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setEncryptionCrypto</h4> |
| <pre>void setEncryptionCrypto(org.apache.wss4j.common.crypto.Crypto encryptionCrypto)</pre> |
| <div class="block">Set the encryption Crypto object</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>encryptionCrypto</code> - the encryption Crypto object</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getEncryptionCrypto--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getEncryptionCrypto</h4> |
| <pre>org.apache.wss4j.common.crypto.Crypto getEncryptionCrypto()</pre> |
| <div class="block">Get the encryption Crypto object</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the encryption Crypto object</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setEncryptionUsername-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setEncryptionUsername</h4> |
| <pre>void setEncryptionUsername(<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> encryptionUsername)</pre> |
| <div class="block">Set the username/alias to use to encrypt any issued tokens. This is a default value - it |
| can be configured per Service in the ServiceMBean.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>encryptionUsername</code> - the username/alias to use to encrypt any issued tokens</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getEncryptionUsername--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getEncryptionUsername</h4> |
| <pre><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> getEncryptionUsername()</pre> |
| <div class="block">Get the username/alias to use to encrypt any issued tokens. This is a default value - it |
| can be configured per Service in the ServiceMBean</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the username/alias to use to encrypt any issued tokens</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setEncryptionProperties-org.apache.cxf.sts.service.EncryptionProperties-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setEncryptionProperties</h4> |
| <pre>void setEncryptionProperties(<a href="../../../../org/apache/cxf/sts/service/EncryptionProperties.html" title="class in org.apache.cxf.sts.service">EncryptionProperties</a> encryptionProperties)</pre> |
| <div class="block">Set the EncryptionProperties to use.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>encryptionProperties</code> - the EncryptionProperties to use.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getEncryptionProperties--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getEncryptionProperties</h4> |
| <pre><a href="../../../../org/apache/cxf/sts/service/EncryptionProperties.html" title="class in org.apache.cxf.sts.service">EncryptionProperties</a> getEncryptionProperties()</pre> |
| <div class="block">Get the EncryptionProperties to use.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the EncryptionProperties to use.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setIssuer-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setIssuer</h4> |
| <pre>void setIssuer(<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> issuer)</pre> |
| <div class="block">Set the STS issuer name</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>issuer</code> - the STS issuer name</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getIssuer--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getIssuer</h4> |
| <pre><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> getIssuer()</pre> |
| <div class="block">Get the STS issuer name</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the STS issuer name</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setSignatureProperties-org.apache.cxf.sts.SignatureProperties-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setSignatureProperties</h4> |
| <pre>void setSignatureProperties(<a href="../../../../org/apache/cxf/sts/SignatureProperties.html" title="class in org.apache.cxf.sts">SignatureProperties</a> signatureProperties)</pre> |
| <div class="block">Set the SignatureProperties to use.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>signatureProperties</code> - the SignatureProperties to use.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getSignatureProperties--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSignatureProperties</h4> |
| <pre><a href="../../../../org/apache/cxf/sts/SignatureProperties.html" title="class in org.apache.cxf.sts">SignatureProperties</a> getSignatureProperties()</pre> |
| <div class="block">Get the SignatureProperties to use.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the SignatureProperties to use.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setRealmParser-org.apache.cxf.sts.RealmParser-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setRealmParser</h4> |
| <pre>void setRealmParser(<a href="../../../../org/apache/cxf/sts/RealmParser.html" title="interface in org.apache.cxf.sts">RealmParser</a> realmParser)</pre> |
| <div class="block">Set the RealmParser object to use.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>realmParser</code> - the RealmParser object to use.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getRealmParser--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getRealmParser</h4> |
| <pre><a href="../../../../org/apache/cxf/sts/RealmParser.html" title="interface in org.apache.cxf.sts">RealmParser</a> getRealmParser()</pre> |
| <div class="block">Get the RealmParser object to use.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the RealmParser object to use.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setIdentityMapper-org.apache.cxf.sts.IdentityMapper-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setIdentityMapper</h4> |
| <pre>void setIdentityMapper(<a href="../../../../org/apache/cxf/sts/IdentityMapper.html" title="interface in org.apache.cxf.sts">IdentityMapper</a> identityMapper)</pre> |
| <div class="block">Set the IdentityMapper object to use.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>identityMapper</code> - the IdentityMapper object to use.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getIdentityMapper--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getIdentityMapper</h4> |
| <pre><a href="../../../../org/apache/cxf/sts/IdentityMapper.html" title="interface in org.apache.cxf.sts">IdentityMapper</a> getIdentityMapper()</pre> |
| <div class="block">Get the IdentityMapper object to use.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the IdentityMapper object to use.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setRelationships-java.util.List-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setRelationships</h4> |
| <pre>void setRelationships(<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/realm/Relationship.html" title="class in org.apache.cxf.sts.token.realm">Relationship</a>> relationships)</pre> |
| <div class="block">Set the list of Relationship objects to use.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>relationships</code> - the List<Relationship> object to use.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getRelationships--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getRelationships</h4> |
| <pre><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/realm/Relationship.html" title="class in org.apache.cxf.sts.token.realm">Relationship</a>> getRelationships()</pre> |
| <div class="block">Get the list of Relationship objects to use.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the List<Relationship> object to use.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getRelationshipResolver--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getRelationshipResolver</h4> |
| <pre><a href="../../../../org/apache/cxf/sts/token/realm/RelationshipResolver.html" title="class in org.apache.cxf.sts.token.realm">RelationshipResolver</a> getRelationshipResolver()</pre> |
| <div class="block">Get the RelationshipResolver objects to use.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the RelationshipResolver object to use.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getSamlRealmCodec--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSamlRealmCodec</h4> |
| <pre><a href="../../../../org/apache/cxf/sts/token/realm/SAMLRealmCodec.html" title="interface in org.apache.cxf.sts.token.realm">SAMLRealmCodec</a> getSamlRealmCodec()</pre> |
| <div class="block">Get the SAML Realm Codec object to use.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the SAMLRealmCodec object to use.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setSamlRealmCodec-org.apache.cxf.sts.token.realm.SAMLRealmCodec-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setSamlRealmCodec</h4> |
| <pre>void setSamlRealmCodec(<a href="../../../../org/apache/cxf/sts/token/realm/SAMLRealmCodec.html" title="interface in org.apache.cxf.sts.token.realm">SAMLRealmCodec</a> samlRealmCodec)</pre> |
| <div class="block">Set the SAML Realm Codec object to use.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>samlRealmCodec</code> - the SAMLRealmCodec object to use.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isValidateUseKey--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isValidateUseKey</h4> |
| <pre>boolean isValidateUseKey()</pre> |
| <div class="block">Get whether to validate a client Public Key or Certificate presented as part of a |
| UseKey element. This is true by default.</div> |
| </li> |
| </ul> |
| <a name="setValidateUseKey-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>setValidateUseKey</h4> |
| <pre>void setValidateUseKey(boolean validateUseKey)</pre> |
| <div class="block">Set whether to validate a client Public Key or Certificate presented as part of a |
| UseKey element. If this is set to true (the default), the public key must be trusted |
| by the Signature Crypto of the STS.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>validateUseKey</code> - whether to validate a client UseKey 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> |
| <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/STSPropertiesMBean.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/STSConstants.html" title="class in org.apache.cxf.sts"><span class="typeNameLink">Prev Class</span></a></li> |
| <li>Next Class</li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/cxf/sts/STSPropertiesMBean.html" target="_top">Frames</a></li> |
| <li><a href="STSPropertiesMBean.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> |