| <!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=ISO-8859-1" /> |
| <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 name="1" href="#1">1</a> <em class="jxr_comment">/*</em> |
| <a name="2" href="#2">2</a> <em class="jxr_comment"> * Licensed to the Apache Software Foundation (ASF) under one</em> |
| <a name="3" href="#3">3</a> <em class="jxr_comment"> * or more contributor license agreements. See the NOTICE file</em> |
| <a name="4" href="#4">4</a> <em class="jxr_comment"> * distributed with this work for additional information</em> |
| <a name="5" href="#5">5</a> <em class="jxr_comment"> * regarding copyright ownership. The ASF licenses this file</em> |
| <a name="6" href="#6">6</a> <em class="jxr_comment"> * to you under the Apache License, Version 2.0 (the</em> |
| <a name="7" href="#7">7</a> <em class="jxr_comment"> * "License"); you may not use this file except in compliance</em> |
| <a name="8" href="#8">8</a> <em class="jxr_comment"> * with the License. You may obtain a copy of the License at</em> |
| <a name="9" href="#9">9</a> <em class="jxr_comment"> *</em> |
| <a name="10" href="#10">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 name="11" href="#11">11</a> <em class="jxr_comment"> *</em> |
| <a name="12" href="#12">12</a> <em class="jxr_comment"> * Unless required by applicable law or agreed to in writing,</em> |
| <a name="13" href="#13">13</a> <em class="jxr_comment"> * software distributed under the License is distributed on an</em> |
| <a name="14" href="#14">14</a> <em class="jxr_comment"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</em> |
| <a name="15" href="#15">15</a> <em class="jxr_comment"> * KIND, either express or implied. See the License for the</em> |
| <a name="16" href="#16">16</a> <em class="jxr_comment"> * specific language governing permissions and limitations</em> |
| <a name="17" href="#17">17</a> <em class="jxr_comment"> * under the License.</em> |
| <a name="18" href="#18">18</a> <em class="jxr_comment"> */</em> |
| <a name="19" href="#19">19</a> <strong class="jxr_keyword">package</strong> org.apache.shiro.realm.ldap; |
| <a name="20" href="#20">20</a> |
| <a name="21" href="#21">21</a> <strong class="jxr_keyword">import</strong> java.util.Hashtable; |
| <a name="22" href="#22">22</a> <strong class="jxr_keyword">import</strong> java.util.Map; |
| <a name="23" href="#23">23</a> <strong class="jxr_keyword">import</strong> javax.naming.AuthenticationException; |
| <a name="24" href="#24">24</a> <strong class="jxr_keyword">import</strong> javax.naming.Context; |
| <a name="25" href="#25">25</a> <strong class="jxr_keyword">import</strong> javax.naming.NamingException; |
| <a name="26" href="#26">26</a> <strong class="jxr_keyword">import</strong> javax.naming.ldap.InitialLdapContext; |
| <a name="27" href="#27">27</a> <strong class="jxr_keyword">import</strong> javax.naming.ldap.LdapContext; |
| <a name="28" href="#28">28</a> |
| <a name="29" href="#29">29</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.util.StringUtils; |
| <a name="30" href="#30">30</a> <strong class="jxr_keyword">import</strong> org.slf4j.Logger; |
| <a name="31" href="#31">31</a> <strong class="jxr_keyword">import</strong> org.slf4j.LoggerFactory; |
| <a name="32" href="#32">32</a> |
| <a name="33" href="#33">33</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="34" href="#34">34</a> <em class="jxr_javadoccomment"> * <p>Default implementation of {@link LdapContextFactory} that can be configured or extended to</em> |
| <a name="35" href="#35">35</a> <em class="jxr_javadoccomment"> * customize the way {@link javax.naming.ldap.LdapContext} objects are retrieved.</p></em> |
| <a name="36" href="#36">36</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="37" href="#37">37</a> <em class="jxr_javadoccomment"> * <p>This implementation of {@link LdapContextFactory} is used by the {@link AbstractLdapRealm} if a</em> |
| <a name="38" href="#38">38</a> <em class="jxr_javadoccomment"> * factory is not explictly configured.</p></em> |
| <a name="39" href="#39">39</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="40" href="#40">40</a> <em class="jxr_javadoccomment"> * <p>Connection pooling is enabled by default on this factory, but can be disabled using the</em> |
| <a name="41" href="#41">41</a> <em class="jxr_javadoccomment"> * {@link #usePooling} property.</p></em> |
| <a name="42" href="#42">42</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="43" href="#43">43</a> <em class="jxr_javadoccomment"> * @since 0.2</em> |
| <a name="44" href="#44">44</a> <em class="jxr_javadoccomment"> * @deprecated replaced by the {@link JndiLdapContextFactory} implementation. This implementation will be removed</em> |
| <a name="45" href="#45">45</a> <em class="jxr_javadoccomment"> * prior to Shiro 2.0</em> |
| <a name="46" href="#46">46</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="47" href="#47">47</a> @Deprecated |
| <a name="48" href="#48">48</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../org/apache/shiro/realm/ldap/DefaultLdapContextFactory.html">DefaultLdapContextFactory</a> implements <a href="../../../../../org/apache/shiro/realm/ldap/LdapContextFactory.html">LdapContextFactory</a> { |
| <a name="49" href="#49">49</a> |
| <a name="50" href="#50">50</a> <em class="jxr_comment">//TODO - complete JavaDoc</em> |
| <a name="51" href="#51">51</a> |
| <a name="52" href="#52">52</a> <em class="jxr_comment">/*<em class="jxr_comment">--------------------------------------------</em></em> |
| <a name="53" href="#53">53</a> <em class="jxr_comment"> | C O N S T A N T S |</em> |
| <a name="54" href="#54">54</a> <em class="jxr_comment"> ============================================*/</em> |
| <a name="55" href="#55">55</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="56" href="#56">56</a> <em class="jxr_javadoccomment"> * The Sun LDAP property used to enable connection pooling. This is used in the default implementation</em> |
| <a name="57" href="#57">57</a> <em class="jxr_javadoccomment"> * to enable LDAP connection pooling.</em> |
| <a name="58" href="#58">58</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="59" href="#59">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 name="60" href="#60">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 name="61" href="#61">61</a> |
| <a name="62" href="#62">62</a> <em class="jxr_comment">/*<em class="jxr_comment">--------------------------------------------</em></em> |
| <a name="63" href="#63">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 name="64" href="#64">64</a> <em class="jxr_comment"> ============================================*/</em> |
| <a name="65" href="#65">65</a> |
| <a name="66" href="#66">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 name="67" href="#67">67</a> |
| <a name="68" href="#68">68</a> <strong class="jxr_keyword">protected</strong> String authentication = SIMPLE_AUTHENTICATION_MECHANISM_NAME; |
| <a name="69" href="#69">69</a> |
| <a name="70" href="#70">70</a> <strong class="jxr_keyword">protected</strong> String principalSuffix = <strong class="jxr_keyword">null</strong>; |
| <a name="71" href="#71">71</a> |
| <a name="72" href="#72">72</a> <strong class="jxr_keyword">protected</strong> String searchBase = <strong class="jxr_keyword">null</strong>; |
| <a name="73" href="#73">73</a> |
| <a name="74" href="#74">74</a> <strong class="jxr_keyword">protected</strong> String contextFactoryClassName = <span class="jxr_string">"com.sun.jndi.ldap.LdapCtxFactory"</span>; |
| <a name="75" href="#75">75</a> |
| <a name="76" href="#76">76</a> <strong class="jxr_keyword">protected</strong> String url = <strong class="jxr_keyword">null</strong>; |
| <a name="77" href="#77">77</a> |
| <a name="78" href="#78">78</a> <strong class="jxr_keyword">protected</strong> String referral = <span class="jxr_string">"follow"</span>; |
| <a name="79" href="#79">79</a> |
| <a name="80" href="#80">80</a> <strong class="jxr_keyword">protected</strong> String systemUsername = <strong class="jxr_keyword">null</strong>; |
| <a name="81" href="#81">81</a> |
| <a name="82" href="#82">82</a> <strong class="jxr_keyword">protected</strong> String systemPassword = <strong class="jxr_keyword">null</strong>; |
| <a name="83" href="#83">83</a> |
| <a name="84" href="#84">84</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> usePooling = <strong class="jxr_keyword">true</strong>; |
| <a name="85" href="#85">85</a> |
| <a name="86" href="#86">86</a> <strong class="jxr_keyword">private</strong> Map<String, String> additionalEnvironment; |
| <a name="87" href="#87">87</a> |
| <a name="88" href="#88">88</a> <em class="jxr_comment">/*<em class="jxr_comment">--------------------------------------------</em></em> |
| <a name="89" href="#89">89</a> <em class="jxr_comment"> | C O N S T R U C T O R S |</em> |
| <a name="90" href="#90">90</a> <em class="jxr_comment"> ============================================*/</em> |
| <a name="91" href="#91">91</a> |
| <a name="92" href="#92">92</a> <em class="jxr_comment">/*<em class="jxr_comment">--------------------------------------------</em></em> |
| <a name="93" href="#93">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 name="94" href="#94">94</a> <em class="jxr_comment"> ============================================*/</em> |
| <a name="95" href="#95">95</a> |
| <a name="96" href="#96">96</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="97" href="#97">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 name="98" href="#98">98</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="99" href="#99">99</a> <em class="jxr_javadoccomment"> * @param authentication the type of LDAP authentication to perform.</em> |
| <a name="100" href="#100">100</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="101" href="#101">101</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setAuthentication(String authentication) { |
| <a name="102" href="#102">102</a> <strong class="jxr_keyword">this</strong>.authentication = authentication; |
| <a name="103" href="#103">103</a> } |
| <a name="104" href="#104">104</a> |
| <a name="105" href="#105">105</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="106" href="#106">106</a> <em class="jxr_javadoccomment"> * A suffix appended to the username. This is typically for</em> |
| <a name="107" href="#107">107</a> <em class="jxr_javadoccomment"> * domain names. (e.g. "@MyDomain.local")</em> |
| <a name="108" href="#108">108</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="109" href="#109">109</a> <em class="jxr_javadoccomment"> * @param principalSuffix the suffix.</em> |
| <a name="110" href="#110">110</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="111" href="#111">111</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setPrincipalSuffix(String principalSuffix) { |
| <a name="112" href="#112">112</a> <strong class="jxr_keyword">this</strong>.principalSuffix = principalSuffix; |
| <a name="113" href="#113">113</a> } |
| <a name="114" href="#114">114</a> |
| <a name="115" href="#115">115</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="116" href="#116">116</a> <em class="jxr_javadoccomment"> * The search base for the search to perform in the LDAP server.</em> |
| <a name="117" href="#117">117</a> <em class="jxr_javadoccomment"> * (e.g. OU=OrganizationName,DC=MyDomain,DC=local )</em> |
| <a name="118" href="#118">118</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="119" href="#119">119</a> <em class="jxr_javadoccomment"> * @param searchBase the search base.</em> |
| <a name="120" href="#120">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 name="121" href="#121">121</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="122" href="#122">122</a> @Deprecated |
| <a name="123" href="#123">123</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setSearchBase(String searchBase) { |
| <a name="124" href="#124">124</a> <strong class="jxr_keyword">this</strong>.searchBase = searchBase; |
| <a name="125" href="#125">125</a> } |
| <a name="126" href="#126">126</a> |
| <a name="127" href="#127">127</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="128" href="#128">128</a> <em class="jxr_javadoccomment"> * The context factory to use. This defaults to the SUN LDAP JNDI implementation</em> |
| <a name="129" href="#129">129</a> <em class="jxr_javadoccomment"> * but can be overridden to use custom LDAP factories.</em> |
| <a name="130" href="#130">130</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="131" href="#131">131</a> <em class="jxr_javadoccomment"> * @param contextFactoryClassName the context factory that should be used.</em> |
| <a name="132" href="#132">132</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="133" href="#133">133</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setContextFactoryClassName(String contextFactoryClassName) { |
| <a name="134" href="#134">134</a> <strong class="jxr_keyword">this</strong>.contextFactoryClassName = contextFactoryClassName; |
| <a name="135" href="#135">135</a> } |
| <a name="136" href="#136">136</a> |
| <a name="137" href="#137">137</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="138" href="#138">138</a> <em class="jxr_javadoccomment"> * The LDAP url to connect to. (e.g. ldap://<ldapDirectoryHostname>:<port>)</em> |
| <a name="139" href="#139">139</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="140" href="#140">140</a> <em class="jxr_javadoccomment"> * @param url the LDAP url.</em> |
| <a name="141" href="#141">141</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="142" href="#142">142</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setUrl(String url) { |
| <a name="143" href="#143">143</a> <strong class="jxr_keyword">this</strong>.url = url; |
| <a name="144" href="#144">144</a> } |
| <a name="145" href="#145">145</a> |
| <a name="146" href="#146">146</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="147" href="#147">147</a> <em class="jxr_javadoccomment"> * Sets the LDAP referral property. Defaults to "follow"</em> |
| <a name="148" href="#148">148</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="149" href="#149">149</a> <em class="jxr_javadoccomment"> * @param referral the referral property.</em> |
| <a name="150" href="#150">150</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="151" href="#151">151</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setReferral(String referral) { |
| <a name="152" href="#152">152</a> <strong class="jxr_keyword">this</strong>.referral = referral; |
| <a name="153" href="#153">153</a> } |
| <a name="154" href="#154">154</a> |
| <a name="155" href="#155">155</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="156" href="#156">156</a> <em class="jxr_javadoccomment"> * The system username that will be used when connecting to the LDAP server to retrieve authorization</em> |
| <a name="157" href="#157">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 name="158" href="#158">158</a> <em class="jxr_javadoccomment"> * only authentication.</em> |
| <a name="159" href="#159">159</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="160" href="#160">160</a> <em class="jxr_javadoccomment"> * @param systemUsername the username to use when logging into the LDAP server for authorization.</em> |
| <a name="161" href="#161">161</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="162" href="#162">162</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setSystemUsername(String systemUsername) { |
| <a name="163" href="#163">163</a> <strong class="jxr_keyword">this</strong>.systemUsername = systemUsername; |
| <a name="164" href="#164">164</a> } |
| <a name="165" href="#165">165</a> |
| <a name="166" href="#166">166</a> |
| <a name="167" href="#167">167</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="168" href="#168">168</a> <em class="jxr_javadoccomment"> * The system password that will be used when connecting to the LDAP server to retrieve authorization</em> |
| <a name="169" href="#169">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 name="170" href="#170">170</a> <em class="jxr_javadoccomment"> * only authentication.</em> |
| <a name="171" href="#171">171</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="172" href="#172">172</a> <em class="jxr_javadoccomment"> * @param systemPassword the password to use when logging into the LDAP server for authorization.</em> |
| <a name="173" href="#173">173</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="174" href="#174">174</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setSystemPassword(String systemPassword) { |
| <a name="175" href="#175">175</a> <strong class="jxr_keyword">this</strong>.systemPassword = systemPassword; |
| <a name="176" href="#176">176</a> } |
| <a name="177" href="#177">177</a> |
| <a name="178" href="#178">178</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="179" href="#179">179</a> <em class="jxr_javadoccomment"> * Determines whether or not LdapContext pooling is enabled for connections made using the system</em> |
| <a name="180" href="#180">180</a> <em class="jxr_javadoccomment"> * user account. In the default implementation, this simply</em> |
| <a name="181" href="#181">181</a> <em class="jxr_javadoccomment"> * sets the <tt>com.sun.jndi.ldap.connect.pool</tt> property in the LDAP context environment. If you use an</em> |
| <a name="182" href="#182">182</a> <em class="jxr_javadoccomment"> * LDAP Context Factory that is not Sun's default implementation, you will need to override the</em> |
| <a name="183" href="#183">183</a> <em class="jxr_javadoccomment"> * default behavior to use this setting in whatever way your underlying LDAP ContextFactory</em> |
| <a name="184" href="#184">184</a> <em class="jxr_javadoccomment"> * supports. By default, pooling is enabled.</em> |
| <a name="185" href="#185">185</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="186" href="#186">186</a> <em class="jxr_javadoccomment"> * @param usePooling true to enable pooling, or false to disable it.</em> |
| <a name="187" href="#187">187</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="188" href="#188">188</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setUsePooling(<strong class="jxr_keyword">boolean</strong> usePooling) { |
| <a name="189" href="#189">189</a> <strong class="jxr_keyword">this</strong>.usePooling = usePooling; |
| <a name="190" href="#190">190</a> } |
| <a name="191" href="#191">191</a> |
| <a name="192" href="#192">192</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="193" href="#193">193</a> <em class="jxr_javadoccomment"> * These entries are added to the environment map before initializing the LDAP context.</em> |
| <a name="194" href="#194">194</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="195" href="#195">195</a> <em class="jxr_javadoccomment"> * @param additionalEnvironment additional environment entries to be configured on the LDAP context.</em> |
| <a name="196" href="#196">196</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="197" href="#197">197</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setAdditionalEnvironment(Map<String, String> additionalEnvironment) { |
| <a name="198" href="#198">198</a> <strong class="jxr_keyword">this</strong>.additionalEnvironment = additionalEnvironment; |
| <a name="199" href="#199">199</a> } |
| <a name="200" href="#200">200</a> |
| <a name="201" href="#201">201</a> <em class="jxr_comment">/*<em class="jxr_comment">--------------------------------------------</em></em> |
| <a name="202" href="#202">202</a> <em class="jxr_comment"> | M E T H O D S |</em> |
| <a name="203" href="#203">203</a> <em class="jxr_comment"> ============================================*/</em> |
| <a name="204" href="#204">204</a> <strong class="jxr_keyword">public</strong> LdapContext getSystemLdapContext() <strong class="jxr_keyword">throws</strong> NamingException { |
| <a name="205" href="#205">205</a> <strong class="jxr_keyword">return</strong> getLdapContext(systemUsername, systemPassword); |
| <a name="206" href="#206">206</a> } |
| <a name="207" href="#207">207</a> |
| <a name="208" href="#208">208</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="209" href="#209">209</a> <em class="jxr_javadoccomment"> * Deprecated - use {@link #getLdapContext(Object, Object)} instead. This will be removed before Apache Shiro 2.0.</em> |
| <a name="210" href="#210">210</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="211" href="#211">211</a> <em class="jxr_javadoccomment"> * @param username the username to use when creating the connection.</em> |
| <a name="212" href="#212">212</a> <em class="jxr_javadoccomment"> * @param password the password to use when creating the connection.</em> |
| <a name="213" href="#213">213</a> <em class="jxr_javadoccomment"> * @return a {@code LdapContext} bound using the given username and password.</em> |
| <a name="214" href="#214">214</a> <em class="jxr_javadoccomment"> * @throws javax.naming.NamingException if there is an error creating the context.</em> |
| <a name="215" href="#215">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 name="216" href="#216">216</a> <em class="jxr_javadoccomment"> * String principals and credentials can be used. Shiro no longer calls this method - it will be</em> |
| <a name="217" href="#217">217</a> <em class="jxr_javadoccomment"> * removed before the 2.0 release.</em> |
| <a name="218" href="#218">218</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="219" href="#219">219</a> @Deprecated |
| <a name="220" href="#220">220</a> <strong class="jxr_keyword">public</strong> LdapContext getLdapContext(String username, String password) <strong class="jxr_keyword">throws</strong> NamingException { |
| <a name="221" href="#221">221</a> <strong class="jxr_keyword">if</strong> (username != <strong class="jxr_keyword">null</strong> && principalSuffix != <strong class="jxr_keyword">null</strong>) { |
| <a name="222" href="#222">222</a> username += principalSuffix; |
| <a name="223" href="#223">223</a> } |
| <a name="224" href="#224">224</a> <strong class="jxr_keyword">return</strong> getLdapContext((Object) username, password); |
| <a name="225" href="#225">225</a> } |
| <a name="226" href="#226">226</a> |
| <a name="227" href="#227">227</a> <strong class="jxr_keyword">public</strong> LdapContext getLdapContext(Object principal, Object credentials) <strong class="jxr_keyword">throws</strong> NamingException { |
| <a name="228" href="#228">228</a> <strong class="jxr_keyword">if</strong> (url == <strong class="jxr_keyword">null</strong>) { |
| <a name="229" href="#229">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://<hostname>:<port>"</span>); |
| <a name="230" href="#230">230</a> } |
| <a name="231" href="#231">231</a> |
| <a name="232" href="#232">232</a> Hashtable<String, Object> env = <strong class="jxr_keyword">new</strong> Hashtable<String, Object>(); |
| <a name="233" href="#233">233</a> |
| <a name="234" href="#234">234</a> env.put(Context.SECURITY_AUTHENTICATION, authentication); |
| <a name="235" href="#235">235</a> <strong class="jxr_keyword">if</strong> (principal != <strong class="jxr_keyword">null</strong>) { |
| <a name="236" href="#236">236</a> env.put(Context.SECURITY_PRINCIPAL, principal); |
| <a name="237" href="#237">237</a> } |
| <a name="238" href="#238">238</a> <strong class="jxr_keyword">if</strong> (credentials!= <strong class="jxr_keyword">null</strong>) { |
| <a name="239" href="#239">239</a> env.put(Context.SECURITY_CREDENTIALS, credentials); |
| <a name="240" href="#240">240</a> } |
| <a name="241" href="#241">241</a> env.put(Context.INITIAL_CONTEXT_FACTORY, contextFactoryClassName); |
| <a name="242" href="#242">242</a> env.put(Context.PROVIDER_URL, url); |
| <a name="243" href="#243">243</a> env.put(Context.REFERRAL, referral); |
| <a name="244" href="#244">244</a> |
| <a name="245" href="#245">245</a> <em class="jxr_comment">// Only pool connections for system contexts</em> |
| <a name="246" href="#246">246</a> <strong class="jxr_keyword">if</strong> (usePooling && principal != <strong class="jxr_keyword">null</strong> && principal.equals(systemUsername)) { |
| <a name="247" href="#247">247</a> <em class="jxr_comment">// Enable connection pooling</em> |
| <a name="248" href="#248">248</a> env.put(SUN_CONNECTION_POOLING_PROPERTY, <span class="jxr_string">"true"</span>); |
| <a name="249" href="#249">249</a> } |
| <a name="250" href="#250">250</a> |
| <a name="251" href="#251">251</a> <strong class="jxr_keyword">if</strong> (additionalEnvironment != <strong class="jxr_keyword">null</strong>) { |
| <a name="252" href="#252">252</a> env.putAll(additionalEnvironment); |
| <a name="253" href="#253">253</a> } |
| <a name="254" href="#254">254</a> |
| <a name="255" href="#255">255</a> <strong class="jxr_keyword">if</strong> (log.isDebugEnabled()) { |
| <a name="256" href="#256">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 name="257" href="#257">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 name="258" href="#258">258</a> } |
| <a name="259" href="#259">259</a> |
| <a name="260" href="#260">260</a> <em class="jxr_comment">// validate the config before creating the context</em> |
| <a name="261" href="#261">261</a> validateAuthenticationInfo(env); |
| <a name="262" href="#262">262</a> |
| <a name="263" href="#263">263</a> <strong class="jxr_keyword">return</strong> createLdapContext(env); |
| <a name="264" href="#264">264</a> } |
| <a name="265" href="#265">265</a> |
| <a name="266" href="#266">266</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="267" href="#267">267</a> <em class="jxr_javadoccomment"> * Creates and returns a new {@link javax.naming.ldap.InitialLdapContext} instance. This method exists primarily</em> |
| <a name="268" href="#268">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 name="269" href="#269">269</a> <em class="jxr_javadoccomment"> * subclasses are free to provide a different implementation if necessary.</em> |
| <a name="270" href="#270">270</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="271" href="#271">271</a> <em class="jxr_javadoccomment"> * @param env the JNDI environment settings used to create the LDAP connection</em> |
| <a name="272" href="#272">272</a> <em class="jxr_javadoccomment"> * @return an LdapConnection</em> |
| <a name="273" href="#273">273</a> <em class="jxr_javadoccomment"> * @throws NamingException if a problem occurs creating the connection</em> |
| <a name="274" href="#274">274</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="275" href="#275">275</a> <strong class="jxr_keyword">protected</strong> LdapContext createLdapContext(Hashtable env) <strong class="jxr_keyword">throws</strong> NamingException { |
| <a name="276" href="#276">276</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> InitialLdapContext(env, <strong class="jxr_keyword">null</strong>); |
| <a name="277" href="#277">277</a> } |
| <a name="278" href="#278">278</a> |
| <a name="279" href="#279">279</a> |
| <a name="280" href="#280">280</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="281" href="#281">281</a> <em class="jxr_javadoccomment"> * Validates the configuration in the JNDI <code>environment</code> settings and throws an exception if a problem</em> |
| <a name="282" href="#282">282</a> <em class="jxr_javadoccomment"> * exists.</em> |
| <a name="283" href="#283">283</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="284" href="#284">284</a> <em class="jxr_javadoccomment"> * This implementation will throw a {@link AuthenticationException} if the authentication mechanism is set to</em> |
| <a name="285" href="#285">285</a> <em class="jxr_javadoccomment"> * 'simple', the principal is non-empty, and the credentials are empty (as per</em> |
| <a name="286" href="#286">286</a> <em class="jxr_javadoccomment"> * <a href="<a href="http://tools.ietf.org/html/rfc4513" target="alexandria_uri">http://tools.ietf.org/html/rfc4513</a>#section-5.1.2">rfc4513 section-5.1.2</a>).</em> |
| <a name="287" href="#287">287</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="288" href="#288">288</a> <em class="jxr_javadoccomment"> * @param environment the JNDI environment settings to be validated</em> |
| <a name="289" href="#289">289</a> <em class="jxr_javadoccomment"> * @throws AuthenticationException if a configuration problem is detected</em> |
| <a name="290" href="#290">290</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="291" href="#291">291</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> validateAuthenticationInfo(Hashtable<String, Object> environment) |
| <a name="292" href="#292">292</a> <strong class="jxr_keyword">throws</strong> AuthenticationException |
| <a name="293" href="#293">293</a> { |
| <a name="294" href="#294">294</a> <em class="jxr_comment">// validate when using Simple auth both principal and credentials are set</em> |
| <a name="295" href="#295">295</a> <strong class="jxr_keyword">if</strong>(SIMPLE_AUTHENTICATION_MECHANISM_NAME.equals(environment.get(Context.SECURITY_AUTHENTICATION))) { |
| <a name="296" href="#296">296</a> |
| <a name="297" href="#297">297</a> <em class="jxr_comment">// only validate credentials if we have a non-empty principal</em> |
| <a name="298" href="#298">298</a> <strong class="jxr_keyword">if</strong>( environment.get(Context.SECURITY_PRINCIPAL) != <strong class="jxr_keyword">null</strong> && |
| <a name="299" href="#299">299</a> StringUtils.hasText( String.valueOf( environment.get(Context.SECURITY_PRINCIPAL) ))) { |
| <a name="300" href="#300">300</a> |
| <a name="301" href="#301">301</a> Object credentials = environment.get(Context.SECURITY_CREDENTIALS); |
| <a name="302" href="#302">302</a> |
| <a name="303" href="#303">303</a> <em class="jxr_comment">// from the FAQ, we need to check for empty credentials:</em> |
| <a name="304" href="#304">304</a> <em class="jxr_comment">// http://docs.oracle.com/javase/tutorial/jndi/ldap/faq.html</em> |
| <a name="305" href="#305">305</a> <strong class="jxr_keyword">if</strong>( credentials == <strong class="jxr_keyword">null</strong> || |
| <a name="306" href="#306">306</a> (credentials instanceof byte[] && ((byte[])credentials).length <= 0) || <em class="jxr_comment">// empty byte[]</em> |
| <a name="307" href="#307">307</a> (credentials instanceof <strong class="jxr_keyword">char</strong>[] && ((<strong class="jxr_keyword">char</strong>[])credentials).length <= 0) || <em class="jxr_comment">// empty char[]</em> |
| <a name="308" href="#308">308</a> (String.<strong class="jxr_keyword">class</strong>.isInstance(credentials) && !StringUtils.hasText(String.valueOf(credentials)))) { |
| <a name="309" href="#309">309</a> |
| <a name="310" href="#310">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 name="311" href="#311">311</a> + <span class="jxr_string">"principal and credentials."</span>); |
| <a name="312" href="#312">312</a> } |
| <a name="313" href="#313">313</a> } |
| <a name="314" href="#314">314</a> } |
| <a name="315" href="#315">315</a> } |
| <a name="316" href="#316">316</a> |
| <a name="317" href="#317">317</a> } |
| </pre> |
| <hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body> |
| </html> |