Google Git
Sign in
apache / shiro-site / 01016f43374d9b054f3ea1e568b015d5d69428f9 / . / src / site / assets / static / 1.4.1 / shiro-core / xref / org / apache / shiro / realm / activedirectory / ActiveDirectoryRealm.html
blob: ded909fd755b54bd743699d6f984da6879b6296b [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head><meta http-equiv="content-type" content="text/html; charset=UTF-8" />
<title>ActiveDirectoryRealm xref</title>
<link type="text/css" rel="stylesheet" href="../../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../../apidocs/org/apache/shiro/realm/activedirectory/ActiveDirectoryRealm.html">View Javadoc</a></div><pre>
<a class="jxr_linenumber" name="L1" href="#L1">1</a> <em class="jxr_comment">/*</em>
<a class="jxr_linenumber" name="L2" href="#L2">2</a> <em class="jxr_comment"> * Licensed to the Apache Software Foundation (ASF) under one</em>
<a class="jxr_linenumber" name="L3" href="#L3">3</a> <em class="jxr_comment"> * or more contributor license agreements. See the NOTICE file</em>
<a class="jxr_linenumber" name="L4" href="#L4">4</a> <em class="jxr_comment"> * distributed with this work for additional information</em>
<a class="jxr_linenumber" name="L5" href="#L5">5</a> <em class="jxr_comment"> * regarding copyright ownership. The ASF licenses this file</em>
<a class="jxr_linenumber" name="L6" href="#L6">6</a> <em class="jxr_comment"> * to you under the Apache License, Version 2.0 (the</em>
<a class="jxr_linenumber" name="L7" href="#L7">7</a> <em class="jxr_comment"> * "License"); you may not use this file except in compliance</em>
<a class="jxr_linenumber" name="L8" href="#L8">8</a> <em class="jxr_comment"> * with the License. You may obtain a copy of the License at</em>
<a class="jxr_linenumber" name="L9" href="#L9">9</a> <em class="jxr_comment"> *</em>
<a class="jxr_linenumber" name="L10" href="#L10">10</a> <em class="jxr_comment"> * <a href="http://www.apache.org/licenses/LICENSE-2." target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.</a>0</em>
<a class="jxr_linenumber" name="L11" href="#L11">11</a> <em class="jxr_comment"> *</em>
<a class="jxr_linenumber" name="L12" href="#L12">12</a> <em class="jxr_comment"> * Unless required by applicable law or agreed to in writing,</em>
<a class="jxr_linenumber" name="L13" href="#L13">13</a> <em class="jxr_comment"> * software distributed under the License is distributed on an</em>
<a class="jxr_linenumber" name="L14" href="#L14">14</a> <em class="jxr_comment"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</em>
<a class="jxr_linenumber" name="L15" href="#L15">15</a> <em class="jxr_comment"> * KIND, either express or implied. See the License for the</em>
<a class="jxr_linenumber" name="L16" href="#L16">16</a> <em class="jxr_comment"> * specific language governing permissions and limitations</em>
<a class="jxr_linenumber" name="L17" href="#L17">17</a> <em class="jxr_comment"> * under the License.</em>
<a class="jxr_linenumber" name="L18" href="#L18">18</a> <em class="jxr_comment"> */</em>
<a class="jxr_linenumber" name="L19" href="#L19">19</a> <strong class="jxr_keyword">package</strong> org.apache.shiro.realm.activedirectory;
<a class="jxr_linenumber" name="L20" href="#L20">20</a>
<a class="jxr_linenumber" name="L21" href="#L21">21</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.authc.AuthenticationInfo;
<a class="jxr_linenumber" name="L22" href="#L22">22</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.authc.AuthenticationToken;
<a class="jxr_linenumber" name="L23" href="#L23">23</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.authc.SimpleAuthenticationInfo;
<a class="jxr_linenumber" name="L24" href="#L24">24</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.authc.UsernamePasswordToken;
<a class="jxr_linenumber" name="L25" href="#L25">25</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.authz.AuthorizationInfo;
<a class="jxr_linenumber" name="L26" href="#L26">26</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.authz.SimpleAuthorizationInfo;
<a class="jxr_linenumber" name="L27" href="#L27">27</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.realm.Realm;
<a class="jxr_linenumber" name="L28" href="#L28">28</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.realm.ldap.AbstractLdapRealm;
<a class="jxr_linenumber" name="L29" href="#L29">29</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.realm.ldap.LdapContextFactory;
<a class="jxr_linenumber" name="L30" href="#L30">30</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.realm.ldap.LdapUtils;
<a class="jxr_linenumber" name="L31" href="#L31">31</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.subject.PrincipalCollection;
<a class="jxr_linenumber" name="L32" href="#L32">32</a> <strong class="jxr_keyword">import</strong> org.slf4j.Logger;
<a class="jxr_linenumber" name="L33" href="#L33">33</a> <strong class="jxr_keyword">import</strong> org.slf4j.LoggerFactory;
<a class="jxr_linenumber" name="L34" href="#L34">34</a>
<a class="jxr_linenumber" name="L35" href="#L35">35</a> <strong class="jxr_keyword">import</strong> javax.naming.NamingEnumeration;
<a class="jxr_linenumber" name="L36" href="#L36">36</a> <strong class="jxr_keyword">import</strong> javax.naming.NamingException;
<a class="jxr_linenumber" name="L37" href="#L37">37</a> <strong class="jxr_keyword">import</strong> javax.naming.directory.Attribute;
<a class="jxr_linenumber" name="L38" href="#L38">38</a> <strong class="jxr_keyword">import</strong> javax.naming.directory.Attributes;
<a class="jxr_linenumber" name="L39" href="#L39">39</a> <strong class="jxr_keyword">import</strong> javax.naming.directory.SearchControls;
<a class="jxr_linenumber" name="L40" href="#L40">40</a> <strong class="jxr_keyword">import</strong> javax.naming.directory.SearchResult;
<a class="jxr_linenumber" name="L41" href="#L41">41</a> <strong class="jxr_keyword">import</strong> javax.naming.ldap.LdapContext;
<a class="jxr_linenumber" name="L42" href="#L42">42</a> <strong class="jxr_keyword">import</strong> java.util.*;
<a class="jxr_linenumber" name="L43" href="#L43">43</a>
<a class="jxr_linenumber" name="L44" href="#L44">44</a>
<a class="jxr_linenumber" name="L45" href="#L45">45</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L46" href="#L46">46</a> <em class="jxr_javadoccomment"> * A {@link Realm} that authenticates with an active directory LDAP</em>
<a class="jxr_linenumber" name="L47" href="#L47">47</a> <em class="jxr_javadoccomment"> * server to determine the roles for a particular user. This implementation</em>
<a class="jxr_linenumber" name="L48" href="#L48">48</a> <em class="jxr_javadoccomment"> * queries for the user's groups and then maps the group names to roles using the</em>
<a class="jxr_linenumber" name="L49" href="#L49">49</a> <em class="jxr_javadoccomment"> * {@link #groupRolesMap}.</em>
<a class="jxr_linenumber" name="L50" href="#L50">50</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L51" href="#L51">51</a> <em class="jxr_javadoccomment"> * @since 0.1</em>
<a class="jxr_linenumber" name="L52" href="#L52">52</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L53" href="#L53">53</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../org/apache/shiro/realm/activedirectory/ActiveDirectoryRealm.html">ActiveDirectoryRealm</a> <strong class="jxr_keyword">extends</strong> <a href="../../../../../org/apache/shiro/realm/ldap/AbstractLdapRealm.html">AbstractLdapRealm</a> {
<a class="jxr_linenumber" name="L54" href="#L54">54</a>
<a class="jxr_linenumber" name="L55" href="#L55">55</a> <em class="jxr_comment">//TODO - complete JavaDoc</em>
<a class="jxr_linenumber" name="L56" href="#L56">56</a>
<a class="jxr_linenumber" name="L57" href="#L57">57</a> <em class="jxr_comment">/*--------------------------------------------</em>
<a class="jxr_linenumber" name="L58" href="#L58">58</a> <em class="jxr_comment"> | C O N S T A N T S |</em>
<a class="jxr_linenumber" name="L59" href="#L59">59</a> <em class="jxr_comment"> ============================================*/</em>
<a class="jxr_linenumber" name="L60" href="#L60">60</a>
<a class="jxr_linenumber" name="L61" href="#L61">61</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> Logger log = LoggerFactory.getLogger(ActiveDirectoryRealm.<strong class="jxr_keyword">class</strong>);
<a class="jxr_linenumber" name="L62" href="#L62">62</a>
<a class="jxr_linenumber" name="L63" href="#L63">63</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String ROLE_NAMES_DELIMETER = <span class="jxr_string">","</span>;
<a class="jxr_linenumber" name="L64" href="#L64">64</a>
<a class="jxr_linenumber" name="L65" href="#L65">65</a> <em class="jxr_comment">/*--------------------------------------------</em>
<a class="jxr_linenumber" name="L66" href="#L66">66</a> <em class="jxr_comment"> | I N S T A N C E V A R I A B L E S |</em>
<a class="jxr_linenumber" name="L67" href="#L67">67</a> <em class="jxr_comment"> ============================================*/</em>
<a class="jxr_linenumber" name="L68" href="#L68">68</a>
<a class="jxr_linenumber" name="L69" href="#L69">69</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L70" href="#L70">70</a> <em class="jxr_javadoccomment"> * Mapping from fully qualified active directory</em>
<a class="jxr_linenumber" name="L71" href="#L71">71</a> <em class="jxr_javadoccomment"> * group names (e.g. CN=Group,OU=Company,DC=MyDomain,DC=local)</em>
<a class="jxr_linenumber" name="L72" href="#L72">72</a> <em class="jxr_javadoccomment"> * as returned by the active directory LDAP server to role names.</em>
<a class="jxr_linenumber" name="L73" href="#L73">73</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L74" href="#L74">74</a> <strong class="jxr_keyword">private</strong> Map&lt;String, String&gt; groupRolesMap;
<a class="jxr_linenumber" name="L75" href="#L75">75</a>
<a class="jxr_linenumber" name="L76" href="#L76">76</a> <em class="jxr_comment">/*--------------------------------------------</em>
<a class="jxr_linenumber" name="L77" href="#L77">77</a> <em class="jxr_comment"> | C O N S T R U C T O R S |</em>
<a class="jxr_linenumber" name="L78" href="#L78">78</a> <em class="jxr_comment"> ============================================*/</em>
<a class="jxr_linenumber" name="L79" href="#L79">79</a>
<a class="jxr_linenumber" name="L80" href="#L80">80</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setGroupRolesMap(Map&lt;String, String&gt; groupRolesMap) {
<a class="jxr_linenumber" name="L81" href="#L81">81</a> <strong class="jxr_keyword">this</strong>.groupRolesMap = groupRolesMap;
<a class="jxr_linenumber" name="L82" href="#L82">82</a> }
<a class="jxr_linenumber" name="L83" href="#L83">83</a>
<a class="jxr_linenumber" name="L84" href="#L84">84</a> <em class="jxr_comment">/*--------------------------------------------</em>
<a class="jxr_linenumber" name="L85" href="#L85">85</a> <em class="jxr_comment"> | M E T H O D S |</em>
<a class="jxr_linenumber" name="L86" href="#L86">86</a> <em class="jxr_comment"> ============================================*/</em>
<a class="jxr_linenumber" name="L87" href="#L87">87</a>
<a class="jxr_linenumber" name="L88" href="#L88">88</a>
<a class="jxr_linenumber" name="L89" href="#L89">89</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L90" href="#L90">90</a> <em class="jxr_javadoccomment"> * Builds an {@link AuthenticationInfo} object by querying the active directory LDAP context for the</em>
<a class="jxr_linenumber" name="L91" href="#L91">91</a> <em class="jxr_javadoccomment"> * specified username. This method binds to the LDAP server using the provided username and password -</em>
<a class="jxr_linenumber" name="L92" href="#L92">92</a> <em class="jxr_javadoccomment"> * which if successful, indicates that the password is correct.</em>
<a class="jxr_linenumber" name="L93" href="#L93">93</a> <em class="jxr_javadoccomment"> * &lt;p/&gt;</em>
<a class="jxr_linenumber" name="L94" href="#L94">94</a> <em class="jxr_javadoccomment"> * This method can be overridden by subclasses to query the LDAP server in a more complex way.</em>
<a class="jxr_linenumber" name="L95" href="#L95">95</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L96" href="#L96">96</a> <em class="jxr_javadoccomment"> * @param token the authentication token provided by the user.</em>
<a class="jxr_linenumber" name="L97" href="#L97">97</a> <em class="jxr_javadoccomment"> * @param ldapContextFactory the factory used to build connections to the LDAP server.</em>
<a class="jxr_linenumber" name="L98" href="#L98">98</a> <em class="jxr_javadoccomment"> * @return an {@link AuthenticationInfo} instance containing information retrieved from LDAP.</em>
<a class="jxr_linenumber" name="L99" href="#L99">99</a> <em class="jxr_javadoccomment"> * @throws NamingException if any LDAP errors occur during the search.</em>
<a class="jxr_linenumber" name="L100" href="#L100">100</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L101" href="#L101">101</a> <strong class="jxr_keyword">protected</strong> <a href="../../../../../org/apache/shiro/authc/AuthenticationInfo.html">AuthenticationInfo</a> queryForAuthenticationInfo(<a href="../../../../../org/apache/shiro/authc/AuthenticationToken.html">AuthenticationToken</a> token, <a href="../../../../../org/apache/shiro/realm/ldap/LdapContextFactory.html">LdapContextFactory</a> ldapContextFactory) <strong class="jxr_keyword">throws</strong> NamingException {
<a class="jxr_linenumber" name="L102" href="#L102">102</a>
<a class="jxr_linenumber" name="L103" href="#L103">103</a> <a href="../../../../../org/apache/shiro/authc/UsernamePasswordToken.html">UsernamePasswordToken</a> upToken = (UsernamePasswordToken) token;
<a class="jxr_linenumber" name="L104" href="#L104">104</a>
<a class="jxr_linenumber" name="L105" href="#L105">105</a> <em class="jxr_comment">// Binds using the username and password provided by the user.</em>
<a class="jxr_linenumber" name="L106" href="#L106">106</a> LdapContext ctx = <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="L107" href="#L107">107</a> <strong class="jxr_keyword">try</strong> {
<a class="jxr_linenumber" name="L108" href="#L108">108</a> ctx = ldapContextFactory.getLdapContext(upToken.getUsername(), String.valueOf(upToken.getPassword()));
<a class="jxr_linenumber" name="L109" href="#L109">109</a> } <strong class="jxr_keyword">finally</strong> {
<a class="jxr_linenumber" name="L110" href="#L110">110</a> LdapUtils.closeContext(ctx);
<a class="jxr_linenumber" name="L111" href="#L111">111</a> }
<a class="jxr_linenumber" name="L112" href="#L112">112</a>
<a class="jxr_linenumber" name="L113" href="#L113">113</a> <strong class="jxr_keyword">return</strong> buildAuthenticationInfo(upToken.getUsername(), upToken.getPassword());
<a class="jxr_linenumber" name="L114" href="#L114">114</a> }
<a class="jxr_linenumber" name="L115" href="#L115">115</a>
<a class="jxr_linenumber" name="L116" href="#L116">116</a> <strong class="jxr_keyword">protected</strong> <a href="../../../../../org/apache/shiro/authc/AuthenticationInfo.html">AuthenticationInfo</a> buildAuthenticationInfo(String username, <strong class="jxr_keyword">char</strong>[] password) {
<a class="jxr_linenumber" name="L117" href="#L117">117</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../org/apache/shiro/authc/SimpleAuthenticationInfo.html">SimpleAuthenticationInfo</a>(username, password, getName());
<a class="jxr_linenumber" name="L118" href="#L118">118</a> }
<a class="jxr_linenumber" name="L119" href="#L119">119</a>
<a class="jxr_linenumber" name="L120" href="#L120">120</a>
<a class="jxr_linenumber" name="L121" href="#L121">121</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L122" href="#L122">122</a> <em class="jxr_javadoccomment"> * Builds an {@link org.apache.shiro.authz.AuthorizationInfo} object by querying the active directory LDAP context for the</em>
<a class="jxr_linenumber" name="L123" href="#L123">123</a> <em class="jxr_javadoccomment"> * groups that a user is a member of. The groups are then translated to role names by using the</em>
<a class="jxr_linenumber" name="L124" href="#L124">124</a> <em class="jxr_javadoccomment"> * configured {@link #groupRolesMap}.</em>
<a class="jxr_linenumber" name="L125" href="#L125">125</a> <em class="jxr_javadoccomment"> * &lt;p/&gt;</em>
<a class="jxr_linenumber" name="L126" href="#L126">126</a> <em class="jxr_javadoccomment"> * This implementation expects the &lt;tt&gt;principal&lt;/tt&gt; argument to be a String username.</em>
<a class="jxr_linenumber" name="L127" href="#L127">127</a> <em class="jxr_javadoccomment"> * &lt;p/&gt;</em>
<a class="jxr_linenumber" name="L128" href="#L128">128</a> <em class="jxr_javadoccomment"> * Subclasses can override this method to determine authorization data (roles, permissions, etc) in a more</em>
<a class="jxr_linenumber" name="L129" href="#L129">129</a> <em class="jxr_javadoccomment"> * complex way. Note that this default implementation does not support permissions, only roles.</em>
<a class="jxr_linenumber" name="L130" href="#L130">130</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L131" href="#L131">131</a> <em class="jxr_javadoccomment"> * @param principals the principal of the Subject whose account is being retrieved.</em>
<a class="jxr_linenumber" name="L132" href="#L132">132</a> <em class="jxr_javadoccomment"> * @param ldapContextFactory the factory used to create LDAP connections.</em>
<a class="jxr_linenumber" name="L133" href="#L133">133</a> <em class="jxr_javadoccomment"> * @return the AuthorizationInfo for the given Subject principal.</em>
<a class="jxr_linenumber" name="L134" href="#L134">134</a> <em class="jxr_javadoccomment"> * @throws NamingException if an error occurs when searching the LDAP server.</em>
<a class="jxr_linenumber" name="L135" href="#L135">135</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L136" href="#L136">136</a> <strong class="jxr_keyword">protected</strong> <a href="../../../../../org/apache/shiro/authz/AuthorizationInfo.html">AuthorizationInfo</a> queryForAuthorizationInfo(<a href="../../../../../org/apache/shiro/subject/PrincipalCollection.html">PrincipalCollection</a> principals, <a href="../../../../../org/apache/shiro/realm/ldap/LdapContextFactory.html">LdapContextFactory</a> ldapContextFactory) <strong class="jxr_keyword">throws</strong> NamingException {
<a class="jxr_linenumber" name="L137" href="#L137">137</a>
<a class="jxr_linenumber" name="L138" href="#L138">138</a> String username = (String) getAvailablePrincipal(principals);
<a class="jxr_linenumber" name="L139" href="#L139">139</a>
<a class="jxr_linenumber" name="L140" href="#L140">140</a> <em class="jxr_comment">// Perform context search</em>
<a class="jxr_linenumber" name="L141" href="#L141">141</a> LdapContext ldapContext = ldapContextFactory.getSystemLdapContext();
<a class="jxr_linenumber" name="L142" href="#L142">142</a>
<a class="jxr_linenumber" name="L143" href="#L143">143</a> Set&lt;String&gt; roleNames;
<a class="jxr_linenumber" name="L144" href="#L144">144</a>
<a class="jxr_linenumber" name="L145" href="#L145">145</a> <strong class="jxr_keyword">try</strong> {
<a class="jxr_linenumber" name="L146" href="#L146">146</a> roleNames = getRoleNamesForUser(username, ldapContext);
<a class="jxr_linenumber" name="L147" href="#L147">147</a> } <strong class="jxr_keyword">finally</strong> {
<a class="jxr_linenumber" name="L148" href="#L148">148</a> LdapUtils.closeContext(ldapContext);
<a class="jxr_linenumber" name="L149" href="#L149">149</a> }
<a class="jxr_linenumber" name="L150" href="#L150">150</a>
<a class="jxr_linenumber" name="L151" href="#L151">151</a> <strong class="jxr_keyword">return</strong> buildAuthorizationInfo(roleNames);
<a class="jxr_linenumber" name="L152" href="#L152">152</a> }
<a class="jxr_linenumber" name="L153" href="#L153">153</a>
<a class="jxr_linenumber" name="L154" href="#L154">154</a> <strong class="jxr_keyword">protected</strong> <a href="../../../../../org/apache/shiro/authz/AuthorizationInfo.html">AuthorizationInfo</a> buildAuthorizationInfo(Set&lt;String&gt; roleNames) {
<a class="jxr_linenumber" name="L155" href="#L155">155</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../org/apache/shiro/authz/SimpleAuthorizationInfo.html">SimpleAuthorizationInfo</a>(roleNames);
<a class="jxr_linenumber" name="L156" href="#L156">156</a> }
<a class="jxr_linenumber" name="L157" href="#L157">157</a>
<a class="jxr_linenumber" name="L158" href="#L158">158</a> <strong class="jxr_keyword">protected</strong> Set&lt;String&gt; getRoleNamesForUser(String username, LdapContext ldapContext) <strong class="jxr_keyword">throws</strong> NamingException {
<a class="jxr_linenumber" name="L159" href="#L159">159</a> Set&lt;String&gt; roleNames;
<a class="jxr_linenumber" name="L160" href="#L160">160</a> roleNames = <strong class="jxr_keyword">new</strong> LinkedHashSet&lt;String&gt;();
<a class="jxr_linenumber" name="L161" href="#L161">161</a>
<a class="jxr_linenumber" name="L162" href="#L162">162</a> SearchControls searchCtls = <strong class="jxr_keyword">new</strong> SearchControls();
<a class="jxr_linenumber" name="L163" href="#L163">163</a> searchCtls.setSearchScope(SearchControls.SUBTREE_SCOPE);
<a class="jxr_linenumber" name="L164" href="#L164">164</a>
<a class="jxr_linenumber" name="L165" href="#L165">165</a> String userPrincipalName = username;
<a class="jxr_linenumber" name="L166" href="#L166">166</a> <strong class="jxr_keyword">if</strong> (principalSuffix != <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L167" href="#L167">167</a> userPrincipalName += principalSuffix;
<a class="jxr_linenumber" name="L168" href="#L168">168</a> }
<a class="jxr_linenumber" name="L169" href="#L169">169</a>
<a class="jxr_linenumber" name="L170" href="#L170">170</a> Object[] searchArguments = <strong class="jxr_keyword">new</strong> Object[]{userPrincipalName};
<a class="jxr_linenumber" name="L171" href="#L171">171</a>
<a class="jxr_linenumber" name="L172" href="#L172">172</a> NamingEnumeration answer = ldapContext.search(searchBase, searchFilter, searchArguments, searchCtls);
<a class="jxr_linenumber" name="L173" href="#L173">173</a>
<a class="jxr_linenumber" name="L174" href="#L174">174</a> <strong class="jxr_keyword">while</strong> (answer.hasMoreElements()) {
<a class="jxr_linenumber" name="L175" href="#L175">175</a> SearchResult sr = (SearchResult) answer.next();
<a class="jxr_linenumber" name="L176" href="#L176">176</a>
<a class="jxr_linenumber" name="L177" href="#L177">177</a> <strong class="jxr_keyword">if</strong> (log.isDebugEnabled()) {
<a class="jxr_linenumber" name="L178" href="#L178">178</a> log.debug(<span class="jxr_string">"Retrieving group names for user ["</span> + sr.getName() + <span class="jxr_string">"]"</span>);
<a class="jxr_linenumber" name="L179" href="#L179">179</a> }
<a class="jxr_linenumber" name="L180" href="#L180">180</a>
<a class="jxr_linenumber" name="L181" href="#L181">181</a> Attributes attrs = sr.getAttributes();
<a class="jxr_linenumber" name="L182" href="#L182">182</a>
<a class="jxr_linenumber" name="L183" href="#L183">183</a> <strong class="jxr_keyword">if</strong> (attrs != <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L184" href="#L184">184</a> NamingEnumeration ae = attrs.getAll();
<a class="jxr_linenumber" name="L185" href="#L185">185</a> <strong class="jxr_keyword">while</strong> (ae.hasMore()) {
<a class="jxr_linenumber" name="L186" href="#L186">186</a> Attribute attr = (Attribute) ae.next();
<a class="jxr_linenumber" name="L187" href="#L187">187</a>
<a class="jxr_linenumber" name="L188" href="#L188">188</a> <strong class="jxr_keyword">if</strong> (attr.getID().equals(<span class="jxr_string">"memberOf"</span>)) {
<a class="jxr_linenumber" name="L189" href="#L189">189</a>
<a class="jxr_linenumber" name="L190" href="#L190">190</a> Collection&lt;String&gt; groupNames = LdapUtils.getAllAttributeValues(attr);
<a class="jxr_linenumber" name="L191" href="#L191">191</a>
<a class="jxr_linenumber" name="L192" href="#L192">192</a> <strong class="jxr_keyword">if</strong> (log.isDebugEnabled()) {
<a class="jxr_linenumber" name="L193" href="#L193">193</a> log.debug(<span class="jxr_string">"Groups found for user ["</span> + username + <span class="jxr_string">"]: "</span> + groupNames);
<a class="jxr_linenumber" name="L194" href="#L194">194</a> }
<a class="jxr_linenumber" name="L195" href="#L195">195</a>
<a class="jxr_linenumber" name="L196" href="#L196">196</a> Collection&lt;String&gt; rolesForGroups = getRoleNamesForGroups(groupNames);
<a class="jxr_linenumber" name="L197" href="#L197">197</a> roleNames.addAll(rolesForGroups);
<a class="jxr_linenumber" name="L198" href="#L198">198</a> }
<a class="jxr_linenumber" name="L199" href="#L199">199</a> }
<a class="jxr_linenumber" name="L200" href="#L200">200</a> }
<a class="jxr_linenumber" name="L201" href="#L201">201</a> }
<a class="jxr_linenumber" name="L202" href="#L202">202</a> <strong class="jxr_keyword">return</strong> roleNames;
<a class="jxr_linenumber" name="L203" href="#L203">203</a> }
<a class="jxr_linenumber" name="L204" href="#L204">204</a>
<a class="jxr_linenumber" name="L205" href="#L205">205</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L206" href="#L206">206</a> <em class="jxr_javadoccomment"> * This method is called by the default implementation to translate Active Directory group names</em>
<a class="jxr_linenumber" name="L207" href="#L207">207</a> <em class="jxr_javadoccomment"> * to role names. This implementation uses the {@link #groupRolesMap} to map group names to role names.</em>
<a class="jxr_linenumber" name="L208" href="#L208">208</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L209" href="#L209">209</a> <em class="jxr_javadoccomment"> * @param groupNames the group names that apply to the current user.</em>
<a class="jxr_linenumber" name="L210" href="#L210">210</a> <em class="jxr_javadoccomment"> * @return a collection of roles that are implied by the given role names.</em>
<a class="jxr_linenumber" name="L211" href="#L211">211</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L212" href="#L212">212</a> <strong class="jxr_keyword">protected</strong> Collection&lt;String&gt; getRoleNamesForGroups(Collection&lt;String&gt; groupNames) {
<a class="jxr_linenumber" name="L213" href="#L213">213</a> Set&lt;String&gt; roleNames = <strong class="jxr_keyword">new</strong> HashSet&lt;String&gt;(groupNames.size());
<a class="jxr_linenumber" name="L214" href="#L214">214</a>
<a class="jxr_linenumber" name="L215" href="#L215">215</a> <strong class="jxr_keyword">if</strong> (groupRolesMap != <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L216" href="#L216">216</a> <strong class="jxr_keyword">for</strong> (String groupName : groupNames) {
<a class="jxr_linenumber" name="L217" href="#L217">217</a> String strRoleNames = groupRolesMap.get(groupName);
<a class="jxr_linenumber" name="L218" href="#L218">218</a> <strong class="jxr_keyword">if</strong> (strRoleNames != <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L219" href="#L219">219</a> <strong class="jxr_keyword">for</strong> (String roleName : strRoleNames.split(ROLE_NAMES_DELIMETER)) {
<a class="jxr_linenumber" name="L220" href="#L220">220</a>
<a class="jxr_linenumber" name="L221" href="#L221">221</a> <strong class="jxr_keyword">if</strong> (log.isDebugEnabled()) {
<a class="jxr_linenumber" name="L222" href="#L222">222</a> log.debug(<span class="jxr_string">"User is member of group ["</span> + groupName + <span class="jxr_string">"] so adding role ["</span> + roleName + <span class="jxr_string">"]"</span>);
<a class="jxr_linenumber" name="L223" href="#L223">223</a> }
<a class="jxr_linenumber" name="L224" href="#L224">224</a>
<a class="jxr_linenumber" name="L225" href="#L225">225</a> roleNames.add(roleName);
<a class="jxr_linenumber" name="L226" href="#L226">226</a>
<a class="jxr_linenumber" name="L227" href="#L227">227</a> }
<a class="jxr_linenumber" name="L228" href="#L228">228</a> }
<a class="jxr_linenumber" name="L229" href="#L229">229</a> }
<a class="jxr_linenumber" name="L230" href="#L230">230</a> }
<a class="jxr_linenumber" name="L231" href="#L231">231</a> <strong class="jxr_keyword">return</strong> roleNames;
<a class="jxr_linenumber" name="L232" href="#L232">232</a> }
<a class="jxr_linenumber" name="L233" href="#L233">233</a>
<a class="jxr_linenumber" name="L234" href="#L234">234</a> }
</pre>
<hr/>
<div id="footer">Copyright &#169; 2004&#x2013;2019 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</div>
</body>
</html>