Google Git
Sign in
apache / archiva-web-content / 1b7e811f9aa411dd1b001fe82a147012e4cce823 / . / redback / core / 3.0.0-SNAPSHOT / apidocs / org / apache / archiva / redback / common / ldap / role / LdapRoleMapper.html
blob: a6f958c5799f74bc450bea40369fa26de17237ec [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>LdapRoleMapper (Apache Archiva Redback 3.0.0-SNAPSHOT API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link rel="stylesheet" type="text/css" href="../../../../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../../../jquery/jquery-ui.css" title="Style">
<script type="text/javascript" src="../../../../../../../script.js"></script>
<script type="text/javascript" src="../../../../../../../jquery/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../../../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../../../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../../../../../../jquery/jquery-3.5.1.js"></script>
<script type="text/javascript" src="../../../../../../../jquery/jquery-ui.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="LdapRoleMapper (Apache Archiva Redback 3.0.0-SNAPSHOT API)";
}
}
catch(err) {
}
//-->
var data = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6,"i11":6,"i12":6,"i13":6,"i14":6,"i15":6,"i16":6,"i17":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
var pathtoroot = "../../../../../../../";
var useModuleDirectories = true;
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<header role="banner">
<nav role="navigation">
<div class="fixedNav">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a id="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/LdapRoleMapper.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" id="allclasses_navbar_top">
<li><a href="../../../../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</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>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</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 id="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
</div>
<div class="navPadding">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
</header>
<!-- ======== START OF CLASS DATA ======== -->
<main role="main">
<div class="header">
<div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">org.apache.archiva.redback.common.ldap.role</a></div>
<h2 title="Interface LdapRoleMapper" class="title">Interface LdapRoleMapper</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><code><a href="DefaultLdapRoleMapper.html" title="class in org.apache.archiva.redback.common.ldap.role">DefaultLdapRoleMapper</a></code></dd>
</dl>
<hr>
<pre>public interface <a href="../../../../../../../src-html/org/apache/archiva/redback/common/ldap/role/LdapRoleMapper.html#line.35">LdapRoleMapper</a></pre>
<div class="block">will map ldap group to redback role</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>2.1</dd>
<dt><span class="simpleTagLabel">Author:</span></dt>
<dd>Olivier Lamy</dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== METHOD SUMMARY =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a>&lt;<a href="LdapGroup.html" title="class in org.apache.archiva.redback.common.ldap.role">LdapGroup</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getAllGroupObjects(javax.naming.directory.DirContext)">getAllGroupObjects</a></span>&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/javax/naming/directory/DirContext.html?is-external=true" title="class or interface in javax.naming.directory" class="externalLink">DirContext</a>&nbsp;context)</code></th>
<td class="colLast">
<div class="block">Read all groups from LDAP and return the list of group objects.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getAllGroups(javax.naming.directory.DirContext)">getAllGroups</a></span>&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/javax/naming/directory/DirContext.html?is-external=true" title="class or interface in javax.naming.directory" class="externalLink">DirContext</a>&nbsp;context)</code></th>
<td class="colLast">
<div class="block">read all groups from ldap</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getAllRoles(javax.naming.directory.DirContext)">getAllRoles</a></span>&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/javax/naming/directory/DirContext.html?is-external=true" title="class or interface in javax.naming.directory" class="externalLink">DirContext</a>&nbsp;context)</code></th>
<td class="colLast">
<div class="block">read all ldap groups then map to corresponding role (if no mapping found group is ignored)</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="LdapGroup.html" title="class in org.apache.archiva.redback.common.ldap.role">LdapGroup</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getGroupForName(javax.naming.directory.DirContext,java.lang.String)">getGroupForName</a></span>&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/javax/naming/directory/DirContext.html?is-external=true" title="class or interface in javax.naming.directory" class="externalLink">DirContext</a>&nbsp;context,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;groupName)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a>&lt;<a href="LdapGroup.html" title="class in org.apache.archiva.redback.common.ldap.role">LdapGroup</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getGroupObjects(java.lang.String,javax.naming.directory.DirContext)">getGroupObjects</a></span>&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;username,
<a href="https://docs.oracle.com/javase/8/docs/api/javax/naming/directory/DirContext.html?is-external=true" title="class or interface in javax.naming.directory" class="externalLink">DirContext</a>&nbsp;context)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getGroups(java.lang.String,javax.naming.directory.DirContext)">getGroups</a></span>&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;username,
<a href="https://docs.oracle.com/javase/8/docs/api/javax/naming/directory/DirContext.html?is-external=true" title="class or interface in javax.naming.directory" class="externalLink">DirContext</a>&nbsp;context)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getGroupsDn()">getGroupsDn</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getGroupsMember(java.lang.String,javax.naming.directory.DirContext)">getGroupsMember</a></span>&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;group,
<a href="https://docs.oracle.com/javase/8/docs/api/javax/naming/directory/DirContext.html?is-external=true" title="class or interface in javax.naming.directory" class="externalLink">DirContext</a>&nbsp;context)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getLdapGroupClass()">getLdapGroupClass</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getRoles(java.lang.String,javax.naming.directory.DirContext,java.util.Collection)">getRoles</a></span>&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;username,
<a href="https://docs.oracle.com/javase/8/docs/api/javax/naming/directory/DirContext.html?is-external=true" title="class or interface in javax.naming.directory" class="externalLink">DirContext</a>&nbsp;context,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util" class="externalLink">Collection</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&gt;&nbsp;realRoles)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getUserIdAttribute()">getUserIdAttribute</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#hasRole(javax.naming.directory.DirContext,java.lang.String)">hasRole</a></span>&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/javax/naming/directory/DirContext.html?is-external=true" title="class or interface in javax.naming.directory" class="externalLink">DirContext</a>&nbsp;context,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;role)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isUseDefaultRoleName()">isUseDefaultRoleName</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#removeAllRoles(javax.naming.directory.DirContext)">removeAllRoles</a></span>&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/javax/naming/directory/DirContext.html?is-external=true" title="class or interface in javax.naming.directory" class="externalLink">DirContext</a>&nbsp;context)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#removeRole(java.lang.String,javax.naming.directory.DirContext)">removeRole</a></span>&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;roleName,
<a href="https://docs.oracle.com/javase/8/docs/api/javax/naming/directory/DirContext.html?is-external=true" title="class or interface in javax.naming.directory" class="externalLink">DirContext</a>&nbsp;context)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#removeUserRole(java.lang.String,java.lang.String,javax.naming.directory.DirContext)">removeUserRole</a></span>&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;roleName,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;username,
<a href="https://docs.oracle.com/javase/8/docs/api/javax/naming/directory/DirContext.html?is-external=true" title="class or interface in javax.naming.directory" class="externalLink">DirContext</a>&nbsp;context)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#saveRole(java.lang.String,javax.naming.directory.DirContext)">saveRole</a></span>&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;roleName,
<a href="https://docs.oracle.com/javase/8/docs/api/javax/naming/directory/DirContext.html?is-external=true" title="class or interface in javax.naming.directory" class="externalLink">DirContext</a>&nbsp;context)</code></th>
<td class="colLast">
<div class="block">will save a ldap group corresponding to the mapping.</div>
</td>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#saveUserRole(java.lang.String,java.lang.String,javax.naming.directory.DirContext)">saveUserRole</a></span>&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;roleName,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;username,
<a href="https://docs.oracle.com/javase/8/docs/api/javax/naming/directory/DirContext.html?is-external=true" title="class or interface in javax.naming.directory" class="externalLink">DirContext</a>&nbsp;context)</code></th>
<td class="colLast">
<div class="block">associate role to user in ldap</div>
</td>
</tr>
</table>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a id="getAllGroups(javax.naming.directory.DirContext)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAllGroups</h4>
<pre class="methodSignature"><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&gt;&nbsp;<a href="../../../../../../../src-html/org/apache/archiva/redback/common/ldap/role/LdapRoleMapper.html#line.43">getAllGroups</a>&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/javax/naming/directory/DirContext.html?is-external=true" title="class or interface in javax.naming.directory" class="externalLink">DirContext</a>&nbsp;context)
throws <a href="../MappingException.html" title="class in org.apache.archiva.redback.common.ldap">MappingException</a></pre>
<div class="block">read all groups from ldap</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>all LDAP groups</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../MappingException.html" title="class in org.apache.archiva.redback.common.ldap">MappingException</a></code></dd>
</dl>
</li>
</ul>
<a id="getAllGroupObjects(javax.naming.directory.DirContext)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAllGroupObjects</h4>
<pre class="methodSignature"><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a>&lt;<a href="LdapGroup.html" title="class in org.apache.archiva.redback.common.ldap.role">LdapGroup</a>&gt;&nbsp;<a href="../../../../../../../src-html/org/apache/archiva/redback/common/ldap/role/LdapRoleMapper.html#line.51">getAllGroupObjects</a>&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/javax/naming/directory/DirContext.html?is-external=true" title="class or interface in javax.naming.directory" class="externalLink">DirContext</a>&nbsp;context)
throws <a href="../MappingException.html" title="class in org.apache.archiva.redback.common.ldap">MappingException</a></pre>
<div class="block">Read all groups from LDAP and return the list of group objects.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>all LDAP groups found in the LDAP directory</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../MappingException.html" title="class in org.apache.archiva.redback.common.ldap">MappingException</a></code></dd>
</dl>
</li>
</ul>
<a id="getGroupForName(javax.naming.directory.DirContext,java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getGroupForName</h4>
<pre class="methodSignature"><a href="LdapGroup.html" title="class in org.apache.archiva.redback.common.ldap.role">LdapGroup</a>&nbsp;<a href="../../../../../../../src-html/org/apache/archiva/redback/common/ldap/role/LdapRoleMapper.html#line.54">getGroupForName</a>&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/javax/naming/directory/DirContext.html?is-external=true" title="class or interface in javax.naming.directory" class="externalLink">DirContext</a>&nbsp;context,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;groupName)
throws <a href="../MappingException.html" title="class in org.apache.archiva.redback.common.ldap">MappingException</a></pre>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../MappingException.html" title="class in org.apache.archiva.redback.common.ldap">MappingException</a></code></dd>
</dl>
</li>
</ul>
<a id="getAllRoles(javax.naming.directory.DirContext)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAllRoles</h4>
<pre class="methodSignature"><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&gt;&nbsp;<a href="../../../../../../../src-html/org/apache/archiva/redback/common/ldap/role/LdapRoleMapper.html#line.63">getAllRoles</a>&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/javax/naming/directory/DirContext.html?is-external=true" title="class or interface in javax.naming.directory" class="externalLink">DirContext</a>&nbsp;context)
throws <a href="../MappingException.html" title="class in org.apache.archiva.redback.common.ldap">MappingException</a></pre>
<div class="block">read all ldap groups then map to corresponding role (if no mapping found group is ignored)</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>all roles</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../MappingException.html" title="class in org.apache.archiva.redback.common.ldap">MappingException</a></code></dd>
</dl>
</li>
</ul>
<a id="hasRole(javax.naming.directory.DirContext,java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hasRole</h4>
<pre class="methodSignature">boolean&nbsp;<a href="../../../../../../../src-html/org/apache/archiva/redback/common/ldap/role/LdapRoleMapper.html#line.66">hasRole</a>&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/javax/naming/directory/DirContext.html?is-external=true" title="class or interface in javax.naming.directory" class="externalLink">DirContext</a>&nbsp;context,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;role)
throws <a href="../MappingException.html" title="class in org.apache.archiva.redback.common.ldap">MappingException</a></pre>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../MappingException.html" title="class in org.apache.archiva.redback.common.ldap">MappingException</a></code></dd>
</dl>
</li>
</ul>
<a id="getGroupsDn()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getGroupsDn</h4>
<pre class="methodSignature"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;<a href="../../../../../../../src-html/org/apache/archiva/redback/common/ldap/role/LdapRoleMapper.html#line.72">getGroupsDn</a>()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the base dn which contains all ldap groups</dd>
</dl>
</li>
</ul>
<a id="getLdapGroupClass()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLdapGroupClass</h4>
<pre class="methodSignature"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;<a href="../../../../../../../src-html/org/apache/archiva/redback/common/ldap/role/LdapRoleMapper.html#line.77">getLdapGroupClass</a>()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the class used for group usually groupOfUniqueNames</dd>
</dl>
</li>
</ul>
<a id="getGroupsMember(java.lang.String,javax.naming.directory.DirContext)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getGroupsMember</h4>
<pre class="methodSignature"><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&gt;&nbsp;<a href="../../../../../../../src-html/org/apache/archiva/redback/common/ldap/role/LdapRoleMapper.html#line.84">getGroupsMember</a>&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;group,
<a href="https://docs.oracle.com/javase/8/docs/api/javax/naming/directory/DirContext.html?is-external=true" title="class or interface in javax.naming.directory" class="externalLink">DirContext</a>&nbsp;context)
throws <a href="../MappingException.html" title="class in org.apache.archiva.redback.common.ldap">MappingException</a></pre>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>group</code> - ldap group</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>uids of group members</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../MappingException.html" title="class in org.apache.archiva.redback.common.ldap">MappingException</a></code></dd>
</dl>
</li>
</ul>
<a id="getGroups(java.lang.String,javax.naming.directory.DirContext)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getGroups</h4>
<pre class="methodSignature"><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&gt;&nbsp;<a href="../../../../../../../src-html/org/apache/archiva/redback/common/ldap/role/LdapRoleMapper.html#line.87">getGroups</a>&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;username,
<a href="https://docs.oracle.com/javase/8/docs/api/javax/naming/directory/DirContext.html?is-external=true" title="class or interface in javax.naming.directory" class="externalLink">DirContext</a>&nbsp;context)
throws <a href="../MappingException.html" title="class in org.apache.archiva.redback.common.ldap">MappingException</a></pre>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../MappingException.html" title="class in org.apache.archiva.redback.common.ldap">MappingException</a></code></dd>
</dl>
</li>
</ul>
<a id="getGroupObjects(java.lang.String,javax.naming.directory.DirContext)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getGroupObjects</h4>
<pre class="methodSignature"><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a>&lt;<a href="LdapGroup.html" title="class in org.apache.archiva.redback.common.ldap.role">LdapGroup</a>&gt;&nbsp;<a href="../../../../../../../src-html/org/apache/archiva/redback/common/ldap/role/LdapRoleMapper.html#line.90">getGroupObjects</a>&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;username,
<a href="https://docs.oracle.com/javase/8/docs/api/javax/naming/directory/DirContext.html?is-external=true" title="class or interface in javax.naming.directory" class="externalLink">DirContext</a>&nbsp;context)
throws <a href="../MappingException.html" title="class in org.apache.archiva.redback.common.ldap">MappingException</a></pre>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../MappingException.html" title="class in org.apache.archiva.redback.common.ldap">MappingException</a></code></dd>
</dl>
</li>
</ul>
<a id="getRoles(java.lang.String,javax.naming.directory.DirContext,java.util.Collection)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRoles</h4>
<pre class="methodSignature"><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&gt;&nbsp;<a href="../../../../../../../src-html/org/apache/archiva/redback/common/ldap/role/LdapRoleMapper.html#line.93">getRoles</a>&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;username,
<a href="https://docs.oracle.com/javase/8/docs/api/javax/naming/directory/DirContext.html?is-external=true" title="class or interface in javax.naming.directory" class="externalLink">DirContext</a>&nbsp;context,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util" class="externalLink">Collection</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&gt;&nbsp;realRoles)
throws <a href="../MappingException.html" title="class in org.apache.archiva.redback.common.ldap">MappingException</a></pre>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../MappingException.html" title="class in org.apache.archiva.redback.common.ldap">MappingException</a></code></dd>
</dl>
</li>
</ul>
<a id="saveRole(java.lang.String,javax.naming.directory.DirContext)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>saveRole</h4>
<pre class="methodSignature">boolean&nbsp;<a href="../../../../../../../src-html/org/apache/archiva/redback/common/ldap/role/LdapRoleMapper.html#line.106">saveRole</a>&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;roleName,
<a href="https://docs.oracle.com/javase/8/docs/api/javax/naming/directory/DirContext.html?is-external=true" title="class or interface in javax.naming.directory" class="externalLink">DirContext</a>&nbsp;context)
throws <a href="../MappingException.html" title="class in org.apache.archiva.redback.common.ldap">MappingException</a></pre>
<div class="block">will save a ldap group corresponding to the mapping.
<b>will do nothing in group already exists.</b></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>roleName</code> - </dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>true</code> if role was added, <code>false</code> if role already exists</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../MappingException.html" title="class in org.apache.archiva.redback.common.ldap">MappingException</a></code></dd>
</dl>
</li>
</ul>
<a id="saveUserRole(java.lang.String,java.lang.String,javax.naming.directory.DirContext)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>saveUserRole</h4>
<pre class="methodSignature">boolean&nbsp;<a href="../../../../../../../src-html/org/apache/archiva/redback/common/ldap/role/LdapRoleMapper.html#line.117">saveUserRole</a>&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;roleName,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;username,
<a href="https://docs.oracle.com/javase/8/docs/api/javax/naming/directory/DirContext.html?is-external=true" title="class or interface in javax.naming.directory" class="externalLink">DirContext</a>&nbsp;context)
throws <a href="../MappingException.html" title="class in org.apache.archiva.redback.common.ldap">MappingException</a></pre>
<div class="block">associate role to user in ldap</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>roleName</code> - </dd>
<dd><code>username</code> - </dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>true</code> if role was added to user, <code>false</code> if role already exists for the user</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../MappingException.html" title="class in org.apache.archiva.redback.common.ldap">MappingException</a></code></dd>
</dl>
</li>
</ul>
<a id="removeUserRole(java.lang.String,java.lang.String,javax.naming.directory.DirContext)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeUserRole</h4>
<pre class="methodSignature">boolean&nbsp;<a href="../../../../../../../src-html/org/apache/archiva/redback/common/ldap/role/LdapRoleMapper.html#line.120">removeUserRole</a>&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;roleName,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;username,
<a href="https://docs.oracle.com/javase/8/docs/api/javax/naming/directory/DirContext.html?is-external=true" title="class or interface in javax.naming.directory" class="externalLink">DirContext</a>&nbsp;context)
throws <a href="../MappingException.html" title="class in org.apache.archiva.redback.common.ldap">MappingException</a></pre>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../MappingException.html" title="class in org.apache.archiva.redback.common.ldap">MappingException</a></code></dd>
</dl>
</li>
</ul>
<a id="removeAllRoles(javax.naming.directory.DirContext)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeAllRoles</h4>
<pre class="methodSignature">void&nbsp;<a href="../../../../../../../src-html/org/apache/archiva/redback/common/ldap/role/LdapRoleMapper.html#line.123">removeAllRoles</a>&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/javax/naming/directory/DirContext.html?is-external=true" title="class or interface in javax.naming.directory" class="externalLink">DirContext</a>&nbsp;context)
throws <a href="../MappingException.html" title="class in org.apache.archiva.redback.common.ldap">MappingException</a></pre>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../MappingException.html" title="class in org.apache.archiva.redback.common.ldap">MappingException</a></code></dd>
</dl>
</li>
</ul>
<a id="removeRole(java.lang.String,javax.naming.directory.DirContext)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeRole</h4>
<pre class="methodSignature">void&nbsp;<a href="../../../../../../../src-html/org/apache/archiva/redback/common/ldap/role/LdapRoleMapper.html#line.126">removeRole</a>&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;roleName,
<a href="https://docs.oracle.com/javase/8/docs/api/javax/naming/directory/DirContext.html?is-external=true" title="class or interface in javax.naming.directory" class="externalLink">DirContext</a>&nbsp;context)
throws <a href="../MappingException.html" title="class in org.apache.archiva.redback.common.ldap">MappingException</a></pre>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../MappingException.html" title="class in org.apache.archiva.redback.common.ldap">MappingException</a></code></dd>
</dl>
</li>
</ul>
<a id="getUserIdAttribute()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getUserIdAttribute</h4>
<pre class="methodSignature"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;<a href="../../../../../../../src-html/org/apache/archiva/redback/common/ldap/role/LdapRoleMapper.html#line.129">getUserIdAttribute</a>()</pre>
</li>
</ul>
<a id="isUseDefaultRoleName()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>isUseDefaultRoleName</h4>
<pre class="methodSignature">boolean&nbsp;<a href="../../../../../../../src-html/org/apache/archiva/redback/common/ldap/role/LdapRoleMapper.html#line.131">isUseDefaultRoleName</a>()</pre>
</li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
</div>
</main>
<!-- ========= END OF CLASS DATA ========= -->
<footer role="contentinfo">
<nav role="navigation">
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a id="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/LdapRoleMapper.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" id="allclasses_navbar_bottom">
<li><a href="../../../../../../../allclasses.html">All&nbsp;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>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</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 id="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
<p class="legalCopy"><small>Copyright &#169; 2006&#x2013;2022 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</footer>
</body>
</html>