Google Git
Sign in
apache/axis-site/d0dd90ea759754a3454fd56c4a38f34f6b0511b3/./axis2/java/rampart/apidocs/org/apache/rahas/impl/SAML2TokenIssuer.html
blob: 2229db71da7449db6add986eecba252bcf270d28 [file]
<!DOCTYPE HTML>
<html lang>
<head>
<!-- Generated by javadoc (17) -->
<title>SAML2TokenIssuer (Apache Rampart)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="description" content="declaration: package: org.apache.rahas.impl, class: SAML2TokenIssuer">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
<script type="text/javascript" src="../../../../script-dir/jquery-3.6.1.min.js"></script>
<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script>
</head>
<body class="class-declaration-page">
<script type="text/javascript">var evenRowColor = "even-row-color";
var oddRowColor = "odd-row-color";
var tableTab = "table-tab";
var activeTableTab = "active-table-tab";
var pathtoroot = "../../../../";
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<div class="flex-box">
<header role="banner" class="flex-header">
<nav role="navigation">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="top-nav" id="navbar-top">
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
<li><a href="../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="nav-bar-cell1-rev">Class</li>
<li><a href="class-use/SAML2TokenIssuer.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#class">Help</a></li>
</ul>
</div>
<div class="sub-nav">
<div>
<ul class="sub-nav-list">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field-summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor-summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method-summary">Method</a></li>
</ul>
<ul class="sub-nav-list">
<li>Detail:&nbsp;</li>
<li><a href="#field-detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor-detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method-detail">Method</a></li>
</ul>
</div>
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
<input type="text" id="search-input" value="search" disabled="disabled">
<input type="reset" id="reset-button" value="reset" disabled="disabled">
</div>
</div>
<!-- ========= END OF TOP NAVBAR ========= -->
<span class="skip-nav" id="skip-navbar-top"></span></nav>
</header>
<div class="flex-content">
<main role="main">
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="sub-title"><span class="package-label-in-type">Package</span>&nbsp;<a href="package-summary.html">org.apache.rahas.impl</a></div>
<h1 title="Class SAML2TokenIssuer" class="title">Class SAML2TokenIssuer</h1>
</div>
<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a>
<div class="inheritance">org.apache.rahas.impl.SAML2TokenIssuer</div>
</div>
<section class="class-description" id="class-description">
<dl class="notes">
<dt>All Implemented Interfaces:</dt>
<dd><code><a href="../TokenIssuer.html" title="interface in org.apache.rahas">TokenIssuer</a></code></dd>
</dl>
<hr>
<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">SAML2TokenIssuer</span>
<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>
implements <a href="../TokenIssuer.html" title="interface in org.apache.rahas">TokenIssuer</a></span></div>
<div class="block">WS-Trust based SAML2 token issuer. This issuer will generate request security token responses with SAML2
assertions.</div>
</section>
<section class="summary">
<ul class="summary-list">
<!-- =========== FIELD SUMMARY =========== -->
<li>
<section class="field-summary" id="field-summary">
<h2>Field Summary</h2>
<div class="caption"><span>Fields</span></div>
<div class="summary-table three-column-summary">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Field</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><code>protected <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;org.opensaml.xmlsec.signature.Signature&gt;</code></div>
<div class="col-second even-row-color"><code><a href="#signatureList" class="member-name-link">signatureList</a></code></div>
<div class="col-last even-row-color">&nbsp;</div>
</div>
</section>
</li>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<li>
<section class="constructor-summary" id="constructor-summary">
<h2>Constructor Summary</h2>
<div class="caption"><span>Constructors</span></div>
<div class="summary-table two-column-summary">
<div class="table-header col-first">Constructor</div>
<div class="table-header col-last">Description</div>
<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E()" class="member-name-link">SAML2TokenIssuer</a>()</code></div>
<div class="col-last even-row-color">&nbsp;</div>
</div>
</section>
</li>
<!-- ========== METHOD SUMMARY =========== -->
<li>
<section class="method-summary" id="method-summary">
<h2>Method Summary</h2>
<div id="method-summary-table">
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div>
<div id="method-summary-table.tabpanel" role="tabpanel">
<div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Method</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected org.opensaml.saml.saml2.core.Assertion</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#buildAssertion(org.w3c.dom.Document,org.apache.wss4j.common.crypto.Crypto,org.apache.rahas.RahasData)" class="member-name-link">buildAssertion</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.xml/org/w3c/dom/Document.html" title="class or interface in org.w3c.dom" class="external-link">Document</a>&nbsp;doc,
org.apache.wss4j.common.crypto.Crypto&nbsp;crypto,
<a href="../RahasData.html" title="class in org.apache.rahas">RahasData</a>&nbsp;data)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">This methods builds the SAML2 assertion.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected org.opensaml.saml.saml2.core.AttributeStatement</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#createAttributeStatement(org.apache.rahas.RahasData)" class="member-name-link">createAttributeStatement</a><wbr>(<a href="../RahasData.html" title="class in org.apache.rahas">RahasData</a>&nbsp;data)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">This method creates an AttributeStatement.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected org.opensaml.saml.saml2.core.AuthnStatement</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#createAuthenticationStatement(org.apache.rahas.RahasData)" class="member-name-link">createAuthenticationStatement</a><wbr>(<a href="../RahasData.html" title="class in org.apache.rahas">RahasData</a>&nbsp;data)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">This method creates an authentication statement.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected org.opensaml.xmlsec.signature.KeyInfo</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#createKeyInfo(org.w3c.dom.Document,org.apache.wss4j.common.crypto.Crypto,org.apache.rahas.RahasData)" class="member-name-link">createKeyInfo</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.xml/org/w3c/dom/Document.html" title="class or interface in org.w3c.dom" class="external-link">Document</a>&nbsp;doc,
org.apache.wss4j.common.crypto.Crypto&nbsp;crypto,
<a href="../RahasData.html" title="class in org.apache.rahas">RahasData</a>&nbsp;data)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">This method creates the KeyInfo relevant for the assertion.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected org.apache.axiom.soap.SOAPEnvelope</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#createRequestSecurityTokenResponse(org.apache.rahas.RahasData,org.opensaml.saml.saml2.core.Assertion,org.apache.axiom.soap.SOAPEnvelope)" class="member-name-link">createRequestSecurityTokenResponse</a><wbr>(<a href="../RahasData.html" title="class in org.apache.rahas">RahasData</a>&nbsp;rahasData,
org.opensaml.saml.saml2.core.Assertion&nbsp;assertion,
org.apache.axiom.soap.SOAPEnvelope&nbsp;soapEnvelope)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">This method prepares the final response.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected org.opensaml.saml.saml2.core.Subject</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#createSubjectWithBearerSubjectConfirmation(org.apache.rahas.RahasData)" class="member-name-link">createSubjectWithBearerSubjectConfirmation</a><wbr>(<a href="../RahasData.html" title="class in org.apache.rahas">RahasData</a>&nbsp;data)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">This method creates a subject element with the bearer subject confirmation method.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected org.opensaml.saml.saml2.core.Subject</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#createSubjectWithHolderOfKeySubjectConfirmation(org.w3c.dom.Document,org.apache.wss4j.common.crypto.Crypto,java.time.Instant,java.time.Instant,org.apache.rahas.RahasData)" class="member-name-link">createSubjectWithHolderOfKeySubjectConfirmation</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.xml/org/w3c/dom/Document.html" title="class or interface in org.w3c.dom" class="external-link">Document</a>&nbsp;doc,
org.apache.wss4j.common.crypto.Crypto&nbsp;crypto,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/time/Instant.html" title="class or interface in java.time" class="external-link">Instant</a>&nbsp;creationTime,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/time/Instant.html" title="class or interface in java.time" class="external-link">Instant</a>&nbsp;expirationTime,
<a href="../RahasData.html" title="class in org.apache.rahas">RahasData</a>&nbsp;data)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">This method will create a SAML 2 subject based on Holder of Key confirmation method.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getResponseAction(org.apache.rahas.RahasData)" class="member-name-link">getResponseAction</a><wbr>(<a href="../RahasData.html" title="class in org.apache.rahas">RahasData</a>&nbsp;data)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Returns the <code>wsa:Action</code> of the response.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>org.apache.axiom.soap.SOAPEnvelope</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#issue(org.apache.rahas.RahasData)" class="member-name-link">issue</a><wbr>(<a href="../RahasData.html" title="class in org.apache.rahas">RahasData</a>&nbsp;data)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">This is the main method which issues SAML2 assertions as security token responses.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setConfigurationElement(org.apache.axiom.om.OMElement)" class="member-name-link">setConfigurationElement</a><wbr>(org.apache.axiom.om.OMElement&nbsp;configElement)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Set the configuration element of this TokenIssuer.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setConfigurationFile(java.lang.String)" class="member-name-link">setConfigurationFile</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;configFile)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Set the configuration file of this TokenIssuer.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setConfigurationParamName(java.lang.String)" class="member-name-link">setConfigurationParamName</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;configParamName)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Set the name of the configuration parameter.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>protected static void</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#setSubjectNamedIdentifierData(org.opensaml.saml.saml2.core.Subject,java.lang.String,java.lang.String)" class="member-name-link">setSubjectNamedIdentifierData</a><wbr>(org.opensaml.saml.saml2.core.Subject&nbsp;subject,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;subjectNameId,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;format)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
<div class="block">This method will set the subject principal details to the given subject.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected org.opensaml.saml.saml2.core.Assertion</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#signAssertion(org.w3c.dom.Document,org.opensaml.saml.saml2.core.Assertion,org.apache.wss4j.common.crypto.Crypto)" class="member-name-link">signAssertion</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.xml/org/w3c/dom/Document.html" title="class or interface in org.w3c.dom" class="external-link">Document</a>&nbsp;document,
org.opensaml.saml.saml2.core.Assertion&nbsp;assertion,
org.apache.wss4j.common.crypto.Crypto&nbsp;crypto)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">This method signs the given assertion with issuer's private key.</div>
</div>
</div>
</div>
</div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3>
<code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div>
</section>
</li>
</ul>
</section>
<section class="details">
<ul class="details-list">
<!-- ============ FIELD DETAIL =========== -->
<li>
<section class="field-details" id="field-detail">
<h2>Field Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="signatureList">
<h3>signatureList</h3>
<div class="member-signature"><span class="modifiers">protected</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;org.opensaml.xmlsec.signature.Signature&gt;</span>&nbsp;<span class="element-name">signatureList</span></div>
</section>
</li>
</ul>
</section>
</li>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<li>
<section class="constructor-details" id="constructor-detail">
<h2>Constructor Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="&lt;init&gt;()">
<h3>SAML2TokenIssuer</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">SAML2TokenIssuer</span>()</div>
</section>
</li>
</ul>
</section>
</li>
<!-- ============ METHOD DETAIL ========== -->
<li>
<section class="method-details" id="method-detail">
<h2>Method Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="issue(org.apache.rahas.RahasData)">
<h3>issue</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">org.apache.axiom.soap.SOAPEnvelope</span>&nbsp;<span class="element-name">issue</span><wbr><span class="parameters">(<a href="../RahasData.html" title="class in org.apache.rahas">RahasData</a>&nbsp;data)</span>
throws <span class="exceptions"><a href="../TrustException.html" title="class in org.apache.rahas">TrustException</a></span></div>
<div class="block">This is the main method which issues SAML2 assertions as security token responses. This method will
read issuer configuration and in message context properties (Basically request security token properties)
and will create a security token response with SAML2 assertion. The attributes are retrieved from a callback
class.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="../TokenIssuer.html#issue(org.apache.rahas.RahasData)">issue</a></code>&nbsp;in interface&nbsp;<code><a href="../TokenIssuer.html" title="interface in org.apache.rahas">TokenIssuer</a></code></dd>
<dt>Parameters:</dt>
<dd><code>data</code> - A populated <code>RahasData</code> instance</dd>
<dt>Returns:</dt>
<dd>A SOAP message with security token response (as per ws-trust spec) with a SAML2 assertion.</dd>
<dt>Throws:</dt>
<dd><code><a href="../TrustException.html" title="class in org.apache.rahas">TrustException</a></code> - If an error occurred while creating the response.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="createRequestSecurityTokenResponse(org.apache.rahas.RahasData,org.opensaml.saml.saml2.core.Assertion,org.apache.axiom.soap.SOAPEnvelope)">
<h3>createRequestSecurityTokenResponse</h3>
<div class="member-signature"><span class="modifiers">protected</span>&nbsp;<span class="return-type">org.apache.axiom.soap.SOAPEnvelope</span>&nbsp;<span class="element-name">createRequestSecurityTokenResponse</span><wbr><span class="parameters">(<a href="../RahasData.html" title="class in org.apache.rahas">RahasData</a>&nbsp;rahasData,
org.opensaml.saml.saml2.core.Assertion&nbsp;assertion,
org.apache.axiom.soap.SOAPEnvelope&nbsp;soapEnvelope)</span>
throws <span class="exceptions"><a href="../TrustException.html" title="class in org.apache.rahas">TrustException</a></span></div>
<div class="block">This method prepares the final response. This method will create a request security token response as
specified in WS-Trust specification. The equivalent XML would take following format,
<pre> &lt;wst:RequestSecurityTokenResponse xmlns:wst="..."&gt;
&lt;wst:TokenType&gt;...&lt;/wst:TokenType&gt;
&lt;wst:RequestedSecurityToken&gt;...&lt;/wst:RequestedSecurityToken&gt;
...
&lt;wsp:AppliesTo xmlns:wsp="..."&gt;...&lt;/wsp:AppliesTo&gt;
&lt;wst:RequestedAttachedReference&gt;
...
&lt;/wst:RequestedAttachedReference&gt;
&lt;wst:RequestedUnattachedReference&gt;
...
&lt;/wst:RequestedUnattachedReference&gt;
&lt;wst:RequestedProofToken&gt;...&lt;/wst:RequestedProofToken&gt;
&lt;wst:Entropy&gt;
&lt;wst:BinarySecret&gt;...&lt;/wst:BinarySecret&gt;
&lt;/wst:Entropy&gt;
&lt;wst:Lifetime&gt;...&lt;/wst:Lifetime&gt;
&lt;/wst:RequestSecurityTokenResponse&gt;</pre>
Thus the RequestedSecurityToken will have SAML2 assertion passed.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>rahasData</code> - The configuration data which comes with RST</dd>
<dd><code>assertion</code> - OpenSAM representation of SAML2 assertion.</dd>
<dd><code>soapEnvelope</code> - SOAP message envelope</dd>
<dt>Returns:</dt>
<dd>SOAPEnvelope which includes RequestSecurityTokenResponse</dd>
<dt>Throws:</dt>
<dd><code><a href="../TrustException.html" title="class in org.apache.rahas">TrustException</a></code> - If an error occurred while creating RequestSecurityTokenResponse.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="buildAssertion(org.w3c.dom.Document,org.apache.wss4j.common.crypto.Crypto,org.apache.rahas.RahasData)">
<h3>buildAssertion</h3>
<div class="member-signature"><span class="modifiers">protected</span>&nbsp;<span class="return-type">org.opensaml.saml.saml2.core.Assertion</span>&nbsp;<span class="element-name">buildAssertion</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.xml/org/w3c/dom/Document.html" title="class or interface in org.w3c.dom" class="external-link">Document</a>&nbsp;doc,
org.apache.wss4j.common.crypto.Crypto&nbsp;crypto,
<a href="../RahasData.html" title="class in org.apache.rahas">RahasData</a>&nbsp;data)</span>
throws <span class="exceptions"><a href="../TrustException.html" title="class in org.apache.rahas">TrustException</a></span></div>
<div class="block">This methods builds the SAML2 assertion. The equivalent XML would look as follows,
<pre>&lt;saml:Assertion
xmlns:saml="urn:oasis:names:tc:SAML:2.0:assertion"
xmlns:xs="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
ID="b07b804c-7c29-ea16-7300-4f3d6f7928ac"
Version="2.0"
IssueInstant="2004-12-05T09:22:05Z"&gt;
&lt;saml:Issuer&gt;https://idp.example.org/SAML2&lt;/saml:Issuer&gt;
&lt;ds:Signature
xmlns:ds="http://www.w3.org/2000/09/xmldsig#"&gt;...&lt;/ds:Signature&gt;
&lt;saml:Subject&gt;
&lt;saml:NameID
Format="urn:oasis:names:tc:SAML:2.0:nameid-format:transient"&gt;
3f7b3dcf-1674-4ecd-92c8-1544f346baf8
&lt;/saml:NameID&gt;
&lt;saml:SubjectConfirmation
Method="urn:oasis:names:tc:SAML:2.0:cm:bearer"&gt;
&lt;saml:SubjectConfirmationData
InResponseTo="aaf23196-1773-2113-474a-fe114412ab72"
Recipient="https://sp.example.com/SAML2/SSO/POST"
NotOnOrAfter="2004-12-05T09:27:05Z"/&gt;
&lt;/saml:SubjectConfirmation&gt;
&lt;/saml:Subject&gt;
&lt;saml:Conditions
NotBefore="2004-12-05T09:17:05Z"
NotOnOrAfter="2004-12-05T09:27:05Z"&gt;
&lt;saml:AudienceRestriction&gt;
&lt;saml:Audience&gt;https://sp.example.com/SAML2&lt;/saml:Audience&gt;
&lt;/saml:AudienceRestriction&gt;
&lt;/saml:Conditions&gt;
&lt;saml:AuthnStatement
AuthnInstant="2004-12-05T09:22:00Z"
SessionIndex="b07b804c-7c29-ea16-7300-4f3d6f7928ac"&gt;
&lt;saml:AuthnContext&gt;
&lt;saml:AuthnContextClassRef&gt;
urn:oasis:names:tc:SAML:2.0:ac:classes:PasswordProtectedTransport
&lt;/saml:AuthnContextClassRef&gt;
&lt;/saml:AuthnContext&gt;
&lt;/saml:AuthnStatement&gt;
&lt;saml:AttributeStatement&gt;
&lt;saml:Attribute
xmlns:x500="urn:oasis:names:tc:SAML:2.0:profiles:attribute:X500"
x500:Encoding="LDAP"
NameFormat="urn:oasis:names:tc:SAML:2.0:attrname-format:uri"
Name="urn:oid:1.3.6.1.4.1.5923.1.1.1.1"
FriendlyName="eduPersonAffiliation"&gt;
&lt;saml:AttributeValue
xsi:type="xs:string"&gt;member&lt;/saml:AttributeValue&gt;
&lt;saml:AttributeValue
xsi:type="xs:string"&gt;staff&lt;/saml:AttributeValue&gt;
&lt;/saml:Attribute&gt;
&lt;/saml:AttributeStatement&gt;
&lt;/saml:Assertion&gt;</pre>
Reference - en.wikipedia.org/wiki/SAML_2.0#SAML_2.0_Assertions</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>doc</code> - The Document which comprises SAML 2 assertion.</dd>
<dd><code>crypto</code> - Crypto properties.</dd>
<dd><code>data</code> - The RST data and other configuration information.</dd>
<dt>Returns:</dt>
<dd>OpenSAML representation of an Assertion.</dd>
<dt>Throws:</dt>
<dd><code><a href="../TrustException.html" title="class in org.apache.rahas">TrustException</a></code> - If an error occurred while creating the Assertion.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="createSubjectWithHolderOfKeySubjectConfirmation(org.w3c.dom.Document,org.apache.wss4j.common.crypto.Crypto,java.time.Instant,java.time.Instant,org.apache.rahas.RahasData)">
<h3>createSubjectWithHolderOfKeySubjectConfirmation</h3>
<div class="member-signature"><span class="modifiers">protected</span>&nbsp;<span class="return-type">org.opensaml.saml.saml2.core.Subject</span>&nbsp;<span class="element-name">createSubjectWithHolderOfKeySubjectConfirmation</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.xml/org/w3c/dom/Document.html" title="class or interface in org.w3c.dom" class="external-link">Document</a>&nbsp;doc,
org.apache.wss4j.common.crypto.Crypto&nbsp;crypto,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/time/Instant.html" title="class or interface in java.time" class="external-link">Instant</a>&nbsp;creationTime,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/time/Instant.html" title="class or interface in java.time" class="external-link">Instant</a>&nbsp;expirationTime,
<a href="../RahasData.html" title="class in org.apache.rahas">RahasData</a>&nbsp;data)</span>
throws <span class="exceptions"><a href="../TrustException.html" title="class in org.apache.rahas">TrustException</a></span></div>
<div class="block">This method will create a SAML 2 subject based on Holder of Key confirmation method.
The relevant XML would look as follows,
<pre> &lt;saml2:Subject&gt;
&lt;saml2:NameID&gt;
...
&lt;/saml2:NameID&gt;
&lt;saml2:SubjectConfirmation
Method="urn:oasis:names:tc:SAML:2.0:cm:holder-of-key"&gt;
&lt;saml2:SubjectConfirmationData
xsi:type="saml2:KeyInfoConfirmationDataType"&gt;
&lt;ds:KeyInfo&gt;
&lt;ds:KeyValue&gt;...&lt;/ds:KeyValue&gt;
&lt;/ds:KeyInfo&gt;
&lt;/saml2:SubjectConfirmationData&gt;
&lt;/saml2:SubjectConfirmation&gt;
&lt;/saml2:Subject&gt;</pre>
KeyInfo can be created based on public key or symmetric key. That is decided by looking at
the RahasData.getKeyType. TODO make sure this implementation is correct.
Theoretically we should be able to have many subject confirmation methods in a SAML2 subject.
TODO - Do we need to support that ?</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>doc</code> - The original XML document which we need to include the assertion.</dd>
<dd><code>crypto</code> - The relevant crypto properties</dd>
<dd><code>creationTime</code> - The time that assertion was created.</dd>
<dd><code>expirationTime</code> - The expiring time</dd>
<dd><code>data</code> - The configuration data relevant request.</dd>
<dt>Returns:</dt>
<dd>OpenSAML representation of the SAML2 object.</dd>
<dt>Throws:</dt>
<dd><code><a href="../TrustException.html" title="class in org.apache.rahas">TrustException</a></code> - If an error occurred while creating the subject.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="createSubjectWithBearerSubjectConfirmation(org.apache.rahas.RahasData)">
<h3>createSubjectWithBearerSubjectConfirmation</h3>
<div class="member-signature"><span class="modifiers">protected</span>&nbsp;<span class="return-type">org.opensaml.saml.saml2.core.Subject</span>&nbsp;<span class="element-name">createSubjectWithBearerSubjectConfirmation</span><wbr><span class="parameters">(<a href="../RahasData.html" title="class in org.apache.rahas">RahasData</a>&nbsp;data)</span>
throws <span class="exceptions"><a href="../TrustException.html" title="class in org.apache.rahas">TrustException</a></span></div>
<div class="block">This method creates a subject element with the bearer subject confirmation method.
<pre> &lt;saml:Subject&gt;
&lt;saml:NameIdentifier
NameQualifier="www.example.com"
Format="urn:oasis:names:tc:SAML:1.1:nameid-
format:X509SubjectName"&gt;
uid=joe,ou=people,ou=saml-demo,o=baltimore.com
&lt;/saml:NameIdentifier&gt;
&lt;saml:SubjectConfirmation&gt;
&lt;saml:ConfirmationMethod&gt;
urn:oasis:names:tc:SAML:1.0:cm:bearer
&lt;/saml:ConfirmationMethod&gt;
&lt;/saml:SubjectConfirmation&gt;
&lt;/saml:Subject&gt;</pre></div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>data</code> - RahasData element</dd>
<dt>Returns:</dt>
<dd>SAML 2.0 Subject element with Bearer subject confirmation</dd>
<dt>Throws:</dt>
<dd><code><a href="../TrustException.html" title="class in org.apache.rahas">TrustException</a></code> - if an error occurred while creating the subject.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="signAssertion(org.w3c.dom.Document,org.opensaml.saml.saml2.core.Assertion,org.apache.wss4j.common.crypto.Crypto)">
<h3>signAssertion</h3>
<div class="member-signature"><span class="modifiers">protected</span>&nbsp;<span class="return-type">org.opensaml.saml.saml2.core.Assertion</span>&nbsp;<span class="element-name">signAssertion</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.xml/org/w3c/dom/Document.html" title="class or interface in org.w3c.dom" class="external-link">Document</a>&nbsp;document,
org.opensaml.saml.saml2.core.Assertion&nbsp;assertion,
org.apache.wss4j.common.crypto.Crypto&nbsp;crypto)</span>
throws <span class="exceptions"><a href="../TrustException.html" title="class in org.apache.rahas">TrustException</a></span></div>
<div class="block">This method signs the given assertion with issuer's private key.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>document</code> - The original RST document.</dd>
<dd><code>assertion</code> - Assertion to be signed.</dd>
<dd><code>crypto</code> - The cryptographic properties.</dd>
<dt>Returns:</dt>
<dd>The signed assertion.</dd>
<dt>Throws:</dt>
<dd><code><a href="../TrustException.html" title="class in org.apache.rahas">TrustException</a></code> - If an error occurred while signing the assertion.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="createAttributeStatement(org.apache.rahas.RahasData)">
<h3>createAttributeStatement</h3>
<div class="member-signature"><span class="modifiers">protected</span>&nbsp;<span class="return-type">org.opensaml.saml.saml2.core.AttributeStatement</span>&nbsp;<span class="element-name">createAttributeStatement</span><wbr><span class="parameters">(<a href="../RahasData.html" title="class in org.apache.rahas">RahasData</a>&nbsp;data)</span>
throws <span class="exceptions"><a href="../TrustException.html" title="class in org.apache.rahas">TrustException</a></span></div>
<div class="block">This method creates an AttributeStatement. The relevant XML would look like as follows,
<pre> &lt;saml:AttributeStatement&gt;
&lt;saml:Attribute
xmlns:x500="urn:oasis:names:tc:SAML:2.0:profiles:attribute:X500"
x500:Encoding="LDAP"
NameFormat="urn:oasis:names:tc:SAML:2.0:attrname-format:uri"
Name="urn:oid:1.3.6.1.4.1.5923.1.1.1.1"
FriendlyName="eduPersonAffiliation"&gt;
&lt;saml:AttributeValue
xsi:type="xs:string"&gt;member&lt;/saml:AttributeValue&gt;
&lt;saml:AttributeValue
xsi:type="xs:string"&gt;staff&lt;/saml:AttributeValue&gt;
&lt;/saml:Attribute&gt;
&lt;/saml:AttributeStatement&gt;</pre>
Reference - http://en.wikipedia.org/wiki/SAML_2.0#SAML_2.0_Assertions</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>data</code> - The RahasData which carry information about RST.</dd>
<dt>Returns:</dt>
<dd>An AttributeStatement with filled attributes retrieved by calling callback class.</dd>
<dt>Throws:</dt>
<dd><code><a href="../TrustException.html" title="class in org.apache.rahas">TrustException</a></code> - If an error occurred while creating the AttributeStatement.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="createAuthenticationStatement(org.apache.rahas.RahasData)">
<h3>createAuthenticationStatement</h3>
<div class="member-signature"><span class="modifiers">protected</span>&nbsp;<span class="return-type">org.opensaml.saml.saml2.core.AuthnStatement</span>&nbsp;<span class="element-name">createAuthenticationStatement</span><wbr><span class="parameters">(<a href="../RahasData.html" title="class in org.apache.rahas">RahasData</a>&nbsp;data)</span>
throws <span class="exceptions"><a href="../TrustException.html" title="class in org.apache.rahas">TrustException</a></span></div>
<div class="block">This method creates an authentication statement. The equivalent XML would look as follows,
<pre> &lt;saml:AuthnStatement
AuthnInstant="2004-12-05T09:22:00Z"
SessionIndex="b07b804c-7c29-ea16-7300-4f3d6f7928ac"&gt;
&lt;saml:AuthnContext&gt;
&lt;saml:AuthnContextClassRef&gt;
urn:oasis:names:tc:SAML:2.0:ac:classes:PasswordProtectedTransport
&lt;/saml:AuthnContextClassRef&gt;
&lt;/saml:AuthnContext&gt;
&lt;/saml:AuthnStatement&gt;</pre></div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>data</code> - The RahasData which carry information about RST.</dd>
<dt>Returns:</dt>
<dd>OpenSAML representation of an AuthnStatement class.</dd>
<dt>Throws:</dt>
<dd><code><a href="../TrustException.html" title="class in org.apache.rahas">TrustException</a></code> - If an error occurred while creating the authentication statement.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="setSubjectNamedIdentifierData(org.opensaml.saml.saml2.core.Subject,java.lang.String,java.lang.String)">
<h3>setSubjectNamedIdentifierData</h3>
<div class="member-signature"><span class="modifiers">protected static</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">setSubjectNamedIdentifierData</span><wbr><span class="parameters">(org.opensaml.saml.saml2.core.Subject&nbsp;subject,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;subjectNameId,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;format)</span>
throws <span class="exceptions"><a href="../TrustException.html" title="class in org.apache.rahas">TrustException</a></span></div>
<div class="block">This method will set the subject principal details to the given subject.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>subject</code> - The subject.</dd>
<dd><code>subjectNameId</code> - Subject name id, to identify the principal</dd>
<dd><code>format</code> - Format of the subjectNameId, i.e. email, x509subject etc ...</dd>
<dt>Throws:</dt>
<dd><code><a href="../TrustException.html" title="class in org.apache.rahas">TrustException</a></code> - If an error occurred while building NameID.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="createKeyInfo(org.w3c.dom.Document,org.apache.wss4j.common.crypto.Crypto,org.apache.rahas.RahasData)">
<h3>createKeyInfo</h3>
<div class="member-signature"><span class="modifiers">protected</span>&nbsp;<span class="return-type">org.opensaml.xmlsec.signature.KeyInfo</span>&nbsp;<span class="element-name">createKeyInfo</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.xml/org/w3c/dom/Document.html" title="class or interface in org.w3c.dom" class="external-link">Document</a>&nbsp;doc,
org.apache.wss4j.common.crypto.Crypto&nbsp;crypto,
<a href="../RahasData.html" title="class in org.apache.rahas">RahasData</a>&nbsp;data)</span>
throws <span class="exceptions"><a href="../TrustException.html" title="class in org.apache.rahas">TrustException</a></span></div>
<div class="block">This method creates the KeyInfo relevant for the assertion. The KeyInfo could be created in 2 ways.
1. Using symmetric key - KeyInfo is created using a symmetric key
2. Using a public key - KeyInfo created using a public key
The methodology is decided by looking at RahasData.getKeyType() method.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>doc</code> - The document which we are processing.</dd>
<dd><code>crypto</code> - Includes crypto properties relevant to issuer.</dd>
<dd><code>data</code> - Includes metadata about the RST.</dd>
<dt>Returns:</dt>
<dd>OpenSAML representation of KeyInfo.</dd>
<dt>Throws:</dt>
<dd><code><a href="../TrustException.html" title="class in org.apache.rahas">TrustException</a></code> - If an error occurred while creating the KeyInfo object.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getResponseAction(org.apache.rahas.RahasData)">
<h3>getResponseAction</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span>&nbsp;<span class="element-name">getResponseAction</span><wbr><span class="parameters">(<a href="../RahasData.html" title="class in org.apache.rahas">RahasData</a>&nbsp;data)</span>
throws <span class="exceptions"><a href="../TrustException.html" title="class in org.apache.rahas">TrustException</a></span></div>
<div class="block"><span class="descfrm-type-label">Description copied from interface:&nbsp;<code><a href="../TokenIssuer.html#getResponseAction(org.apache.rahas.RahasData)">TokenIssuer</a></code></span></div>
<div class="block">Returns the <code>wsa:Action</code> of the response.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="../TokenIssuer.html#getResponseAction(org.apache.rahas.RahasData)">getResponseAction</a></code>&nbsp;in interface&nbsp;<code><a href="../TokenIssuer.html" title="interface in org.apache.rahas">TokenIssuer</a></code></dd>
<dt>Parameters:</dt>
<dd><code>data</code> - A populated <code>RahasData</code> instance</dd>
<dt>Returns:</dt>
<dd>Returns the <code>wsa:Action</code> of the response</dd>
<dt>Throws:</dt>
<dd><code><a href="../TrustException.html" title="class in org.apache.rahas">TrustException</a></code> - If an error occurred while during operation.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="setConfigurationFile(java.lang.String)">
<h3>setConfigurationFile</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">setConfigurationFile</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;configFile)</span></div>
<div class="block"><span class="descfrm-type-label">Description copied from interface:&nbsp;<code><a href="../TokenIssuer.html#setConfigurationFile(java.lang.String)">TokenIssuer</a></code></span></div>
<div class="block">Set the configuration file of this TokenIssuer.
<p>
This is the text value of the &lt;configuration-file&gt; element of the
token-dispatcher-configuration</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="../TokenIssuer.html#setConfigurationFile(java.lang.String)">setConfigurationFile</a></code>&nbsp;in interface&nbsp;<code><a href="../TokenIssuer.html" title="interface in org.apache.rahas">TokenIssuer</a></code></dd>
<dt>Parameters:</dt>
<dd><code>configFile</code> - Sets the token issuer configuration file.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="setConfigurationElement(org.apache.axiom.om.OMElement)">
<h3>setConfigurationElement</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">setConfigurationElement</span><wbr><span class="parameters">(org.apache.axiom.om.OMElement&nbsp;configElement)</span></div>
<div class="block"><span class="descfrm-type-label">Description copied from interface:&nbsp;<code><a href="../TokenIssuer.html#setConfigurationElement(org.apache.axiom.om.OMElement)">TokenIssuer</a></code></span></div>
<div class="block">Set the configuration element of this TokenIssuer.
<p>
This is the &lt;configuration&gt; element of the
token-dispatcher-configuration</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="../TokenIssuer.html#setConfigurationElement(org.apache.axiom.om.OMElement)">setConfigurationElement</a></code>&nbsp;in interface&nbsp;<code><a href="../TokenIssuer.html" title="interface in org.apache.rahas">TokenIssuer</a></code></dd>
<dt>Parameters:</dt>
<dd><code>configElement</code> - <code>OMElement</code> representing the configuration</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="setConfigurationParamName(java.lang.String)">
<h3>setConfigurationParamName</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">setConfigurationParamName</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;configParamName)</span></div>
<div class="block"><span class="descfrm-type-label">Description copied from interface:&nbsp;<code><a href="../TokenIssuer.html#setConfigurationParamName(java.lang.String)">TokenIssuer</a></code></span></div>
<div class="block">Set the name of the configuration parameter.
<p>
If this is used then there must be a
<code>org.apache.axis2.description.Parameter</code> object available in
the via the messageContext when the <code>TokenIssuer</code> is called.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="../TokenIssuer.html#setConfigurationParamName(java.lang.String)">setConfigurationParamName</a></code>&nbsp;in interface&nbsp;<code><a href="../TokenIssuer.html" title="interface in org.apache.rahas">TokenIssuer</a></code></dd>
<dt>Parameters:</dt>
<dd><code>configParamName</code> - The configuration parameter to be set.</dd>
<dt>See Also:</dt>
<dd>
<ul class="see-list">
<li><code>Parameter</code></li>
</ul>
</dd>
</dl>
</section>
</li>
</ul>
</section>
</li>
</ul>
</section>
<!-- ========= END OF CLASS DATA ========= -->
</main>
<footer role="contentinfo">
<hr>
<p class="legal-copy"><small>Copyright &copy; <a href="http://www.apache.org">Apache Software Foundation</a>. All Rights Reserved.</small></p>
</footer>
</div>
</div>
</body>
</html>