blob: ce85bf47c5c5ca6a7d0c8865b7ffbf065f6ba27d [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>
<!-- Generated by javadoc -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>LdapRoleMapper (Apache Archiva Redback 3.0.0-SNAPSHOT API)</title>
<link rel="stylesheet" type="text/css" href="../../../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../../../script.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 methods = {"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};
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";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<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/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">
<li><a href="../../../../../../../org/apache/archiva/redback/common/ldap/role/DefaultLdapRoleMapperConfiguration.html" title="class in org.apache.archiva.redback.common.ldap.role"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../../org/apache/archiva/redback/common/ldap/role/LdapRoleMapperConfiguration.html" title="interface in org.apache.archiva.redback.common.ldap.role"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../index.html?org/apache/archiva/redback/common/ldap/role/LdapRoleMapper.html" target="_top">Frames</a></li>
<li><a href="LdapRoleMapper.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../../../allclasses-noframe.html">All&nbsp;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.archiva.redback.common.ldap.role</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><a href="../../../../../../../org/apache/archiva/redback/common/ldap/role/DefaultLdapRoleMapper.html" title="class in org.apache.archiva.redback.common.ldap.role">DefaultLdapRoleMapper</a></dd>
</dl>
<hr>
<br>
<pre>public interface <a href="../../../../../../../src-html/org/apache/archiva/redback/common/ldap/role/LdapRoleMapper.html#line.34">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 =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<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="colLast" scope="col">Method and 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">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">String</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/archiva/redback/common/ldap/role/LdapRoleMapper.html#getAllGroups-javax.naming.directory.DirContext-">getAllGroups</a></span>(<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">DirContext</a>&nbsp;context)</code>
<div class="block">read all groups from ldap</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">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">String</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/archiva/redback/common/ldap/role/LdapRoleMapper.html#getAllRoles-javax.naming.directory.DirContext-">getAllRoles</a></span>(<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">DirContext</a>&nbsp;context)</code>
<div class="block">read all ldap groups then map to corresponding role (if no mapping found group is ignored)</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">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">String</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/archiva/redback/common/ldap/role/LdapRoleMapper.html#getGroups-java.lang.String-javax.naming.directory.DirContext-">getGroups</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">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">DirContext</a>&nbsp;context)</code>&nbsp;</td>
</tr>
<tr id="i3" class="rowColor">
<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">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/archiva/redback/common/ldap/role/LdapRoleMapper.html#getGroupsDn--">getGroupsDn</a></span>()</code>&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">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">String</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/archiva/redback/common/ldap/role/LdapRoleMapper.html#getGroupsMember-java.lang.String-javax.naming.directory.DirContext-">getGroupsMember</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">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">DirContext</a>&nbsp;context)</code>&nbsp;</td>
</tr>
<tr id="i5" class="rowColor">
<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">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/archiva/redback/common/ldap/role/LdapRoleMapper.html#getLdapGroupClass--">getLdapGroupClass</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i6" 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">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">String</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/archiva/redback/common/ldap/role/LdapRoleMapper.html#getRoles-java.lang.String-javax.naming.directory.DirContext-java.util.Collection-">getRoles</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">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">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">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">String</a>&gt;&nbsp;realRoles)</code>&nbsp;</td>
</tr>
<tr id="i7" class="rowColor">
<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">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/archiva/redback/common/ldap/role/LdapRoleMapper.html#getUserIdAttribute--">getUserIdAttribute</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/archiva/redback/common/ldap/role/LdapRoleMapper.html#hasRole-javax.naming.directory.DirContext-java.lang.String-">hasRole</a></span>(<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">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">String</a>&nbsp;role)</code>&nbsp;</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/archiva/redback/common/ldap/role/LdapRoleMapper.html#isUseDefaultRoleName--">isUseDefaultRoleName</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/archiva/redback/common/ldap/role/LdapRoleMapper.html#removeAllRoles-javax.naming.directory.DirContext-">removeAllRoles</a></span>(<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">DirContext</a>&nbsp;context)</code>&nbsp;</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/archiva/redback/common/ldap/role/LdapRoleMapper.html#removeRole-java.lang.String-javax.naming.directory.DirContext-">removeRole</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">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">DirContext</a>&nbsp;context)</code>&nbsp;</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/archiva/redback/common/ldap/role/LdapRoleMapper.html#removeUserRole-java.lang.String-java.lang.String-javax.naming.directory.DirContext-">removeUserRole</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">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">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">DirContext</a>&nbsp;context)</code>&nbsp;</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/archiva/redback/common/ldap/role/LdapRoleMapper.html#saveRole-java.lang.String-javax.naming.directory.DirContext-">saveRole</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">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">DirContext</a>&nbsp;context)</code>
<div class="block">will save a ldap group corresponding to the mapping.</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/archiva/redback/common/ldap/role/LdapRoleMapper.html#saveUserRole-java.lang.String-java.lang.String-javax.naming.directory.DirContext-">saveUserRole</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">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">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">DirContext</a>&nbsp;context)</code>
<div class="block">associate role to user in ldap</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="getAllGroups-javax.naming.directory.DirContext-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAllGroups</h4>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">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">String</a>&gt;&nbsp;<a href="../../../../../../../src-html/org/apache/archiva/redback/common/ldap/role/LdapRoleMapper.html#line.42">getAllGroups</a>(<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">DirContext</a>&nbsp;context)
throws <a href="../../../../../../../org/apache/archiva/redback/common/ldap/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="../../../../../../../org/apache/archiva/redback/common/ldap/MappingException.html" title="class in org.apache.archiva.redback.common.ldap">MappingException</a></code></dd>
</dl>
</li>
</ul>
<a name="getAllRoles-javax.naming.directory.DirContext-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAllRoles</h4>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">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">String</a>&gt;&nbsp;<a href="../../../../../../../src-html/org/apache/archiva/redback/common/ldap/role/LdapRoleMapper.html#line.51">getAllRoles</a>(<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">DirContext</a>&nbsp;context)
throws <a href="../../../../../../../org/apache/archiva/redback/common/ldap/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="../../../../../../../org/apache/archiva/redback/common/ldap/MappingException.html" title="class in org.apache.archiva.redback.common.ldap">MappingException</a></code></dd>
</dl>
</li>
</ul>
<a name="hasRole-javax.naming.directory.DirContext-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hasRole</h4>
<pre>boolean&nbsp;<a href="../../../../../../../src-html/org/apache/archiva/redback/common/ldap/role/LdapRoleMapper.html#line.54">hasRole</a>(<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">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">String</a>&nbsp;role)
throws <a href="../../../../../../../org/apache/archiva/redback/common/ldap/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="../../../../../../../org/apache/archiva/redback/common/ldap/MappingException.html" title="class in org.apache.archiva.redback.common.ldap">MappingException</a></code></dd>
</dl>
</li>
</ul>
<a name="getGroupsDn--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getGroupsDn</h4>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;<a href="../../../../../../../src-html/org/apache/archiva/redback/common/ldap/role/LdapRoleMapper.html#line.61">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 name="getLdapGroupClass--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLdapGroupClass</h4>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;<a href="../../../../../../../src-html/org/apache/archiva/redback/common/ldap/role/LdapRoleMapper.html#line.66">getLdapGroupClass</a>()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the class used for group usually groupOfUniqueNames</dd>
</dl>
</li>
</ul>
<a name="getGroupsMember-java.lang.String-javax.naming.directory.DirContext-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getGroupsMember</h4>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">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">String</a>&gt;&nbsp;<a href="../../../../../../../src-html/org/apache/archiva/redback/common/ldap/role/LdapRoleMapper.html#line.73">getGroupsMember</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">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">DirContext</a>&nbsp;context)
throws <a href="../../../../../../../org/apache/archiva/redback/common/ldap/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="../../../../../../../org/apache/archiva/redback/common/ldap/MappingException.html" title="class in org.apache.archiva.redback.common.ldap">MappingException</a></code></dd>
</dl>
</li>
</ul>
<a name="getGroups-java.lang.String-javax.naming.directory.DirContext-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getGroups</h4>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">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">String</a>&gt;&nbsp;<a href="../../../../../../../src-html/org/apache/archiva/redback/common/ldap/role/LdapRoleMapper.html#line.76">getGroups</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">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">DirContext</a>&nbsp;context)
throws <a href="../../../../../../../org/apache/archiva/redback/common/ldap/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="../../../../../../../org/apache/archiva/redback/common/ldap/MappingException.html" title="class in org.apache.archiva.redback.common.ldap">MappingException</a></code></dd>
</dl>
</li>
</ul>
<a name="getRoles-java.lang.String-javax.naming.directory.DirContext-java.util.Collection-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRoles</h4>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">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">String</a>&gt;&nbsp;<a href="../../../../../../../src-html/org/apache/archiva/redback/common/ldap/role/LdapRoleMapper.html#line.79">getRoles</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">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">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">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">String</a>&gt;&nbsp;realRoles)
throws <a href="../../../../../../../org/apache/archiva/redback/common/ldap/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="../../../../../../../org/apache/archiva/redback/common/ldap/MappingException.html" title="class in org.apache.archiva.redback.common.ldap">MappingException</a></code></dd>
</dl>
</li>
</ul>
<a name="saveRole-java.lang.String-javax.naming.directory.DirContext-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>saveRole</h4>
<pre>boolean&nbsp;<a href="../../../../../../../src-html/org/apache/archiva/redback/common/ldap/role/LdapRoleMapper.html#line.92">saveRole</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">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">DirContext</a>&nbsp;context)
throws <a href="../../../../../../../org/apache/archiva/redback/common/ldap/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="../../../../../../../org/apache/archiva/redback/common/ldap/MappingException.html" title="class in org.apache.archiva.redback.common.ldap">MappingException</a></code></dd>
</dl>
</li>
</ul>
<a name="saveUserRole-java.lang.String-java.lang.String-javax.naming.directory.DirContext-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>saveUserRole</h4>
<pre>boolean&nbsp;<a href="../../../../../../../src-html/org/apache/archiva/redback/common/ldap/role/LdapRoleMapper.html#line.103">saveUserRole</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">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">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">DirContext</a>&nbsp;context)
throws <a href="../../../../../../../org/apache/archiva/redback/common/ldap/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="../../../../../../../org/apache/archiva/redback/common/ldap/MappingException.html" title="class in org.apache.archiva.redback.common.ldap">MappingException</a></code></dd>
</dl>
</li>
</ul>
<a name="removeUserRole-java.lang.String-java.lang.String-javax.naming.directory.DirContext-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeUserRole</h4>
<pre>boolean&nbsp;<a href="../../../../../../../src-html/org/apache/archiva/redback/common/ldap/role/LdapRoleMapper.html#line.106">removeUserRole</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">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">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">DirContext</a>&nbsp;context)
throws <a href="../../../../../../../org/apache/archiva/redback/common/ldap/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="../../../../../../../org/apache/archiva/redback/common/ldap/MappingException.html" title="class in org.apache.archiva.redback.common.ldap">MappingException</a></code></dd>
</dl>
</li>
</ul>
<a name="removeAllRoles-javax.naming.directory.DirContext-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeAllRoles</h4>
<pre>void&nbsp;<a href="../../../../../../../src-html/org/apache/archiva/redback/common/ldap/role/LdapRoleMapper.html#line.109">removeAllRoles</a>(<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">DirContext</a>&nbsp;context)
throws <a href="../../../../../../../org/apache/archiva/redback/common/ldap/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="../../../../../../../org/apache/archiva/redback/common/ldap/MappingException.html" title="class in org.apache.archiva.redback.common.ldap">MappingException</a></code></dd>
</dl>
</li>
</ul>
<a name="removeRole-java.lang.String-javax.naming.directory.DirContext-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeRole</h4>
<pre>void&nbsp;<a href="../../../../../../../src-html/org/apache/archiva/redback/common/ldap/role/LdapRoleMapper.html#line.112">removeRole</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">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">DirContext</a>&nbsp;context)
throws <a href="../../../../../../../org/apache/archiva/redback/common/ldap/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="../../../../../../../org/apache/archiva/redback/common/ldap/MappingException.html" title="class in org.apache.archiva.redback.common.ldap">MappingException</a></code></dd>
</dl>
</li>
</ul>
<a name="getUserIdAttribute--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getUserIdAttribute</h4>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;<a href="../../../../../../../src-html/org/apache/archiva/redback/common/ldap/role/LdapRoleMapper.html#line.115">getUserIdAttribute</a>()</pre>
</li>
</ul>
<a name="isUseDefaultRoleName--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>isUseDefaultRoleName</h4>
<pre>boolean&nbsp;<a href="../../../../../../../src-html/org/apache/archiva/redback/common/ldap/role/LdapRoleMapper.html#line.117">isUseDefaultRoleName</a>()</pre>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<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/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">
<li><a href="../../../../../../../org/apache/archiva/redback/common/ldap/role/DefaultLdapRoleMapperConfiguration.html" title="class in org.apache.archiva.redback.common.ldap.role"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../../org/apache/archiva/redback/common/ldap/role/LdapRoleMapperConfiguration.html" title="interface in org.apache.archiva.redback.common.ldap.role"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../index.html?org/apache/archiva/redback/common/ldap/role/LdapRoleMapper.html" target="_top">Frames</a></li>
<li><a href="LdapRoleMapper.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../../../allclasses-noframe.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>
</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 &#169; 2006&#x2013;2019 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>