blob: b07e743ea9d44603ef75ba54890ca641998bf57e [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>DefaultSAMLRoleParser (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="DefaultSAMLRoleParser (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/DefaultSAMLRoleParser.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>Prev Class</li>
<li><a href="../../../../../../org/apache/cxf/sts/token/validator/DefaultSubjectRoleParser.html" title="class in org.apache.cxf.sts.token.validator"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/cxf/sts/token/validator/DefaultSAMLRoleParser.html" target="_top">Frames</a></li>
<li><a href="DefaultSAMLRoleParser.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><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="subNavList">
<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>
<a name="skip-navbar_top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.cxf.sts.token.validator</div>
<h2 title="Class DefaultSAMLRoleParser" class="title">Class DefaultSAMLRoleParser</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li><a href="../../../../../../org/apache/cxf/sts/token/validator/DefaultSubjectRoleParser.html" title="class in org.apache.cxf.sts.token.validator">org.apache.cxf.sts.token.validator.DefaultSubjectRoleParser</a></li>
<li>
<ul class="inheritance">
<li>org.apache.cxf.sts.token.validator.DefaultSAMLRoleParser</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="../../../../../../org/apache/cxf/sts/token/validator/SAMLRoleParser.html" title="interface in org.apache.cxf.sts.token.validator">SAMLRoleParser</a>, <a href="../../../../../../org/apache/cxf/sts/token/validator/SubjectRoleParser.html" title="interface in org.apache.cxf.sts.token.validator">SubjectRoleParser</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="strong">DefaultSAMLRoleParser</span>
extends <a href="../../../../../../org/apache/cxf/sts/token/validator/DefaultSubjectRoleParser.html" title="class in org.apache.cxf.sts.token.validator">DefaultSubjectRoleParser</a>
implements <a href="../../../../../../org/apache/cxf/sts/token/validator/SAMLRoleParser.html" title="interface in org.apache.cxf.sts.token.validator">SAMLRoleParser</a></pre>
<div class="block">A default implementation to extract roles from a SAML Assertion</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field_summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <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></code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/apache/cxf/sts/token/validator/DefaultSAMLRoleParser.html#SAML_ROLE_ATTRIBUTENAME_DEFAULT">SAML_ROLE_ATTRIBUTENAME_DEFAULT</a></strong></code>
<div class="block">This configuration tag specifies the default attribute name where the roles are present
The default is "http://schemas.xmlsoap.org/ws/2005/05/identity/claims/role".</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../../../../org/apache/cxf/sts/token/validator/DefaultSAMLRoleParser.html#DefaultSAMLRoleParser()">DefaultSAMLRoleParser</a></strong>()</code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ========== 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/7/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/cxf/sts/token/validator/DefaultSAMLRoleParser.html#getRoleAttributeName()">getRoleAttributeName</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/apache/cxf/sts/token/validator/DefaultSAMLRoleParser.html#isUseJaasSubject()">isUseJaasSubject</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a>&lt;<a href="http://docs.oracle.com/javase/7/docs/api/java/security/Principal.html?is-external=true" title="class or interface in java.security">Principal</a>&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/apache/cxf/sts/token/validator/DefaultSAMLRoleParser.html#parseRolesFromAssertion(java.security.Principal,%20javax.security.auth.Subject,%20org.apache.wss4j.common.saml.SamlAssertionWrapper)">parseRolesFromAssertion</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/security/Principal.html?is-external=true" title="class or interface in java.security">Principal</a>&nbsp;principal,
<a href="http://docs.oracle.com/javase/7/docs/api/javax/security/auth/Subject.html?is-external=true" title="class or interface in javax.security.auth">Subject</a>&nbsp;subject,
org.apache.wss4j.common.saml.SamlAssertionWrapper&nbsp;assertion)</code>
<div class="block">Return the set of User/Principal roles from the Assertion.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/apache/cxf/sts/token/validator/DefaultSAMLRoleParser.html#setRoleAttributeName(java.lang.String)">setRoleAttributeName</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;roleAttributeName)</code>
<div class="block">Set the attribute URI of the SAML AttributeStatement where the role information is stored.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/apache/cxf/sts/token/validator/DefaultSAMLRoleParser.html#setUseJaasSubject(boolean)">setUseJaasSubject</a></strong>(boolean&nbsp;useJaasSubject)</code>
<div class="block">Whether to get roles from the JAAS Subject (if not null) returned from SAML Assertion
Validation or not.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_org.apache.cxf.sts.token.validator.DefaultSubjectRoleParser">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.cxf.sts.token.validator.<a href="../../../../../../org/apache/cxf/sts/token/validator/DefaultSubjectRoleParser.html" title="class in org.apache.cxf.sts.token.validator">DefaultSubjectRoleParser</a></h3>
<code><a href="../../../../../../org/apache/cxf/sts/token/validator/DefaultSubjectRoleParser.html#getRoleClassifier()">getRoleClassifier</a>, <a href="../../../../../../org/apache/cxf/sts/token/validator/DefaultSubjectRoleParser.html#getRoleClassifierType()">getRoleClassifierType</a>, <a href="../../../../../../org/apache/cxf/sts/token/validator/DefaultSubjectRoleParser.html#parseRolesFromSubject(java.security.Principal,%20javax.security.auth.Subject)">parseRolesFromSubject</a>, <a href="../../../../../../org/apache/cxf/sts/token/validator/DefaultSubjectRoleParser.html#setRoleClassifier(java.lang.String)">setRoleClassifier</a>, <a href="../../../../../../org/apache/cxf/sts/token/validator/DefaultSubjectRoleParser.html#setRoleClassifierType(java.lang.String)">setRoleClassifierType</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait(long,%20int)" title="class or interface in java.lang">wait</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_org.apache.cxf.sts.token.validator.SubjectRoleParser">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.cxf.sts.token.validator.<a href="../../../../../../org/apache/cxf/sts/token/validator/SubjectRoleParser.html" title="interface in org.apache.cxf.sts.token.validator">SubjectRoleParser</a></h3>
<code><a href="../../../../../../org/apache/cxf/sts/token/validator/SubjectRoleParser.html#parseRolesFromSubject(java.security.Principal,%20javax.security.auth.Subject)">parseRolesFromSubject</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field_detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="SAML_ROLE_ATTRIBUTENAME_DEFAULT">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>SAML_ROLE_ATTRIBUTENAME_DEFAULT</h4>
<pre>public static final&nbsp;<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> SAML_ROLE_ATTRIBUTENAME_DEFAULT</pre>
<div class="block">This configuration tag specifies the default attribute name where the roles are present
The default is "http://schemas.xmlsoap.org/ws/2005/05/identity/claims/role".</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../../constant-values.html#org.apache.cxf.sts.token.validator.DefaultSAMLRoleParser.SAML_ROLE_ATTRIBUTENAME_DEFAULT">Constant Field Values</a></dd></dl>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="DefaultSAMLRoleParser()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>DefaultSAMLRoleParser</h4>
<pre>public&nbsp;DefaultSAMLRoleParser()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="parseRolesFromAssertion(java.security.Principal, javax.security.auth.Subject, org.apache.wss4j.common.saml.SamlAssertionWrapper)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>parseRolesFromAssertion</h4>
<pre>public&nbsp;<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a>&lt;<a href="http://docs.oracle.com/javase/7/docs/api/java/security/Principal.html?is-external=true" title="class or interface in java.security">Principal</a>&gt;&nbsp;parseRolesFromAssertion(<a href="http://docs.oracle.com/javase/7/docs/api/java/security/Principal.html?is-external=true" title="class or interface in java.security">Principal</a>&nbsp;principal,
<a href="http://docs.oracle.com/javase/7/docs/api/javax/security/auth/Subject.html?is-external=true" title="class or interface in javax.security.auth">Subject</a>&nbsp;subject,
org.apache.wss4j.common.saml.SamlAssertionWrapper&nbsp;assertion)</pre>
<div class="block">Return the set of User/Principal roles from the Assertion.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../../org/apache/cxf/sts/token/validator/SAMLRoleParser.html#parseRolesFromAssertion(java.security.Principal,%20javax.security.auth.Subject,%20org.apache.wss4j.common.saml.SamlAssertionWrapper)">parseRolesFromAssertion</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../org/apache/cxf/sts/token/validator/SAMLRoleParser.html" title="interface in org.apache.cxf.sts.token.validator">SAMLRoleParser</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>principal</code> - the Principal associated with the Assertion</dd><dd><code>subject</code> - the JAAS Subject associated with a successful validation of the Assertion</dd><dd><code>assertion</code> - The Assertion object</dd>
<dt><span class="strong">Returns:</span></dt><dd>the set of User/Principal roles from the Assertion.</dd></dl>
</li>
</ul>
<a name="isUseJaasSubject()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isUseJaasSubject</h4>
<pre>public&nbsp;boolean&nbsp;isUseJaasSubject()</pre>
</li>
</ul>
<a name="setUseJaasSubject(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setUseJaasSubject</h4>
<pre>public&nbsp;void&nbsp;setUseJaasSubject(boolean&nbsp;useJaasSubject)</pre>
<div class="block">Whether to get roles from the JAAS Subject (if not null) returned from SAML Assertion
Validation or not. The default is true.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>useJaasSubject</code> - whether to get roles from the JAAS Subject or not</dd></dl>
</li>
</ul>
<a name="getRoleAttributeName()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRoleAttributeName</h4>
<pre>public&nbsp;<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;getRoleAttributeName()</pre>
</li>
</ul>
<a name="setRoleAttributeName(java.lang.String)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>setRoleAttributeName</h4>
<pre>public&nbsp;void&nbsp;setRoleAttributeName(<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;roleAttributeName)</pre>
<div class="block">Set the attribute URI of the SAML AttributeStatement where the role information is stored.
The default is "http://schemas.xmlsoap.org/ws/2005/05/identity/claims/role".</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>roleAttributeName</code> - the Attribute URI where role information is stored</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/DefaultSAMLRoleParser.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>Prev Class</li>
<li><a href="../../../../../../org/apache/cxf/sts/token/validator/DefaultSubjectRoleParser.html" title="class in org.apache.cxf.sts.token.validator"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/cxf/sts/token/validator/DefaultSAMLRoleParser.html" target="_top">Frames</a></li>
<li><a href="DefaultSAMLRoleParser.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><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="subNavList">
<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>
<a name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Apache CXF</small></p>
</body>
</html>