Google Git
Sign in
apache / axis-site / b0e13d4b24437ff26e96c3d95ca0ac6e466a3951 / . / axis2 / java / rampart-staging / apidocs / org / apache / rahas / TokenIssuer.html
blob: 2622dc2554e17739f6257e0849d4b90d6df110d8 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
<title>TokenIssuer (Apache Rampart)</title>
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="TokenIssuer (Apache Rampart)";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/TokenIssuer.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>
<div class="subNav">
<ul class="navList">
<li><a href="../../../org/apache/rahas/TokenCanceler.html" title="interface in org.apache.rahas"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../org/apache/rahas/TokenRenewer.html" title="interface in org.apache.rahas"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?org/apache/rahas/TokenIssuer.html" target="_top">Frames</a></li>
<li><a href="TokenIssuer.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.rahas</div>
<h2 title="Interface TokenIssuer" class="title">Interface TokenIssuer</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/rahas/impl/SAML2TokenIssuer.html" title="class in org.apache.rahas.impl">SAML2TokenIssuer</a>, <a href="../../../org/apache/rahas/impl/SAMLTokenIssuer.html" title="class in org.apache.rahas.impl">SAMLTokenIssuer</a>, <a href="../../../org/apache/rahas/impl/SCTIssuer.html" title="class in org.apache.rahas.impl">SCTIssuer</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="strong">TokenIssuer</span></pre>
<div class="block">The <code>TokenIssuer</code></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="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../../org/apache/rahas/TokenIssuer.html#getResponseAction(org.apache.rahas.RahasData)">getResponseAction</a></strong>(<a href="../../../org/apache/rahas/RahasData.html" title="class in org.apache.rahas">RahasData</a>&nbsp;data)</code>
<div class="block">Returns the <code>wsa:Action</code> of the response.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>org.apache.axiom.soap.SOAPEnvelope</code></td>
<td class="colLast"><code><strong><a href="../../../org/apache/rahas/TokenIssuer.html#issue(org.apache.rahas.RahasData)">issue</a></strong>(<a href="../../../org/apache/rahas/RahasData.html" title="class in org.apache.rahas">RahasData</a>&nbsp;data)</code>
<div class="block">Create the response <code>soap:Envelope</code> for the given issue
request.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../org/apache/rahas/TokenIssuer.html#setConfigurationElement(org.apache.axiom.om.OMElement)">setConfigurationElement</a></strong>(org.apache.axiom.om.OMElement&nbsp;configElement)</code>
<div class="block">Set the configuration element of this TokenIssuer.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../org/apache/rahas/TokenIssuer.html#setConfigurationFile(java.lang.String)">setConfigurationFile</a></strong>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;configFile)</code>
<div class="block">Set the configuration file of this TokenIssuer.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../org/apache/rahas/TokenIssuer.html#setConfigurationParamName(java.lang.String)">setConfigurationParamName</a></strong>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;configParamName)</code>
<div class="block">Set the name of the configuration parameter.</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="issue(org.apache.rahas.RahasData)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>issue</h4>
<pre>org.apache.axiom.soap.SOAPEnvelope&nbsp;issue(<a href="../../../org/apache/rahas/RahasData.html" title="class in org.apache.rahas">RahasData</a>&nbsp;data)
throws <a href="../../../org/apache/rahas/TrustException.html" title="class in org.apache.rahas">TrustException</a></pre>
<div class="block">Create the response <code>soap:Envelope</code> for the given issue
request.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>data</code> - A populated <code>RahasData</code> instance</dd>
<dt><span class="strong">Returns:</span></dt><dd>The response <code>soap:Envelope</code> for the given issue
request.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../org/apache/rahas/TrustException.html" title="class in org.apache.rahas">TrustException</a></code> - If an error occurred while creating the token.</dd></dl>
</li>
</ul>
<a name="getResponseAction(org.apache.rahas.RahasData)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getResponseAction</h4>
<pre><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getResponseAction(<a href="../../../org/apache/rahas/RahasData.html" title="class in org.apache.rahas">RahasData</a>&nbsp;data)
throws <a href="../../../org/apache/rahas/TrustException.html" title="class in org.apache.rahas">TrustException</a></pre>
<div class="block">Returns the <code>wsa:Action</code> of the response.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>data</code> - A populated <code>RahasData</code> instance</dd>
<dt><span class="strong">Returns:</span></dt><dd>Returns the <code>wsa:Action</code> of the response</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../org/apache/rahas/TrustException.html" title="class in org.apache.rahas">TrustException</a></code> - If an error occurred while during operation.</dd></dl>
</li>
</ul>
<a name="setConfigurationFile(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setConfigurationFile</h4>
<pre>void&nbsp;setConfigurationFile(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;configFile)</pre>
<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><dt><span class="strong">Parameters:</span></dt><dd><code>configFile</code> - Sets the token issuer configuration file.</dd></dl>
</li>
</ul>
<a name="setConfigurationElement(org.apache.axiom.om.OMElement)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setConfigurationElement</h4>
<pre>void&nbsp;setConfigurationElement(org.apache.axiom.om.OMElement&nbsp;configElement)</pre>
<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><dt><span class="strong">Parameters:</span></dt><dd><code>configElement</code> - <code>OMElement</code> representing the configuration</dd></dl>
</li>
</ul>
<a name="setConfigurationParamName(java.lang.String)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>setConfigurationParamName</h4>
<pre>void&nbsp;setConfigurationParamName(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;configParamName)</pre>
<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><dt><span class="strong">Parameters:</span></dt><dd><code>configParamName</code> - The configuration parameter to be set.</dd><dt><span class="strong">See Also:</span></dt><dd><code>Parameter</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><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/TokenIssuer.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>
<div class="subNav">
<ul class="navList">
<li><a href="../../../org/apache/rahas/TokenCanceler.html" title="interface in org.apache.rahas"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../org/apache/rahas/TokenRenewer.html" title="interface in org.apache.rahas"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?org/apache/rahas/TokenIssuer.html" target="_top">Frames</a></li>
<li><a href="TokenIssuer.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &copy; <a href="http://www.apache.org">Apache Software Foundation</a>. All Rights Reserved.</small></p>
</body>
</html>