| <!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 javax.naming.directory.DirContext;</a> |
| <span class="sourceLineNo">024</span><a id="line.24">import java.util.Collection;</a> |
| <span class="sourceLineNo">025</span><a id="line.25">import java.util.List;</a> |
| <span class="sourceLineNo">026</span><a id="line.26">import java.util.Map;</a> |
| <span class="sourceLineNo">027</span><a id="line.27">import java.util.stream.Stream;</a> |
| <span class="sourceLineNo">028</span><a id="line.28"></a> |
| <span class="sourceLineNo">029</span><a id="line.29">/**</a> |
| <span class="sourceLineNo">030</span><a id="line.30"> * will map ldap group to redback role</a> |
| <span class="sourceLineNo">031</span><a id="line.31"> *</a> |
| <span class="sourceLineNo">032</span><a id="line.32"> * @author Olivier Lamy</a> |
| <span class="sourceLineNo">033</span><a id="line.33"> * @since 2.1</a> |
| <span class="sourceLineNo">034</span><a id="line.34"> */</a> |
| <span class="sourceLineNo">035</span><a id="line.35">public interface LdapRoleMapper</a> |
| <span class="sourceLineNo">036</span><a id="line.36">{</a> |
| <span class="sourceLineNo">037</span><a id="line.37"></a> |
| <span class="sourceLineNo">038</span><a id="line.38"> /**</a> |
| <span class="sourceLineNo">039</span><a id="line.39"> * read all groups from ldap</a> |
| <span class="sourceLineNo">040</span><a id="line.40"> *</a> |
| <span class="sourceLineNo">041</span><a id="line.41"> * @return all LDAP groups</a> |
| <span class="sourceLineNo">042</span><a id="line.42"> */</a> |
| <span class="sourceLineNo">043</span><a id="line.43"> List<String> getAllGroups( DirContext context )</a> |
| <span class="sourceLineNo">044</span><a id="line.44"> throws MappingException;</a> |
| <span class="sourceLineNo">045</span><a id="line.45"></a> |
| <span class="sourceLineNo">046</span><a id="line.46"> /**</a> |
| <span class="sourceLineNo">047</span><a id="line.47"> * Read all groups from LDAP and return the list of group objects.</a> |
| <span class="sourceLineNo">048</span><a id="line.48"> *</a> |
| <span class="sourceLineNo">049</span><a id="line.49"> * @return all LDAP groups found in the LDAP directory</a> |
| <span class="sourceLineNo">050</span><a id="line.50"> */</a> |
| <span class="sourceLineNo">051</span><a id="line.51"> List<LdapGroup> getAllGroupObjects( DirContext context )</a> |
| <span class="sourceLineNo">052</span><a id="line.52"> throws MappingException;</a> |
| <span class="sourceLineNo">053</span><a id="line.53"></a> |
| <span class="sourceLineNo">054</span><a id="line.54"> LdapGroup getGroupForName( DirContext context, String groupName )</a> |
| <span class="sourceLineNo">055</span><a id="line.55"> throws MappingException;</a> |
| <span class="sourceLineNo">056</span><a id="line.56"></a> |
| <span class="sourceLineNo">057</span><a id="line.57"> /**</a> |
| <span class="sourceLineNo">058</span><a id="line.58"> * read all ldap groups then map to corresponding role (if no mapping found group is ignored)</a> |
| <span class="sourceLineNo">059</span><a id="line.59"> *</a> |
| <span class="sourceLineNo">060</span><a id="line.60"> * @return all roles</a> |
| <span class="sourceLineNo">061</span><a id="line.61"> * @throws MappingException</a> |
| <span class="sourceLineNo">062</span><a id="line.62"> */</a> |
| <span class="sourceLineNo">063</span><a id="line.63"> List<String> getAllRoles( DirContext context )</a> |
| <span class="sourceLineNo">064</span><a id="line.64"> throws MappingException;</a> |
| <span class="sourceLineNo">065</span><a id="line.65"></a> |
| <span class="sourceLineNo">066</span><a id="line.66"> boolean hasRole( DirContext context, String role )</a> |
| <span class="sourceLineNo">067</span><a id="line.67"> throws MappingException;</a> |
| <span class="sourceLineNo">068</span><a id="line.68"></a> |
| <span class="sourceLineNo">069</span><a id="line.69"> /**</a> |
| <span class="sourceLineNo">070</span><a id="line.70"> * @return the base dn which contains all ldap groups</a> |
| <span class="sourceLineNo">071</span><a id="line.71"> */</a> |
| <span class="sourceLineNo">072</span><a id="line.72"> String getGroupsDn();</a> |
| <span class="sourceLineNo">073</span><a id="line.73"></a> |
| <span class="sourceLineNo">074</span><a id="line.74"> /**</a> |
| <span class="sourceLineNo">075</span><a id="line.75"> * @return the class used for group usually groupOfUniqueNames</a> |
| <span class="sourceLineNo">076</span><a id="line.76"> */</a> |
| <span class="sourceLineNo">077</span><a id="line.77"> String getLdapGroupClass();</a> |
| <span class="sourceLineNo">078</span><a id="line.78"></a> |
| <span class="sourceLineNo">079</span><a id="line.79"> /**</a> |
| <span class="sourceLineNo">080</span><a id="line.80"> * @param group ldap group</a> |
| <span class="sourceLineNo">081</span><a id="line.81"> * @return uids of group members</a> |
| <span class="sourceLineNo">082</span><a id="line.82"> * @throws MappingException</a> |
| <span class="sourceLineNo">083</span><a id="line.83"> */</a> |
| <span class="sourceLineNo">084</span><a id="line.84"> List<String> getGroupsMember( String group, DirContext context )</a> |
| <span class="sourceLineNo">085</span><a id="line.85"> throws MappingException;</a> |
| <span class="sourceLineNo">086</span><a id="line.86"></a> |
| <span class="sourceLineNo">087</span><a id="line.87"> List<String> getGroups( String username, DirContext context )</a> |
| <span class="sourceLineNo">088</span><a id="line.88"> throws MappingException;</a> |
| <span class="sourceLineNo">089</span><a id="line.89"></a> |
| <span class="sourceLineNo">090</span><a id="line.90"> List<LdapGroup> getGroupObjects( String username, DirContext context )</a> |
| <span class="sourceLineNo">091</span><a id="line.91"> throws MappingException;</a> |
| <span class="sourceLineNo">092</span><a id="line.92"></a> |
| <span class="sourceLineNo">093</span><a id="line.93"> List<String> getRoles( String username, DirContext context, Collection<String> realRoles )</a> |
| <span class="sourceLineNo">094</span><a id="line.94"> throws MappingException;</a> |
| <span class="sourceLineNo">095</span><a id="line.95"></a> |
| <span class="sourceLineNo">096</span><a id="line.96"></a> |
| <span class="sourceLineNo">097</span><a id="line.97"></a> |
| <span class="sourceLineNo">098</span><a id="line.98"> /**</a> |
| <span class="sourceLineNo">099</span><a id="line.99"> * will save a ldap group corresponding to the mapping.</a> |
| <span class="sourceLineNo">100</span><a id="line.100"> * <b>will do nothing in group already exists.</b></a> |
| <span class="sourceLineNo">101</span><a id="line.101"> *</a> |
| <span class="sourceLineNo">102</span><a id="line.102"> * @param roleName</a> |
| <span class="sourceLineNo">103</span><a id="line.103"> * @return <code>true</code> if role was added, <code>false</code> if role already exists</a> |
| <span class="sourceLineNo">104</span><a id="line.104"> * @throws MappingException</a> |
| <span class="sourceLineNo">105</span><a id="line.105"> */</a> |
| <span class="sourceLineNo">106</span><a id="line.106"> boolean saveRole( String roleName, DirContext context )</a> |
| <span class="sourceLineNo">107</span><a id="line.107"> throws MappingException;</a> |
| <span class="sourceLineNo">108</span><a id="line.108"></a> |
| <span class="sourceLineNo">109</span><a id="line.109"> /**</a> |
| <span class="sourceLineNo">110</span><a id="line.110"> * associate role to user in ldap</a> |
| <span class="sourceLineNo">111</span><a id="line.111"> *</a> |
| <span class="sourceLineNo">112</span><a id="line.112"> * @param roleName</a> |
| <span class="sourceLineNo">113</span><a id="line.113"> * @param username</a> |
| <span class="sourceLineNo">114</span><a id="line.114"> * @return <code>true</code> if role was added to user, <code>false</code> if role already exists for the user</a> |
| <span class="sourceLineNo">115</span><a id="line.115"> * @throws MappingException</a> |
| <span class="sourceLineNo">116</span><a id="line.116"> */</a> |
| <span class="sourceLineNo">117</span><a id="line.117"> boolean saveUserRole( String roleName, String username, DirContext context )</a> |
| <span class="sourceLineNo">118</span><a id="line.118"> throws MappingException;</a> |
| <span class="sourceLineNo">119</span><a id="line.119"></a> |
| <span class="sourceLineNo">120</span><a id="line.120"> boolean removeUserRole( String roleName, String username, DirContext context )</a> |
| <span class="sourceLineNo">121</span><a id="line.121"> throws MappingException;</a> |
| <span class="sourceLineNo">122</span><a id="line.122"></a> |
| <span class="sourceLineNo">123</span><a id="line.123"> void removeAllRoles( DirContext context )</a> |
| <span class="sourceLineNo">124</span><a id="line.124"> throws MappingException;</a> |
| <span class="sourceLineNo">125</span><a id="line.125"></a> |
| <span class="sourceLineNo">126</span><a id="line.126"> void removeRole( String roleName, DirContext context )</a> |
| <span class="sourceLineNo">127</span><a id="line.127"> throws MappingException;</a> |
| <span class="sourceLineNo">128</span><a id="line.128"></a> |
| <span class="sourceLineNo">129</span><a id="line.129"> String getUserIdAttribute();</a> |
| <span class="sourceLineNo">130</span><a id="line.130"></a> |
| <span class="sourceLineNo">131</span><a id="line.131"> boolean isUseDefaultRoleName();</a> |
| <span class="sourceLineNo">132</span><a id="line.132"></a> |
| <span class="sourceLineNo">133</span><a id="line.133">}</a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </main> |
| </body> |
| </html> |
