Google Git
Sign in
apache / shiro-site / 01016f43374d9b054f3ea1e568b015d5d69428f9 / . / src / site / assets / static / 1.8.0 / xref / org / apache / shiro / realm / ldap / DefaultLdapContextFactory.html
blob: c1872bc1e9996a80a4a0bb65880a70800a0bbf5c [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>DefaultLdapContextFactory xref</title>
<link type="text/css" rel="stylesheet" href="../../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../../apidocs/org/apache/shiro/realm/ldap/DefaultLdapContextFactory.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.0" target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a></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.ldap;
<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> java.util.Hashtable;
<a class="jxr_linenumber" name="L22" href="#L22">22</a> <strong class="jxr_keyword">import</strong> java.util.Map;
<a class="jxr_linenumber" name="L23" href="#L23">23</a> <strong class="jxr_keyword">import</strong> javax.naming.AuthenticationException;
<a class="jxr_linenumber" name="L24" href="#L24">24</a> <strong class="jxr_keyword">import</strong> javax.naming.Context;
<a class="jxr_linenumber" name="L25" href="#L25">25</a> <strong class="jxr_keyword">import</strong> javax.naming.NamingException;
<a class="jxr_linenumber" name="L26" href="#L26">26</a> <strong class="jxr_keyword">import</strong> javax.naming.ldap.InitialLdapContext;
<a class="jxr_linenumber" name="L27" href="#L27">27</a> <strong class="jxr_keyword">import</strong> javax.naming.ldap.LdapContext;
<a class="jxr_linenumber" name="L28" href="#L28">28</a>
<a class="jxr_linenumber" name="L29" href="#L29">29</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.util.StringUtils;
<a class="jxr_linenumber" name="L30" href="#L30">30</a> <strong class="jxr_keyword">import</strong> org.slf4j.Logger;
<a class="jxr_linenumber" name="L31" href="#L31">31</a> <strong class="jxr_keyword">import</strong> org.slf4j.LoggerFactory;
<a class="jxr_linenumber" name="L32" href="#L32">32</a>
<a class="jxr_linenumber" name="L33" href="#L33">33</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L34" href="#L34">34</a> <em class="jxr_javadoccomment"> * &lt;p&gt;Default implementation of {@link LdapContextFactory} that can be configured or extended to</em>
<a class="jxr_linenumber" name="L35" href="#L35">35</a> <em class="jxr_javadoccomment"> * customize the way {@link javax.naming.ldap.LdapContext} objects are retrieved.&lt;/p&gt;</em>
<a class="jxr_linenumber" name="L36" href="#L36">36</a> <em class="jxr_javadoccomment"> * &lt;p/&gt;</em>
<a class="jxr_linenumber" name="L37" href="#L37">37</a> <em class="jxr_javadoccomment"> * &lt;p&gt;This implementation of {@link LdapContextFactory} is used by the {@link AbstractLdapRealm} if a</em>
<a class="jxr_linenumber" name="L38" href="#L38">38</a> <em class="jxr_javadoccomment"> * factory is not explictly configured.&lt;/p&gt;</em>
<a class="jxr_linenumber" name="L39" href="#L39">39</a> <em class="jxr_javadoccomment"> * &lt;p/&gt;</em>
<a class="jxr_linenumber" name="L40" href="#L40">40</a> <em class="jxr_javadoccomment"> * &lt;p&gt;Connection pooling is enabled by default on this factory, but can be disabled using the</em>
<a class="jxr_linenumber" name="L41" href="#L41">41</a> <em class="jxr_javadoccomment"> * {@link #usePooling} property.&lt;/p&gt;</em>
<a class="jxr_linenumber" name="L42" href="#L42">42</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L43" href="#L43">43</a> <em class="jxr_javadoccomment"> * @since 0.2</em>
<a class="jxr_linenumber" name="L44" href="#L44">44</a> <em class="jxr_javadoccomment"> * @deprecated replaced by the {@link JndiLdapContextFactory} implementation. This implementation will be removed</em>
<a class="jxr_linenumber" name="L45" href="#L45">45</a> <em class="jxr_javadoccomment"> * prior to Shiro 2.0</em>
<a class="jxr_linenumber" name="L46" href="#L46">46</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L47" href="#L47">47</a> @Deprecated
<a class="jxr_linenumber" name="L48" href="#L48">48</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a name="DefaultLdapContextFactory" href="../../../../../org/apache/shiro/realm/ldap/DefaultLdapContextFactory.html#DefaultLdapContextFactory">DefaultLdapContextFactory</a> <strong class="jxr_keyword">implements</strong> <a name="LdapContextFactory" href="../../../../../org/apache/shiro/realm/ldap/LdapContextFactory.html#LdapContextFactory">LdapContextFactory</a> {
<a class="jxr_linenumber" name="L49" href="#L49">49</a>
<a class="jxr_linenumber" name="L50" href="#L50">50</a> <em class="jxr_comment">//TODO - complete JavaDoc</em>
<a class="jxr_linenumber" name="L51" href="#L51">51</a>
<a class="jxr_linenumber" name="L52" href="#L52">52</a> <em class="jxr_comment">/*--------------------------------------------</em>
<a class="jxr_linenumber" name="L53" href="#L53">53</a> <em class="jxr_comment"> | C O N S T A N T S |</em>
<a class="jxr_linenumber" name="L54" href="#L54">54</a> <em class="jxr_comment"> ============================================*/</em>
<a class="jxr_linenumber" name="L55" href="#L55">55</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L56" href="#L56">56</a> <em class="jxr_javadoccomment"> * The Sun LDAP property used to enable connection pooling. This is used in the default implementation</em>
<a class="jxr_linenumber" name="L57" href="#L57">57</a> <em class="jxr_javadoccomment"> * to enable LDAP connection pooling.</em>
<a class="jxr_linenumber" name="L58" href="#L58">58</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L59" href="#L59">59</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String SUN_CONNECTION_POOLING_PROPERTY = <span class="jxr_string">"com.sun.jndi.ldap.connect.pool"</span>;
<a class="jxr_linenumber" name="L60" href="#L60">60</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String SIMPLE_AUTHENTICATION_MECHANISM_NAME = <span class="jxr_string">"simple"</span>;
<a class="jxr_linenumber" name="L61" href="#L61">61</a>
<a class="jxr_linenumber" name="L62" href="#L62">62</a> <em class="jxr_comment">/*--------------------------------------------</em>
<a class="jxr_linenumber" name="L63" href="#L63">63</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="L64" href="#L64">64</a> <em class="jxr_comment"> ============================================*/</em>
<a class="jxr_linenumber" name="L65" href="#L65">65</a>
<a class="jxr_linenumber" name="L66" href="#L66">66</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> Logger log = LoggerFactory.getLogger(DefaultLdapContextFactory.<strong class="jxr_keyword">class</strong>);
<a class="jxr_linenumber" name="L67" href="#L67">67</a>
<a class="jxr_linenumber" name="L68" href="#L68">68</a> <strong class="jxr_keyword">protected</strong> String authentication = SIMPLE_AUTHENTICATION_MECHANISM_NAME;
<a class="jxr_linenumber" name="L69" href="#L69">69</a>
<a class="jxr_linenumber" name="L70" href="#L70">70</a> <strong class="jxr_keyword">protected</strong> String principalSuffix = <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="L71" href="#L71">71</a>
<a class="jxr_linenumber" name="L72" href="#L72">72</a> <strong class="jxr_keyword">protected</strong> String searchBase = <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="L73" href="#L73">73</a>
<a class="jxr_linenumber" name="L74" href="#L74">74</a> <strong class="jxr_keyword">protected</strong> String contextFactoryClassName = <span class="jxr_string">"com.sun.jndi.ldap.LdapCtxFactory"</span>;
<a class="jxr_linenumber" name="L75" href="#L75">75</a>
<a class="jxr_linenumber" name="L76" href="#L76">76</a> <strong class="jxr_keyword">protected</strong> String url = <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="L77" href="#L77">77</a>
<a class="jxr_linenumber" name="L78" href="#L78">78</a> <strong class="jxr_keyword">protected</strong> String referral = <span class="jxr_string">"follow"</span>;
<a class="jxr_linenumber" name="L79" href="#L79">79</a>
<a class="jxr_linenumber" name="L80" href="#L80">80</a> <strong class="jxr_keyword">protected</strong> String systemUsername = <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="L81" href="#L81">81</a>
<a class="jxr_linenumber" name="L82" href="#L82">82</a> <strong class="jxr_keyword">protected</strong> String systemPassword = <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="L83" href="#L83">83</a>
<a class="jxr_linenumber" name="L84" href="#L84">84</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> usePooling = <strong class="jxr_keyword">true</strong>;
<a class="jxr_linenumber" name="L85" href="#L85">85</a>
<a class="jxr_linenumber" name="L86" href="#L86">86</a> <strong class="jxr_keyword">private</strong> Map&lt;String, String&gt; additionalEnvironment;
<a class="jxr_linenumber" name="L87" href="#L87">87</a>
<a class="jxr_linenumber" name="L88" href="#L88">88</a> <em class="jxr_comment">/*--------------------------------------------</em>
<a class="jxr_linenumber" name="L89" href="#L89">89</a> <em class="jxr_comment"> | C O N S T R U C T O R S |</em>
<a class="jxr_linenumber" name="L90" href="#L90">90</a> <em class="jxr_comment"> ============================================*/</em>
<a class="jxr_linenumber" name="L91" href="#L91">91</a>
<a class="jxr_linenumber" name="L92" href="#L92">92</a> <em class="jxr_comment">/*--------------------------------------------</em>
<a class="jxr_linenumber" name="L93" href="#L93">93</a> <em class="jxr_comment"> | A C C E S S O R S / M O D I F I E R S |</em>
<a class="jxr_linenumber" name="L94" href="#L94">94</a> <em class="jxr_comment"> ============================================*/</em>
<a class="jxr_linenumber" name="L95" href="#L95">95</a>
<a class="jxr_linenumber" name="L96" href="#L96">96</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L97" href="#L97">97</a> <em class="jxr_javadoccomment"> * Sets the type of LDAP authentication to perform when connecting to the LDAP server. Defaults to "simple"</em>
<a class="jxr_linenumber" name="L98" href="#L98">98</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L99" href="#L99">99</a> <em class="jxr_javadoccomment"> * @param authentication the type of LDAP authentication to perform.</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">public</strong> <strong class="jxr_keyword">void</strong> setAuthentication(String authentication) {
<a class="jxr_linenumber" name="L102" href="#L102">102</a> <strong class="jxr_keyword">this</strong>.authentication = authentication;
<a class="jxr_linenumber" name="L103" href="#L103">103</a> }
<a class="jxr_linenumber" name="L104" href="#L104">104</a>
<a class="jxr_linenumber" name="L105" href="#L105">105</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L106" href="#L106">106</a> <em class="jxr_javadoccomment"> * A suffix appended to the username. This is typically for</em>
<a class="jxr_linenumber" name="L107" href="#L107">107</a> <em class="jxr_javadoccomment"> * domain names. (e.g. "@MyDomain.local")</em>
<a class="jxr_linenumber" name="L108" href="#L108">108</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L109" href="#L109">109</a> <em class="jxr_javadoccomment"> * @param principalSuffix the suffix.</em>
<a class="jxr_linenumber" name="L110" href="#L110">110</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L111" href="#L111">111</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setPrincipalSuffix(String principalSuffix) {
<a class="jxr_linenumber" name="L112" href="#L112">112</a> <strong class="jxr_keyword">this</strong>.principalSuffix = principalSuffix;
<a class="jxr_linenumber" name="L113" href="#L113">113</a> }
<a class="jxr_linenumber" name="L114" href="#L114">114</a>
<a class="jxr_linenumber" name="L115" href="#L115">115</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L116" href="#L116">116</a> <em class="jxr_javadoccomment"> * The search base for the search to perform in the LDAP server.</em>
<a class="jxr_linenumber" name="L117" href="#L117">117</a> <em class="jxr_javadoccomment"> * (e.g. OU=OrganizationName,DC=MyDomain,DC=local )</em>
<a class="jxr_linenumber" name="L118" href="#L118">118</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L119" href="#L119">119</a> <em class="jxr_javadoccomment"> * @param searchBase the search base.</em>
<a class="jxr_linenumber" name="L120" href="#L120">120</a> <em class="jxr_javadoccomment"> * @deprecated this attribute existed, but was never used in Shiro 1.x. It will be removed prior to Shiro 2.0.</em>
<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> @Deprecated
<a class="jxr_linenumber" name="L123" href="#L123">123</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setSearchBase(String searchBase) {
<a class="jxr_linenumber" name="L124" href="#L124">124</a> <strong class="jxr_keyword">this</strong>.searchBase = searchBase;
<a class="jxr_linenumber" name="L125" href="#L125">125</a> }
<a class="jxr_linenumber" name="L126" href="#L126">126</a>
<a class="jxr_linenumber" name="L127" href="#L127">127</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L128" href="#L128">128</a> <em class="jxr_javadoccomment"> * The context factory to use. This defaults to the SUN LDAP JNDI implementation</em>
<a class="jxr_linenumber" name="L129" href="#L129">129</a> <em class="jxr_javadoccomment"> * but can be overridden to use custom LDAP factories.</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 contextFactoryClassName the context factory that should be used.</em>
<a class="jxr_linenumber" name="L132" href="#L132">132</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L133" href="#L133">133</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setContextFactoryClassName(String contextFactoryClassName) {
<a class="jxr_linenumber" name="L134" href="#L134">134</a> <strong class="jxr_keyword">this</strong>.contextFactoryClassName = contextFactoryClassName;
<a class="jxr_linenumber" name="L135" href="#L135">135</a> }
<a class="jxr_linenumber" name="L136" href="#L136">136</a>
<a class="jxr_linenumber" name="L137" href="#L137">137</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L138" href="#L138">138</a> <em class="jxr_javadoccomment"> * The LDAP url to connect to. (e.g. ldap://&lt;ldapDirectoryHostname&gt;:&lt;port&gt;)</em>
<a class="jxr_linenumber" name="L139" href="#L139">139</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L140" href="#L140">140</a> <em class="jxr_javadoccomment"> * @param url the LDAP url.</em>
<a class="jxr_linenumber" name="L141" href="#L141">141</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L142" href="#L142">142</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setUrl(String url) {
<a class="jxr_linenumber" name="L143" href="#L143">143</a> <strong class="jxr_keyword">this</strong>.url = url;
<a class="jxr_linenumber" name="L144" href="#L144">144</a> }
<a class="jxr_linenumber" name="L145" href="#L145">145</a>
<a class="jxr_linenumber" name="L146" href="#L146">146</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L147" href="#L147">147</a> <em class="jxr_javadoccomment"> * Sets the LDAP referral property. Defaults to "follow"</em>
<a class="jxr_linenumber" name="L148" href="#L148">148</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L149" href="#L149">149</a> <em class="jxr_javadoccomment"> * @param referral the referral property.</em>
<a class="jxr_linenumber" name="L150" href="#L150">150</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L151" href="#L151">151</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setReferral(String referral) {
<a class="jxr_linenumber" name="L152" href="#L152">152</a> <strong class="jxr_keyword">this</strong>.referral = referral;
<a class="jxr_linenumber" name="L153" href="#L153">153</a> }
<a class="jxr_linenumber" name="L154" href="#L154">154</a>
<a class="jxr_linenumber" name="L155" href="#L155">155</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L156" href="#L156">156</a> <em class="jxr_javadoccomment"> * The system username that will be used when connecting to the LDAP server to retrieve authorization</em>
<a class="jxr_linenumber" name="L157" href="#L157">157</a> <em class="jxr_javadoccomment"> * information about a user. This must be specified for LDAP authorization to work, but is not required for</em>
<a class="jxr_linenumber" name="L158" href="#L158">158</a> <em class="jxr_javadoccomment"> * only authentication.</em>
<a class="jxr_linenumber" name="L159" href="#L159">159</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L160" href="#L160">160</a> <em class="jxr_javadoccomment"> * @param systemUsername the username to use when logging into the LDAP server for authorization.</em>
<a class="jxr_linenumber" name="L161" href="#L161">161</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L162" href="#L162">162</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setSystemUsername(String systemUsername) {
<a class="jxr_linenumber" name="L163" href="#L163">163</a> <strong class="jxr_keyword">this</strong>.systemUsername = systemUsername;
<a class="jxr_linenumber" name="L164" href="#L164">164</a> }
<a class="jxr_linenumber" name="L165" href="#L165">165</a>
<a class="jxr_linenumber" name="L166" href="#L166">166</a>
<a class="jxr_linenumber" name="L167" href="#L167">167</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L168" href="#L168">168</a> <em class="jxr_javadoccomment"> * The system password that will be used when connecting to the LDAP server to retrieve authorization</em>
<a class="jxr_linenumber" name="L169" href="#L169">169</a> <em class="jxr_javadoccomment"> * information about a user. This must be specified for LDAP authorization to work, but is not required for</em>
<a class="jxr_linenumber" name="L170" href="#L170">170</a> <em class="jxr_javadoccomment"> * only authentication.</em>
<a class="jxr_linenumber" name="L171" href="#L171">171</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L172" href="#L172">172</a> <em class="jxr_javadoccomment"> * @param systemPassword the password to use when logging into the LDAP server for authorization.</em>
<a class="jxr_linenumber" name="L173" href="#L173">173</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L174" href="#L174">174</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setSystemPassword(String systemPassword) {
<a class="jxr_linenumber" name="L175" href="#L175">175</a> <strong class="jxr_keyword">this</strong>.systemPassword = systemPassword;
<a class="jxr_linenumber" name="L176" href="#L176">176</a> }
<a class="jxr_linenumber" name="L177" href="#L177">177</a>
<a class="jxr_linenumber" name="L178" href="#L178">178</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L179" href="#L179">179</a> <em class="jxr_javadoccomment"> * Determines whether or not LdapContext pooling is enabled for connections made using the system</em>
<a class="jxr_linenumber" name="L180" href="#L180">180</a> <em class="jxr_javadoccomment"> * user account. In the default implementation, this simply</em>
<a class="jxr_linenumber" name="L181" href="#L181">181</a> <em class="jxr_javadoccomment"> * sets the &lt;tt&gt;com.sun.jndi.ldap.connect.pool&lt;/tt&gt; property in the LDAP context environment. If you use an</em>
<a class="jxr_linenumber" name="L182" href="#L182">182</a> <em class="jxr_javadoccomment"> * LDAP Context Factory that is not Sun's default implementation, you will need to override the</em>
<a class="jxr_linenumber" name="L183" href="#L183">183</a> <em class="jxr_javadoccomment"> * default behavior to use this setting in whatever way your underlying LDAP ContextFactory</em>
<a class="jxr_linenumber" name="L184" href="#L184">184</a> <em class="jxr_javadoccomment"> * supports. By default, pooling is enabled.</em>
<a class="jxr_linenumber" name="L185" href="#L185">185</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L186" href="#L186">186</a> <em class="jxr_javadoccomment"> * @param usePooling true to enable pooling, or false to disable it.</em>
<a class="jxr_linenumber" name="L187" href="#L187">187</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L188" href="#L188">188</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setUsePooling(<strong class="jxr_keyword">boolean</strong> usePooling) {
<a class="jxr_linenumber" name="L189" href="#L189">189</a> <strong class="jxr_keyword">this</strong>.usePooling = usePooling;
<a class="jxr_linenumber" name="L190" href="#L190">190</a> }
<a class="jxr_linenumber" name="L191" href="#L191">191</a>
<a class="jxr_linenumber" name="L192" href="#L192">192</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L193" href="#L193">193</a> <em class="jxr_javadoccomment"> * These entries are added to the environment map before initializing the LDAP context.</em>
<a class="jxr_linenumber" name="L194" href="#L194">194</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L195" href="#L195">195</a> <em class="jxr_javadoccomment"> * @param additionalEnvironment additional environment entries to be configured on the LDAP context.</em>
<a class="jxr_linenumber" name="L196" href="#L196">196</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L197" href="#L197">197</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setAdditionalEnvironment(Map&lt;String, String&gt; additionalEnvironment) {
<a class="jxr_linenumber" name="L198" href="#L198">198</a> <strong class="jxr_keyword">this</strong>.additionalEnvironment = additionalEnvironment;
<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> <em class="jxr_comment">/*--------------------------------------------</em>
<a class="jxr_linenumber" name="L202" href="#L202">202</a> <em class="jxr_comment"> | M E T H O D S |</em>
<a class="jxr_linenumber" name="L203" href="#L203">203</a> <em class="jxr_comment"> ============================================*/</em>
<a class="jxr_linenumber" name="L204" href="#L204">204</a> <strong class="jxr_keyword">public</strong> LdapContext getSystemLdapContext() <strong class="jxr_keyword">throws</strong> NamingException {
<a class="jxr_linenumber" name="L205" href="#L205">205</a> <strong class="jxr_keyword">return</strong> getLdapContext(systemUsername, systemPassword);
<a class="jxr_linenumber" name="L206" href="#L206">206</a> }
<a class="jxr_linenumber" name="L207" href="#L207">207</a>
<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"> * Deprecated - use {@link #getLdapContext(Object, Object)} instead. This will be removed before Apache Shiro 2.0.</em>
<a class="jxr_linenumber" name="L210" href="#L210">210</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L211" href="#L211">211</a> <em class="jxr_javadoccomment"> * @param username the username to use when creating the connection.</em>
<a class="jxr_linenumber" name="L212" href="#L212">212</a> <em class="jxr_javadoccomment"> * @param password the password to use when creating the connection.</em>
<a class="jxr_linenumber" name="L213" href="#L213">213</a> <em class="jxr_javadoccomment"> * @return a {@code LdapContext} bound using the given username and password.</em>
<a class="jxr_linenumber" name="L214" href="#L214">214</a> <em class="jxr_javadoccomment"> * @throws javax.naming.NamingException if there is an error creating the context.</em>
<a class="jxr_linenumber" name="L215" href="#L215">215</a> <em class="jxr_javadoccomment"> * @deprecated the {@link #getLdapContext(Object, Object)} method should be used in all cases to ensure more than</em>
<a class="jxr_linenumber" name="L216" href="#L216">216</a> <em class="jxr_javadoccomment"> * String principals and credentials can be used. Shiro no longer calls this method - it will be</em>
<a class="jxr_linenumber" name="L217" href="#L217">217</a> <em class="jxr_javadoccomment"> * removed before the 2.0 release.</em>
<a class="jxr_linenumber" name="L218" href="#L218">218</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L219" href="#L219">219</a> @Deprecated
<a class="jxr_linenumber" name="L220" href="#L220">220</a> <strong class="jxr_keyword">public</strong> LdapContext getLdapContext(String username, String password) <strong class="jxr_keyword">throws</strong> NamingException {
<a class="jxr_linenumber" name="L221" href="#L221">221</a> <strong class="jxr_keyword">if</strong> (username != <strong class="jxr_keyword">null</strong> &amp;&amp; principalSuffix != <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L222" href="#L222">222</a> username += principalSuffix;
<a class="jxr_linenumber" name="L223" href="#L223">223</a> }
<a class="jxr_linenumber" name="L224" href="#L224">224</a> <strong class="jxr_keyword">return</strong> getLdapContext((Object) username, password);
<a class="jxr_linenumber" name="L225" href="#L225">225</a> }
<a class="jxr_linenumber" name="L226" href="#L226">226</a>
<a class="jxr_linenumber" name="L227" href="#L227">227</a> <strong class="jxr_keyword">public</strong> LdapContext getLdapContext(Object principal, Object credentials) <strong class="jxr_keyword">throws</strong> NamingException {
<a class="jxr_linenumber" name="L228" href="#L228">228</a> <strong class="jxr_keyword">if</strong> (url == <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L229" href="#L229">229</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IllegalStateException(<span class="jxr_string">"An LDAP URL must be specified of the form ldap://&lt;hostname&gt;:&lt;port&gt;"</span>);
<a class="jxr_linenumber" name="L230" href="#L230">230</a> }
<a class="jxr_linenumber" name="L231" href="#L231">231</a>
<a class="jxr_linenumber" name="L232" href="#L232">232</a> Hashtable&lt;String, Object&gt; env = <strong class="jxr_keyword">new</strong> Hashtable&lt;String, Object&gt;();
<a class="jxr_linenumber" name="L233" href="#L233">233</a>
<a class="jxr_linenumber" name="L234" href="#L234">234</a> env.put(Context.SECURITY_AUTHENTICATION, authentication);
<a class="jxr_linenumber" name="L235" href="#L235">235</a> <strong class="jxr_keyword">if</strong> (principal != <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L236" href="#L236">236</a> env.put(Context.SECURITY_PRINCIPAL, principal);
<a class="jxr_linenumber" name="L237" href="#L237">237</a> }
<a class="jxr_linenumber" name="L238" href="#L238">238</a> <strong class="jxr_keyword">if</strong> (credentials!= <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L239" href="#L239">239</a> env.put(Context.SECURITY_CREDENTIALS, credentials);
<a class="jxr_linenumber" name="L240" href="#L240">240</a> }
<a class="jxr_linenumber" name="L241" href="#L241">241</a> env.put(Context.INITIAL_CONTEXT_FACTORY, contextFactoryClassName);
<a class="jxr_linenumber" name="L242" href="#L242">242</a> env.put(Context.PROVIDER_URL, url);
<a class="jxr_linenumber" name="L243" href="#L243">243</a> env.put(Context.REFERRAL, referral);
<a class="jxr_linenumber" name="L244" href="#L244">244</a>
<a class="jxr_linenumber" name="L245" href="#L245">245</a> <em class="jxr_comment">// Only pool connections for system contexts</em>
<a class="jxr_linenumber" name="L246" href="#L246">246</a> <strong class="jxr_keyword">if</strong> (usePooling &amp;&amp; principal != <strong class="jxr_keyword">null</strong> &amp;&amp; principal.equals(systemUsername)) {
<a class="jxr_linenumber" name="L247" href="#L247">247</a> <em class="jxr_comment">// Enable connection pooling</em>
<a class="jxr_linenumber" name="L248" href="#L248">248</a> env.put(SUN_CONNECTION_POOLING_PROPERTY, <span class="jxr_string">"true"</span>);
<a class="jxr_linenumber" name="L249" href="#L249">249</a> }
<a class="jxr_linenumber" name="L250" href="#L250">250</a>
<a class="jxr_linenumber" name="L251" href="#L251">251</a> <strong class="jxr_keyword">if</strong> (additionalEnvironment != <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L252" href="#L252">252</a> env.putAll(additionalEnvironment);
<a class="jxr_linenumber" name="L253" href="#L253">253</a> }
<a class="jxr_linenumber" name="L254" href="#L254">254</a>
<a class="jxr_linenumber" name="L255" href="#L255">255</a> <strong class="jxr_keyword">if</strong> (log.isDebugEnabled()) {
<a class="jxr_linenumber" name="L256" href="#L256">256</a> log.debug(<span class="jxr_string">"Initializing LDAP context using URL ["</span> + url + <span class="jxr_string">"] and username ["</span> + systemUsername + <span class="jxr_string">"] "</span> +
<a class="jxr_linenumber" name="L257" href="#L257">257</a> <span class="jxr_string">"with pooling ["</span> + (usePooling ? <span class="jxr_string">"enabled"</span> : <span class="jxr_string">"disabled"</span>) + <span class="jxr_string">"]"</span>);
<a class="jxr_linenumber" name="L258" href="#L258">258</a> }
<a class="jxr_linenumber" name="L259" href="#L259">259</a>
<a class="jxr_linenumber" name="L260" href="#L260">260</a> <em class="jxr_comment">// validate the config before creating the context</em>
<a class="jxr_linenumber" name="L261" href="#L261">261</a> validateAuthenticationInfo(env);
<a class="jxr_linenumber" name="L262" href="#L262">262</a>
<a class="jxr_linenumber" name="L263" href="#L263">263</a> <strong class="jxr_keyword">return</strong> createLdapContext(env);
<a class="jxr_linenumber" name="L264" href="#L264">264</a> }
<a class="jxr_linenumber" name="L265" href="#L265">265</a>
<a class="jxr_linenumber" name="L266" href="#L266">266</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L267" href="#L267">267</a> <em class="jxr_javadoccomment"> * Creates and returns a new {@link javax.naming.ldap.InitialLdapContext} instance. This method exists primarily</em>
<a class="jxr_linenumber" name="L268" href="#L268">268</a> <em class="jxr_javadoccomment"> * to support testing where a mock LdapContext can be returned instead of actually creating a connection, but</em>
<a class="jxr_linenumber" name="L269" href="#L269">269</a> <em class="jxr_javadoccomment"> * subclasses are free to provide a different implementation if necessary.</em>
<a class="jxr_linenumber" name="L270" href="#L270">270</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L271" href="#L271">271</a> <em class="jxr_javadoccomment"> * @param env the JNDI environment settings used to create the LDAP connection</em>
<a class="jxr_linenumber" name="L272" href="#L272">272</a> <em class="jxr_javadoccomment"> * @return an LdapConnection</em>
<a class="jxr_linenumber" name="L273" href="#L273">273</a> <em class="jxr_javadoccomment"> * @throws NamingException if a problem occurs creating the connection</em>
<a class="jxr_linenumber" name="L274" href="#L274">274</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L275" href="#L275">275</a> <strong class="jxr_keyword">protected</strong> LdapContext createLdapContext(Hashtable env) <strong class="jxr_keyword">throws</strong> NamingException {
<a class="jxr_linenumber" name="L276" href="#L276">276</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> InitialLdapContext(env, <strong class="jxr_keyword">null</strong>);
<a class="jxr_linenumber" name="L277" href="#L277">277</a> }
<a class="jxr_linenumber" name="L278" href="#L278">278</a>
<a class="jxr_linenumber" name="L279" href="#L279">279</a>
<a class="jxr_linenumber" name="L280" href="#L280">280</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L281" href="#L281">281</a> <em class="jxr_javadoccomment"> * Validates the configuration in the JNDI &lt;code&gt;environment&lt;/code&gt; settings and throws an exception if a problem</em>
<a class="jxr_linenumber" name="L282" href="#L282">282</a> <em class="jxr_javadoccomment"> * exists.</em>
<a class="jxr_linenumber" name="L283" href="#L283">283</a> <em class="jxr_javadoccomment"> * &lt;p/&gt;</em>
<a class="jxr_linenumber" name="L284" href="#L284">284</a> <em class="jxr_javadoccomment"> * This implementation will throw a {@link AuthenticationException} if the authentication mechanism is set to</em>
<a class="jxr_linenumber" name="L285" href="#L285">285</a> <em class="jxr_javadoccomment"> * 'simple', the principal is non-empty, and the credentials are empty (as per</em>
<a class="jxr_linenumber" name="L286" href="#L286">286</a> <em class="jxr_javadoccomment"> * &lt;a href="<a href="http://tools.ietf.org/html/rfc4513" target="alexandria_uri">http://tools.ietf.org/html/rfc4513</a>#section-5.1.2"&gt;rfc4513 section-5.1.2&lt;/a&gt;).</em>
<a class="jxr_linenumber" name="L287" href="#L287">287</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L288" href="#L288">288</a> <em class="jxr_javadoccomment"> * @param environment the JNDI environment settings to be validated</em>
<a class="jxr_linenumber" name="L289" href="#L289">289</a> <em class="jxr_javadoccomment"> * @throws AuthenticationException if a configuration problem is detected</em>
<a class="jxr_linenumber" name="L290" href="#L290">290</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L291" href="#L291">291</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> validateAuthenticationInfo(Hashtable&lt;String, Object&gt; environment)
<a class="jxr_linenumber" name="L292" href="#L292">292</a> <strong class="jxr_keyword">throws</strong> AuthenticationException
<a class="jxr_linenumber" name="L293" href="#L293">293</a> {
<a class="jxr_linenumber" name="L294" href="#L294">294</a> <em class="jxr_comment">// validate when using Simple auth both principal and credentials are set</em>
<a class="jxr_linenumber" name="L295" href="#L295">295</a> <strong class="jxr_keyword">if</strong>(SIMPLE_AUTHENTICATION_MECHANISM_NAME.equals(environment.get(Context.SECURITY_AUTHENTICATION))) {
<a class="jxr_linenumber" name="L296" href="#L296">296</a>
<a class="jxr_linenumber" name="L297" href="#L297">297</a> <em class="jxr_comment">// only validate credentials if we have a non-empty principal</em>
<a class="jxr_linenumber" name="L298" href="#L298">298</a> <strong class="jxr_keyword">if</strong>( environment.get(Context.SECURITY_PRINCIPAL) != <strong class="jxr_keyword">null</strong> &amp;&amp;
<a class="jxr_linenumber" name="L299" href="#L299">299</a> StringUtils.hasText( String.valueOf( environment.get(Context.SECURITY_PRINCIPAL) ))) {
<a class="jxr_linenumber" name="L300" href="#L300">300</a>
<a class="jxr_linenumber" name="L301" href="#L301">301</a> Object credentials = environment.get(Context.SECURITY_CREDENTIALS);
<a class="jxr_linenumber" name="L302" href="#L302">302</a>
<a class="jxr_linenumber" name="L303" href="#L303">303</a> <em class="jxr_comment">// from the FAQ, we need to check for empty credentials:</em>
<a class="jxr_linenumber" name="L304" href="#L304">304</a> <em class="jxr_comment">// http://docs.oracle.com/javase/tutorial/jndi/ldap/faq.html</em>
<a class="jxr_linenumber" name="L305" href="#L305">305</a> <strong class="jxr_keyword">if</strong>( credentials == <strong class="jxr_keyword">null</strong> ||
<a class="jxr_linenumber" name="L306" href="#L306">306</a> (credentials instanceof byte[] &amp;&amp; ((byte[])credentials).length &lt;= 0) || <em class="jxr_comment">// empty byte[]</em>
<a class="jxr_linenumber" name="L307" href="#L307">307</a> (credentials instanceof <strong class="jxr_keyword">char</strong>[] &amp;&amp; ((<strong class="jxr_keyword">char</strong>[])credentials).length &lt;= 0) || <em class="jxr_comment">// empty char[]</em>
<a class="jxr_linenumber" name="L308" href="#L308">308</a> (String.<strong class="jxr_keyword">class</strong>.isInstance(credentials) &amp;&amp; !StringUtils.hasText(String.valueOf(credentials)))) {
<a class="jxr_linenumber" name="L309" href="#L309">309</a>
<a class="jxr_linenumber" name="L310" href="#L310">310</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> javax.naming.AuthenticationException(<span class="jxr_string">"LDAP Simple authentication requires both a "</span>
<a class="jxr_linenumber" name="L311" href="#L311">311</a> + <span class="jxr_string">"principal and credentials."</span>);
<a class="jxr_linenumber" name="L312" href="#L312">312</a> }
<a class="jxr_linenumber" name="L313" href="#L313">313</a> }
<a class="jxr_linenumber" name="L314" href="#L314">314</a> }
<a class="jxr_linenumber" name="L315" href="#L315">315</a> }
<a class="jxr_linenumber" name="L316" href="#L316">316</a>
<a class="jxr_linenumber" name="L317" href="#L317">317</a> }
</pre>
<hr/>
<div id="footer">Copyright &#169; 2004&#x2013;2021 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</div>
</body>
</html>