blob: cb70d8fe49cf56e4362c163a2a0ec942bff246a5 [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="en">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../../../../../../stylesheet.css" title="Style">
</head>
<body>
<main role="main">
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span><a id="line.1">package org.apache.archiva.redback.common.ldap.role;</a>
<span class="sourceLineNo">002</span><a id="line.2">/*</a>
<span class="sourceLineNo">003</span><a id="line.3"> * Licensed to the Apache Software Foundation (ASF) under one</a>
<span class="sourceLineNo">004</span><a id="line.4"> * or more contributor license agreements. See the NOTICE file</a>
<span class="sourceLineNo">005</span><a id="line.5"> * distributed with this work for additional information</a>
<span class="sourceLineNo">006</span><a id="line.6"> * regarding copyright ownership. The ASF licenses this file</a>
<span class="sourceLineNo">007</span><a id="line.7"> * to you under the Apache License, Version 2.0 (the</a>
<span class="sourceLineNo">008</span><a id="line.8"> * "License"); you may not use this file except in compliance</a>
<span class="sourceLineNo">009</span><a id="line.9"> * with the License. You may obtain a copy of the License at</a>
<span class="sourceLineNo">010</span><a id="line.10"> *</a>
<span class="sourceLineNo">011</span><a id="line.11"> * http://www.apache.org/licenses/LICENSE-2.0</a>
<span class="sourceLineNo">012</span><a id="line.12"> *</a>
<span class="sourceLineNo">013</span><a id="line.13"> * Unless required by applicable law or agreed to in writing,</a>
<span class="sourceLineNo">014</span><a id="line.14"> * software distributed under the License is distributed on an</a>
<span class="sourceLineNo">015</span><a id="line.15"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</a>
<span class="sourceLineNo">016</span><a id="line.16"> * KIND, either express or implied. See the License for the</a>
<span class="sourceLineNo">017</span><a id="line.17"> * specific language governing permissions and limitations</a>
<span class="sourceLineNo">018</span><a id="line.18"> * under the License.</a>
<span class="sourceLineNo">019</span><a id="line.19"> */</a>
<span class="sourceLineNo">020</span><a id="line.20"></a>
<span class="sourceLineNo">021</span><a id="line.21">import org.apache.archiva.redback.common.ldap.MappingException;</a>
<span class="sourceLineNo">022</span><a id="line.22"></a>
<span class="sourceLineNo">023</span><a id="line.23">import java.util.Collection;</a>
<span class="sourceLineNo">024</span><a id="line.24">import java.util.List;</a>
<span class="sourceLineNo">025</span><a id="line.25">import java.util.Map;</a>
<span class="sourceLineNo">026</span><a id="line.26"></a>
<span class="sourceLineNo">027</span><a id="line.27">/**</a>
<span class="sourceLineNo">028</span><a id="line.28"> * @author Olivier Lamy</a>
<span class="sourceLineNo">029</span><a id="line.29"> * @since 2.1</a>
<span class="sourceLineNo">030</span><a id="line.30"> */</a>
<span class="sourceLineNo">031</span><a id="line.31">public interface LdapRoleMapperConfiguration</a>
<span class="sourceLineNo">032</span><a id="line.32">{</a>
<span class="sourceLineNo">033</span><a id="line.33"> /**</a>
<span class="sourceLineNo">034</span><a id="line.34"> * add mapping ldap group to redback roles</a>
<span class="sourceLineNo">035</span><a id="line.35"> *</a>
<span class="sourceLineNo">036</span><a id="line.36"> * @param roles list of Role names</a>
<span class="sourceLineNo">037</span><a id="line.37"> * @param ldapGroup ldap group</a>
<span class="sourceLineNo">038</span><a id="line.38"> */</a>
<span class="sourceLineNo">039</span><a id="line.39"> void addLdapMapping( String ldapGroup, List&lt;String&gt; roles )</a>
<span class="sourceLineNo">040</span><a id="line.40"> throws MappingException;</a>
<span class="sourceLineNo">041</span><a id="line.41"></a>
<span class="sourceLineNo">042</span><a id="line.42"> /**</a>
<span class="sourceLineNo">043</span><a id="line.43"> * update an existing mapping</a>
<span class="sourceLineNo">044</span><a id="line.44"> * @param ldapGroup</a>
<span class="sourceLineNo">045</span><a id="line.45"> * @param roles</a>
<span class="sourceLineNo">046</span><a id="line.46"> * @throws MappingException</a>
<span class="sourceLineNo">047</span><a id="line.47"> */</a>
<span class="sourceLineNo">048</span><a id="line.48"> void updateLdapMapping( String ldapGroup, List&lt;String&gt; roles )</a>
<span class="sourceLineNo">049</span><a id="line.49"> throws MappingException;</a>
<span class="sourceLineNo">050</span><a id="line.50"></a>
<span class="sourceLineNo">051</span><a id="line.51"> /**</a>
<span class="sourceLineNo">052</span><a id="line.52"> * remove a mapping</a>
<span class="sourceLineNo">053</span><a id="line.53"> *</a>
<span class="sourceLineNo">054</span><a id="line.54"> * @param group ldap group</a>
<span class="sourceLineNo">055</span><a id="line.55"> */</a>
<span class="sourceLineNo">056</span><a id="line.56"> void removeLdapMapping( String group )</a>
<span class="sourceLineNo">057</span><a id="line.57"> throws MappingException;</a>
<span class="sourceLineNo">058</span><a id="line.58"></a>
<span class="sourceLineNo">059</span><a id="line.59"> /**</a>
<span class="sourceLineNo">060</span><a id="line.60"> * @return Map of corresponding LDAP group (key) and Redback roles (value)</a>
<span class="sourceLineNo">061</span><a id="line.61"> */</a>
<span class="sourceLineNo">062</span><a id="line.62"> Map&lt;String, Collection&lt;String&gt;&gt; getLdapGroupMappings()</a>
<span class="sourceLineNo">063</span><a id="line.63"> throws MappingException;</a>
<span class="sourceLineNo">064</span><a id="line.64"></a>
<span class="sourceLineNo">065</span><a id="line.65"> /**</a>
<span class="sourceLineNo">066</span><a id="line.66"> * Returns the mapping for the given group</a>
<span class="sourceLineNo">067</span><a id="line.67"> * @param groupName the group name</a>
<span class="sourceLineNo">068</span><a id="line.68"> * @return the list of roles</a>
<span class="sourceLineNo">069</span><a id="line.69"> * @throws MappingException</a>
<span class="sourceLineNo">070</span><a id="line.70"> */</a>
<span class="sourceLineNo">071</span><a id="line.71"> Collection&lt;String&gt; getLdapGroupMapping(String groupName) throws MappingException;</a>
<span class="sourceLineNo">072</span><a id="line.72"></a>
<span class="sourceLineNo">073</span><a id="line.73"> void setLdapGroupMappings( Map&lt;String, List&lt;String&gt;&gt; mappings )</a>
<span class="sourceLineNo">074</span><a id="line.74"> throws MappingException;</a>
<span class="sourceLineNo">075</span><a id="line.75">}</a>
</pre>
</div>
</main>
</body>
</html>