blob: a52d085b2cefbab9d25aac98bb7d62444e35b20e [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>ClaimsMapper (Apache CXF JavaDoc 3.1.0 API)</title>
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="ClaimsMapper (Apache CXF JavaDoc 3.1.0 API)";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/ClaimsMapper.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
<div class="aboutLanguage"><em>Apache CXF API</em></div>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/apache/cxf/sts/claims/ClaimsManager.html" title="class in org.apache.cxf.sts.claims"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../org/apache/cxf/sts/claims/ClaimsParameters.html" title="class in org.apache.cxf.sts.claims"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/cxf/sts/claims/ClaimsMapper.html" target="_top">Frames</a></li>
<li><a href="ClaimsMapper.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.cxf.sts.claims</div>
<h2 title="Interface ClaimsMapper" class="title">Interface ClaimsMapper</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/claims/mapper/JexlClaimsMapper.html" title="class in org.apache.cxf.sts.claims.mapper">JexlClaimsMapper</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="strong">ClaimsMapper</span></pre>
<div class="block">This interface defines a pluggable way of mapping claims from a source realm to a target
realm.</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="../../../../../org/apache/cxf/sts/claims/ProcessedClaimCollection.html" title="class in org.apache.cxf.sts.claims">ProcessedClaimCollection</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/cxf/sts/claims/ClaimsMapper.html#mapClaims(java.lang.String,%20org.apache.cxf.sts.claims.ProcessedClaimCollection,%20java.lang.String,%20org.apache.cxf.sts.claims.ClaimsParameters)">mapClaims</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;sourceRealm,
<a href="../../../../../org/apache/cxf/sts/claims/ProcessedClaimCollection.html" title="class in org.apache.cxf.sts.claims">ProcessedClaimCollection</a>&nbsp;sourceClaims,
<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;targetRealm,
<a href="../../../../../org/apache/cxf/sts/claims/ClaimsParameters.html" title="class in org.apache.cxf.sts.claims">ClaimsParameters</a>&nbsp;parameters)</code>
<div class="block">Map a collection of claims in the source realm to the target realm</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="mapClaims(java.lang.String, org.apache.cxf.sts.claims.ProcessedClaimCollection, java.lang.String, org.apache.cxf.sts.claims.ClaimsParameters)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>mapClaims</h4>
<pre><a href="../../../../../org/apache/cxf/sts/claims/ProcessedClaimCollection.html" title="class in org.apache.cxf.sts.claims">ProcessedClaimCollection</a>&nbsp;mapClaims(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;sourceRealm,
<a href="../../../../../org/apache/cxf/sts/claims/ProcessedClaimCollection.html" title="class in org.apache.cxf.sts.claims">ProcessedClaimCollection</a>&nbsp;sourceClaims,
<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;targetRealm,
<a href="../../../../../org/apache/cxf/sts/claims/ClaimsParameters.html" title="class in org.apache.cxf.sts.claims">ClaimsParameters</a>&nbsp;parameters)</pre>
<div class="block">Map a collection of claims in the source realm to the target realm</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>sourceRealm</code> - the source realm of the Principal</dd><dd><code>sourceClaims</code> - the claims collection in the source realm</dd><dd><code>targetRealm</code> - the target realm of the Principal</dd>
<dt><span class="strong">Returns:</span></dt><dd>claims collection of the target realm</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/ClaimsMapper.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
<div class="aboutLanguage"><em>Apache CXF API</em></div>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/apache/cxf/sts/claims/ClaimsManager.html" title="class in org.apache.cxf.sts.claims"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../org/apache/cxf/sts/claims/ClaimsParameters.html" title="class in org.apache.cxf.sts.claims"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/cxf/sts/claims/ClaimsMapper.html" target="_top">Frames</a></li>
<li><a href="ClaimsMapper.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>Apache CXF</small></p>
</body>
</html>