Google Git
Sign in
apache / shiro-site / 01016f43374d9b054f3ea1e568b015d5d69428f9 / . / src / site / assets / static / 1.10.1 / shiro-core / xref / org / apache / shiro / realm / ldap / AbstractLdapRealm.html
blob: 9a4e63767b865d49bb88090c570f6370441a2126 [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>AbstractLdapRealm xref</title>
<link type="text/css" rel="stylesheet" href="../../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../../apidocs/org/apache/shiro/realm/ldap/AbstractLdapRealm.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> org.apache.shiro.authc.AuthenticationException;
<a class="jxr_linenumber" name="L22" href="#L22">22</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.authc.AuthenticationInfo;
<a class="jxr_linenumber" name="L23" href="#L23">23</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.authc.AuthenticationToken;
<a class="jxr_linenumber" name="L24" href="#L24">24</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.authz.AuthorizationException;
<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.realm.AuthorizingRealm;
<a class="jxr_linenumber" name="L27" href="#L27">27</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.subject.PrincipalCollection;
<a class="jxr_linenumber" name="L28" href="#L28">28</a> <strong class="jxr_keyword">import</strong> org.slf4j.Logger;
<a class="jxr_linenumber" name="L29" href="#L29">29</a> <strong class="jxr_keyword">import</strong> org.slf4j.LoggerFactory;
<a class="jxr_linenumber" name="L30" href="#L30">30</a>
<a class="jxr_linenumber" name="L31" href="#L31">31</a> <strong class="jxr_keyword">import</strong> javax.naming.NamingException;
<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;A {@link org.apache.shiro.realm.Realm} that authenticates with an LDAP</em>
<a class="jxr_linenumber" name="L35" href="#L35">35</a> <em class="jxr_javadoccomment"> * server to build the Subject for a user. This implementation only returns roles for a</em>
<a class="jxr_linenumber" name="L36" href="#L36">36</a> <em class="jxr_javadoccomment"> * particular user, and not permissions - but it can be subclassed to build a permission</em>
<a class="jxr_linenumber" name="L37" href="#L37">37</a> <em class="jxr_javadoccomment"> * list as well.&lt;/p&gt;</em>
<a class="jxr_linenumber" name="L38" href="#L38">38</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L39" href="#L39">39</a> <em class="jxr_javadoccomment"> * &lt;p&gt;Implementations would need to implement the</em>
<a class="jxr_linenumber" name="L40" href="#L40">40</a> <em class="jxr_javadoccomment"> * {@link #queryForAuthenticationInfo(org.apache.shiro.authc.AuthenticationToken ,LdapContextFactory)} and</em>
<a class="jxr_linenumber" name="L41" href="#L41">41</a> <em class="jxr_javadoccomment"> * {@link #queryForAuthorizationInfo(org.apache.shiro.subject.PrincipalCollection ,LdapContextFactory)} abstract methods.&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"> * &lt;p&gt;By default, this implementation will create an instance of {@link DefaultLdapContextFactory} to use for</em>
<a class="jxr_linenumber" name="L44" href="#L44">44</a> <em class="jxr_javadoccomment"> * creating LDAP connections using the principalSuffix, searchBase, url, systemUsername, and systemPassword properties</em>
<a class="jxr_linenumber" name="L45" href="#L45">45</a> <em class="jxr_javadoccomment"> * specified on the realm. The remaining settings use the defaults of {@link DefaultLdapContextFactory}, which are usually</em>
<a class="jxr_linenumber" name="L46" href="#L46">46</a> <em class="jxr_javadoccomment"> * sufficient. If more customized connections are needed, you should inject a custom {@link LdapContextFactory}, which</em>
<a class="jxr_linenumber" name="L47" href="#L47">47</a> <em class="jxr_javadoccomment"> * will cause these properties specified on the realm to be ignored.&lt;/p&gt;</em>
<a class="jxr_linenumber" name="L48" href="#L48">48</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L49" href="#L49">49</a> <em class="jxr_javadoccomment"> * @see #queryForAuthenticationInfo(org.apache.shiro.authc.AuthenticationToken , LdapContextFactory)</em>
<a class="jxr_linenumber" name="L50" href="#L50">50</a> <em class="jxr_javadoccomment"> * @see #queryForAuthorizationInfo(org.apache.shiro.subject.PrincipalCollection , LdapContextFactory)</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">abstract</strong> <strong class="jxr_keyword">class</strong> <a name="AbstractLdapRealm" href="../../../../../org/apache/shiro/realm/ldap/AbstractLdapRealm.html#AbstractLdapRealm">AbstractLdapRealm</a> <strong class="jxr_keyword">extends</strong> <a name="AuthorizingRealm" href="../../../../../org/apache/shiro/realm/AuthorizingRealm.html#AuthorizingRealm">AuthorizingRealm</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(AbstractLdapRealm.<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> <em class="jxr_comment">/*--------------------------------------------</em>
<a class="jxr_linenumber" name="L64" href="#L64">64</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="L65" href="#L65">65</a> <em class="jxr_comment"> ============================================*/</em>
<a class="jxr_linenumber" name="L66" href="#L66">66</a>
<a class="jxr_linenumber" name="L67" href="#L67">67</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L68" href="#L68">68</a> <em class="jxr_javadoccomment"> * Defines the Suffix added to the User Principal Name when looking up groups (e.g. "memberOf")</em>
<a class="jxr_linenumber" name="L69" href="#L69">69</a> <em class="jxr_javadoccomment"> * AD Example:</em>
<a class="jxr_linenumber" name="L70" href="#L70">70</a> <em class="jxr_javadoccomment"> * User's Principal Name be "John.Doe"</em>
<a class="jxr_linenumber" name="L71" href="#L71">71</a> <em class="jxr_javadoccomment"> * User's E-Mail Address be "John.Doe@example.com"</em>
<a class="jxr_linenumber" name="L72" href="#L72">72</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L73" href="#L73">73</a> <em class="jxr_javadoccomment"> * For the example below, set:</em>
<a class="jxr_linenumber" name="L74" href="#L74">74</a> <em class="jxr_javadoccomment"> * realm.principalSuffix = @example.com</em>
<a class="jxr_linenumber" name="L75" href="#L75">75</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L76" href="#L76">76</a> <em class="jxr_javadoccomment"> * Only then, "John.Doe" and also "John.Doe@example.com" can authorize against groups</em>
<a class="jxr_linenumber" name="L77" href="#L77">77</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L78" href="#L78">78</a> <strong class="jxr_keyword">protected</strong> String principalSuffix = <strong class="jxr_keyword">null</strong>;
<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 searchBase = <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 url = <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">protected</strong> String systemUsername = <strong class="jxr_keyword">null</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">protected</strong> String systemPassword = <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="L87" href="#L87">87</a>
<a class="jxr_linenumber" name="L88" href="#L88">88</a> <em class="jxr_comment">//SHIRO-115 - prevent potential code injection:</em>
<a class="jxr_linenumber" name="L89" href="#L89">89</a> <strong class="jxr_keyword">protected</strong> String searchFilter = <span class="jxr_string">"(&amp;(objectClass=*)(userPrincipalName={0}))"</span>;
<a class="jxr_linenumber" name="L90" href="#L90">90</a>
<a class="jxr_linenumber" name="L91" href="#L91">91</a> <strong class="jxr_keyword">private</strong> <a name="LdapContextFactory" href="../../../../../org/apache/shiro/realm/ldap/LdapContextFactory.html#LdapContextFactory">LdapContextFactory</a> ldapContextFactory = <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="L92" href="#L92">92</a>
<a class="jxr_linenumber" name="L93" href="#L93">93</a> <em class="jxr_comment">/*--------------------------------------------</em>
<a class="jxr_linenumber" name="L94" href="#L94">94</a> <em class="jxr_comment"> | C O N S T R U C T O R S |</em>
<a class="jxr_linenumber" name="L95" href="#L95">95</a> <em class="jxr_comment"> ============================================*/</em>
<a class="jxr_linenumber" name="L96" href="#L96">96</a>
<a class="jxr_linenumber" name="L97" href="#L97">97</a> <em class="jxr_comment">/*--------------------------------------------</em>
<a class="jxr_linenumber" name="L98" href="#L98">98</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="L99" href="#L99">99</a> <em class="jxr_comment"> ============================================*/</em>
<a class="jxr_linenumber" name="L100" href="#L100">100</a>
<a class="jxr_linenumber" name="L101" href="#L101">101</a> <em class="jxr_comment">/*--------------------------------------------</em>
<a class="jxr_linenumber" name="L102" href="#L102">102</a> <em class="jxr_comment"> | M E T H O D S |</em>
<a class="jxr_linenumber" name="L103" href="#L103">103</a> <em class="jxr_comment"> ============================================*/</em>
<a class="jxr_linenumber" name="L104" href="#L104">104</a>
<a class="jxr_linenumber" name="L105" href="#L105">105</a>
<a class="jxr_linenumber" name="L106" href="#L106">106</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L107" href="#L107">107</a> <em class="jxr_javadoccomment"> * Used when initializing the default {@link LdapContextFactory}. This property is ignored if a custom</em>
<a class="jxr_linenumber" name="L108" href="#L108">108</a> <em class="jxr_javadoccomment"> * &lt;tt&gt;LdapContextFactory&lt;/tt&gt; is specified.</em>
<a class="jxr_linenumber" name="L109" href="#L109">109</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L110" href="#L110">110</a> <em class="jxr_javadoccomment"> * @param principalSuffix the suffix.</em>
<a class="jxr_linenumber" name="L111" href="#L111">111</a> <em class="jxr_javadoccomment"> * @see DefaultLdapContextFactory#setPrincipalSuffix(String)</em>
<a class="jxr_linenumber" name="L112" href="#L112">112</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L113" href="#L113">113</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setPrincipalSuffix(String principalSuffix) {
<a class="jxr_linenumber" name="L114" href="#L114">114</a> <strong class="jxr_keyword">this</strong>.principalSuffix = principalSuffix;
<a class="jxr_linenumber" name="L115" href="#L115">115</a> }
<a class="jxr_linenumber" name="L116" href="#L116">116</a>
<a class="jxr_linenumber" name="L117" href="#L117">117</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L118" href="#L118">118</a> <em class="jxr_javadoccomment"> * Used when initializing the default {@link LdapContextFactory}. This property is ignored if a custom</em>
<a class="jxr_linenumber" name="L119" href="#L119">119</a> <em class="jxr_javadoccomment"> * &lt;tt&gt;LdapContextFactory&lt;/tt&gt; is specified.</em>
<a class="jxr_linenumber" name="L120" href="#L120">120</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L121" href="#L121">121</a> <em class="jxr_javadoccomment"> * @param searchBase the search base.</em>
<a class="jxr_linenumber" name="L122" href="#L122">122</a> <em class="jxr_javadoccomment"> * @see DefaultLdapContextFactory#setSearchBase(String)</em>
<a class="jxr_linenumber" name="L123" href="#L123">123</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L124" href="#L124">124</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setSearchBase(String searchBase) {
<a class="jxr_linenumber" name="L125" href="#L125">125</a> <strong class="jxr_keyword">this</strong>.searchBase = searchBase;
<a class="jxr_linenumber" name="L126" href="#L126">126</a> }
<a class="jxr_linenumber" name="L127" href="#L127">127</a>
<a class="jxr_linenumber" name="L128" href="#L128">128</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L129" href="#L129">129</a> <em class="jxr_javadoccomment"> * Used when initializing the default {@link LdapContextFactory}. This property is ignored if a custom</em>
<a class="jxr_linenumber" name="L130" href="#L130">130</a> <em class="jxr_javadoccomment"> * &lt;tt&gt;LdapContextFactory&lt;/tt&gt; is specified.</em>
<a class="jxr_linenumber" name="L131" href="#L131">131</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L132" href="#L132">132</a> <em class="jxr_javadoccomment"> * @param url the LDAP url.</em>
<a class="jxr_linenumber" name="L133" href="#L133">133</a> <em class="jxr_javadoccomment"> * @see DefaultLdapContextFactory#setUrl(String)</em>
<a class="jxr_linenumber" name="L134" href="#L134">134</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L135" href="#L135">135</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setUrl(String url) {
<a class="jxr_linenumber" name="L136" href="#L136">136</a> <strong class="jxr_keyword">this</strong>.url = url;
<a class="jxr_linenumber" name="L137" href="#L137">137</a> }
<a class="jxr_linenumber" name="L138" href="#L138">138</a>
<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"> * Used when initializing the default {@link LdapContextFactory}. This property is ignored if a custom</em>
<a class="jxr_linenumber" name="L141" href="#L141">141</a> <em class="jxr_javadoccomment"> * &lt;tt&gt;LdapContextFactory&lt;/tt&gt; is specified.</em>
<a class="jxr_linenumber" name="L142" href="#L142">142</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L143" href="#L143">143</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="L144" href="#L144">144</a> <em class="jxr_javadoccomment"> * @see DefaultLdapContextFactory#setSystemUsername(String)</em>
<a class="jxr_linenumber" name="L145" href="#L145">145</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L146" href="#L146">146</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setSystemUsername(String systemUsername) {
<a class="jxr_linenumber" name="L147" href="#L147">147</a> <strong class="jxr_keyword">this</strong>.systemUsername = systemUsername;
<a class="jxr_linenumber" name="L148" href="#L148">148</a> }
<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> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L152" href="#L152">152</a> <em class="jxr_javadoccomment"> * Used when initializing the default {@link LdapContextFactory}. This property is ignored if a custom</em>
<a class="jxr_linenumber" name="L153" href="#L153">153</a> <em class="jxr_javadoccomment"> * &lt;tt&gt;LdapContextFactory&lt;/tt&gt; is specified.</em>
<a class="jxr_linenumber" name="L154" href="#L154">154</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L155" href="#L155">155</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="L156" href="#L156">156</a> <em class="jxr_javadoccomment"> * @see DefaultLdapContextFactory#setSystemPassword(String)</em>
<a class="jxr_linenumber" name="L157" href="#L157">157</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L158" href="#L158">158</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setSystemPassword(String systemPassword) {
<a class="jxr_linenumber" name="L159" href="#L159">159</a> <strong class="jxr_keyword">this</strong>.systemPassword = systemPassword;
<a class="jxr_linenumber" name="L160" href="#L160">160</a> }
<a class="jxr_linenumber" name="L161" href="#L161">161</a>
<a class="jxr_linenumber" name="L162" href="#L162">162</a>
<a class="jxr_linenumber" name="L163" href="#L163">163</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L164" href="#L164">164</a> <em class="jxr_javadoccomment"> * Configures the {@link LdapContextFactory} implementation that is used to create LDAP connections for</em>
<a class="jxr_linenumber" name="L165" href="#L165">165</a> <em class="jxr_javadoccomment"> * authentication and authorization. If this is set, the {@link LdapContextFactory} provided will be used.</em>
<a class="jxr_linenumber" name="L166" href="#L166">166</a> <em class="jxr_javadoccomment"> * Otherwise, a {@link DefaultLdapContextFactory} instance will be created based on the properties specified</em>
<a class="jxr_linenumber" name="L167" href="#L167">167</a> <em class="jxr_javadoccomment"> * in this realm.</em>
<a class="jxr_linenumber" name="L168" href="#L168">168</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L169" href="#L169">169</a> <em class="jxr_javadoccomment"> * @param ldapContextFactory the factory to use - if not specified, a default factory will be created automatically.</em>
<a class="jxr_linenumber" name="L170" href="#L170">170</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L171" href="#L171">171</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setLdapContextFactory(<a name="LdapContextFactory" href="../../../../../org/apache/shiro/realm/ldap/LdapContextFactory.html#LdapContextFactory">LdapContextFactory</a> ldapContextFactory) {
<a class="jxr_linenumber" name="L172" href="#L172">172</a> <strong class="jxr_keyword">this</strong>.ldapContextFactory = ldapContextFactory;
<a class="jxr_linenumber" name="L173" href="#L173">173</a> }
<a class="jxr_linenumber" name="L174" href="#L174">174</a>
<a class="jxr_linenumber" name="L175" href="#L175">175</a>
<a class="jxr_linenumber" name="L176" href="#L176">176</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setSearchFilter(String searchFilter) {
<a class="jxr_linenumber" name="L177" href="#L177">177</a> <strong class="jxr_keyword">this</strong>.searchFilter = searchFilter;
<a class="jxr_linenumber" name="L178" href="#L178">178</a> }
<a class="jxr_linenumber" name="L179" href="#L179">179</a>
<a class="jxr_linenumber" name="L180" href="#L180">180</a> <em class="jxr_comment">/*--------------------------------------------</em>
<a class="jxr_linenumber" name="L181" href="#L181">181</a> <em class="jxr_comment"> | M E T H O D S |</em>
<a class="jxr_linenumber" name="L182" href="#L182">182</a> <em class="jxr_comment"> ============================================*/</em>
<a class="jxr_linenumber" name="L183" href="#L183">183</a>
<a class="jxr_linenumber" name="L184" href="#L184">184</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> onInit() {
<a class="jxr_linenumber" name="L185" href="#L185">185</a> <strong class="jxr_keyword">super</strong>.onInit();
<a class="jxr_linenumber" name="L186" href="#L186">186</a> ensureContextFactory();
<a class="jxr_linenumber" name="L187" href="#L187">187</a> }
<a class="jxr_linenumber" name="L188" href="#L188">188</a>
<a class="jxr_linenumber" name="L189" href="#L189">189</a> <strong class="jxr_keyword">private</strong> <a name="LdapContextFactory" href="../../../../../org/apache/shiro/realm/ldap/LdapContextFactory.html#LdapContextFactory">LdapContextFactory</a> ensureContextFactory() {
<a class="jxr_linenumber" name="L190" href="#L190">190</a> <strong class="jxr_keyword">if</strong> (<strong class="jxr_keyword">this</strong>.ldapContextFactory == <strong class="jxr_keyword">null</strong>) {
<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">"No LdapContextFactory specified - creating a default instance."</span>);
<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> <a name="DefaultLdapContextFactory" href="../../../../../org/apache/shiro/realm/ldap/DefaultLdapContextFactory.html#DefaultLdapContextFactory">DefaultLdapContextFactory</a> defaultFactory = <strong class="jxr_keyword">new</strong> <a name="DefaultLdapContextFactory" href="../../../../../org/apache/shiro/realm/ldap/DefaultLdapContextFactory.html#DefaultLdapContextFactory">DefaultLdapContextFactory</a>();
<a class="jxr_linenumber" name="L197" href="#L197">197</a> defaultFactory.setPrincipalSuffix(<strong class="jxr_keyword">this</strong>.principalSuffix);
<a class="jxr_linenumber" name="L198" href="#L198">198</a> defaultFactory.setSearchBase(<strong class="jxr_keyword">this</strong>.searchBase);
<a class="jxr_linenumber" name="L199" href="#L199">199</a> defaultFactory.setUrl(<strong class="jxr_keyword">this</strong>.url);
<a class="jxr_linenumber" name="L200" href="#L200">200</a> defaultFactory.setSystemUsername(<strong class="jxr_keyword">this</strong>.systemUsername);
<a class="jxr_linenumber" name="L201" href="#L201">201</a> defaultFactory.setSystemPassword(<strong class="jxr_keyword">this</strong>.systemPassword);
<a class="jxr_linenumber" name="L202" href="#L202">202</a>
<a class="jxr_linenumber" name="L203" href="#L203">203</a> <strong class="jxr_keyword">this</strong>.ldapContextFactory = defaultFactory;
<a class="jxr_linenumber" name="L204" href="#L204">204</a> }
<a class="jxr_linenumber" name="L205" href="#L205">205</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>.ldapContextFactory;
<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>
<a class="jxr_linenumber" name="L209" href="#L209">209</a> <strong class="jxr_keyword">protected</strong> <a name="AuthenticationInfo" href="../../../../../org/apache/shiro/authc/AuthenticationInfo.html#AuthenticationInfo">AuthenticationInfo</a> doGetAuthenticationInfo(<a name="AuthenticationToken" href="../../../../../org/apache/shiro/authc/AuthenticationToken.html#AuthenticationToken">AuthenticationToken</a> token) <strong class="jxr_keyword">throws</strong> <a name="AuthenticationException" href="../../../../../org/apache/shiro/authc/AuthenticationException.html#AuthenticationException">AuthenticationException</a> {
<a class="jxr_linenumber" name="L210" href="#L210">210</a> <a name="AuthenticationInfo" href="../../../../../org/apache/shiro/authc/AuthenticationInfo.html#AuthenticationInfo">AuthenticationInfo</a> info;
<a class="jxr_linenumber" name="L211" href="#L211">211</a> <strong class="jxr_keyword">try</strong> {
<a class="jxr_linenumber" name="L212" href="#L212">212</a> info = queryForAuthenticationInfo(token, ensureContextFactory());
<a class="jxr_linenumber" name="L213" href="#L213">213</a> } <strong class="jxr_keyword">catch</strong> (javax.naming.AuthenticationException e) {
<a class="jxr_linenumber" name="L214" href="#L214">214</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a name="AuthenticationException" href="../../../../../org/apache/shiro/authc/AuthenticationException.html#AuthenticationException">AuthenticationException</a>(<span class="jxr_string">"LDAP authentication failed."</span>, e);
<a class="jxr_linenumber" name="L215" href="#L215">215</a> } <strong class="jxr_keyword">catch</strong> (NamingException e) {
<a class="jxr_linenumber" name="L216" href="#L216">216</a> String msg = <span class="jxr_string">"LDAP naming error while attempting to authenticate user."</span>;
<a class="jxr_linenumber" name="L217" href="#L217">217</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a name="AuthenticationException" href="../../../../../org/apache/shiro/authc/AuthenticationException.html#AuthenticationException">AuthenticationException</a>(msg, e);
<a class="jxr_linenumber" name="L218" href="#L218">218</a> }
<a class="jxr_linenumber" name="L219" href="#L219">219</a>
<a class="jxr_linenumber" name="L220" href="#L220">220</a> <strong class="jxr_keyword">return</strong> info;
<a class="jxr_linenumber" name="L221" href="#L221">221</a> }
<a class="jxr_linenumber" name="L222" href="#L222">222</a>
<a class="jxr_linenumber" name="L223" href="#L223">223</a>
<a class="jxr_linenumber" name="L224" href="#L224">224</a> <strong class="jxr_keyword">protected</strong> <a name="AuthorizationInfo" href="../../../../../org/apache/shiro/authz/AuthorizationInfo.html#AuthorizationInfo">AuthorizationInfo</a> doGetAuthorizationInfo(<a name="PrincipalCollection" href="../../../../../org/apache/shiro/subject/PrincipalCollection.html#PrincipalCollection">PrincipalCollection</a> principals) {
<a class="jxr_linenumber" name="L225" href="#L225">225</a> <a name="AuthorizationInfo" href="../../../../../org/apache/shiro/authz/AuthorizationInfo.html#AuthorizationInfo">AuthorizationInfo</a> info;
<a class="jxr_linenumber" name="L226" href="#L226">226</a> <strong class="jxr_keyword">try</strong> {
<a class="jxr_linenumber" name="L227" href="#L227">227</a> info = queryForAuthorizationInfo(principals, ensureContextFactory());
<a class="jxr_linenumber" name="L228" href="#L228">228</a> } <strong class="jxr_keyword">catch</strong> (NamingException e) {
<a class="jxr_linenumber" name="L229" href="#L229">229</a> String msg = <span class="jxr_string">"LDAP naming error while attempting to retrieve authorization for user ["</span> + principals + <span class="jxr_string">"]."</span>;
<a class="jxr_linenumber" name="L230" href="#L230">230</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a name="AuthorizationException" href="../../../../../org/apache/shiro/authz/AuthorizationException.html#AuthorizationException">AuthorizationException</a>(msg, e);
<a class="jxr_linenumber" name="L231" href="#L231">231</a> }
<a class="jxr_linenumber" name="L232" href="#L232">232</a>
<a class="jxr_linenumber" name="L233" href="#L233">233</a> <strong class="jxr_keyword">return</strong> info;
<a class="jxr_linenumber" name="L234" href="#L234">234</a> }
<a class="jxr_linenumber" name="L235" href="#L235">235</a>
<a class="jxr_linenumber" name="L236" href="#L236">236</a>
<a class="jxr_linenumber" name="L237" href="#L237">237</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L238" href="#L238">238</a> <em class="jxr_javadoccomment"> * &lt;p&gt;Abstract method that should be implemented by subclasses to builds an</em>
<a class="jxr_linenumber" name="L239" href="#L239">239</a> <em class="jxr_javadoccomment"> * {@link AuthenticationInfo} object by querying the LDAP context for the</em>
<a class="jxr_linenumber" name="L240" href="#L240">240</a> <em class="jxr_javadoccomment"> * specified username.&lt;/p&gt;</em>
<a class="jxr_linenumber" name="L241" href="#L241">241</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L242" href="#L242">242</a> <em class="jxr_javadoccomment"> * @param token the authentication token given during authentication.</em>
<a class="jxr_linenumber" name="L243" href="#L243">243</a> <em class="jxr_javadoccomment"> * @param ldapContextFactory factory used to retrieve LDAP connections.</em>
<a class="jxr_linenumber" name="L244" href="#L244">244</a> <em class="jxr_javadoccomment"> * @return an {@link AuthenticationInfo} instance containing information retrieved from the LDAP server.</em>
<a class="jxr_linenumber" name="L245" href="#L245">245</a> <em class="jxr_javadoccomment"> * @throws NamingException if any LDAP errors occur during the search.</em>
<a class="jxr_linenumber" name="L246" href="#L246">246</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L247" href="#L247">247</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">abstract</strong> <a name="AuthenticationInfo" href="../../../../../org/apache/shiro/authc/AuthenticationInfo.html#AuthenticationInfo">AuthenticationInfo</a> queryForAuthenticationInfo(<a name="AuthenticationToken" href="../../../../../org/apache/shiro/authc/AuthenticationToken.html#AuthenticationToken">AuthenticationToken</a> token, <a name="LdapContextFactory" href="../../../../../org/apache/shiro/realm/ldap/LdapContextFactory.html#LdapContextFactory">LdapContextFactory</a> ldapContextFactory) <strong class="jxr_keyword">throws</strong> NamingException;
<a class="jxr_linenumber" name="L248" href="#L248">248</a>
<a class="jxr_linenumber" name="L249" href="#L249">249</a>
<a class="jxr_linenumber" name="L250" href="#L250">250</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L251" href="#L251">251</a> <em class="jxr_javadoccomment"> * &lt;p&gt;Abstract method that should be implemented by subclasses to builds an</em>
<a class="jxr_linenumber" name="L252" href="#L252">252</a> <em class="jxr_javadoccomment"> * {@link AuthorizationInfo} object by querying the LDAP context for the</em>
<a class="jxr_linenumber" name="L253" href="#L253">253</a> <em class="jxr_javadoccomment"> * specified principal.&lt;/p&gt;</em>
<a class="jxr_linenumber" name="L254" href="#L254">254</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L255" href="#L255">255</a> <em class="jxr_javadoccomment"> * @param principal the principal of the Subject whose AuthenticationInfo should be queried from the LDAP server.</em>
<a class="jxr_linenumber" name="L256" href="#L256">256</a> <em class="jxr_javadoccomment"> * @param ldapContextFactory factory used to retrieve LDAP connections.</em>
<a class="jxr_linenumber" name="L257" href="#L257">257</a> <em class="jxr_javadoccomment"> * @return an {@link AuthorizationInfo} instance containing information retrieved from the LDAP server.</em>
<a class="jxr_linenumber" name="L258" href="#L258">258</a> <em class="jxr_javadoccomment"> * @throws NamingException if any LDAP errors occur during the search.</em>
<a class="jxr_linenumber" name="L259" href="#L259">259</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L260" href="#L260">260</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">abstract</strong> <a name="AuthorizationInfo" href="../../../../../org/apache/shiro/authz/AuthorizationInfo.html#AuthorizationInfo">AuthorizationInfo</a> queryForAuthorizationInfo(<a name="PrincipalCollection" href="../../../../../org/apache/shiro/subject/PrincipalCollection.html#PrincipalCollection">PrincipalCollection</a> principal, <a name="LdapContextFactory" href="../../../../../org/apache/shiro/realm/ldap/LdapContextFactory.html#LdapContextFactory">LdapContextFactory</a> ldapContextFactory) <strong class="jxr_keyword">throws</strong> NamingException;
<a class="jxr_linenumber" name="L261" href="#L261">261</a>
<a class="jxr_linenumber" name="L262" href="#L262">262</a> }
</pre>
<hr/>
<div id="footer">Copyright &#169; 2004&#x2013;2022 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</div>
</body>
</html>