Google Git
Sign in
apache / shiro-site / 01016f43374d9b054f3ea1e568b015d5d69428f9 / . / src / site / assets / static / 1.10.1 / shiro-core / apidocs / src-html / org / apache / shiro / realm / ldap / AbstractLdapRealm.html
blob: 4f7f1864eb84dc6b96bc4b9dd2c7e175324a3c91 [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="en">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
</head>
<body>
<main role="main">
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span><a id="line.1">/*</a>
<span class="sourceLineNo">002</span><a id="line.2"> * Licensed to the Apache Software Foundation (ASF) under one</a>
<span class="sourceLineNo">003</span><a id="line.3"> * or more contributor license agreements. See the NOTICE file</a>
<span class="sourceLineNo">004</span><a id="line.4"> * distributed with this work for additional information</a>
<span class="sourceLineNo">005</span><a id="line.5"> * regarding copyright ownership. The ASF licenses this file</a>
<span class="sourceLineNo">006</span><a id="line.6"> * to you under the Apache License, Version 2.0 (the</a>
<span class="sourceLineNo">007</span><a id="line.7"> * "License"); you may not use this file except in compliance</a>
<span class="sourceLineNo">008</span><a id="line.8"> * with the License. You may obtain a copy of the License at</a>
<span class="sourceLineNo">009</span><a id="line.9"> *</a>
<span class="sourceLineNo">010</span><a id="line.10"> * http://www.apache.org/licenses/LICENSE-2.0</a>
<span class="sourceLineNo">011</span><a id="line.11"> *</a>
<span class="sourceLineNo">012</span><a id="line.12"> * Unless required by applicable law or agreed to in writing,</a>
<span class="sourceLineNo">013</span><a id="line.13"> * software distributed under the License is distributed on an</a>
<span class="sourceLineNo">014</span><a id="line.14"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</a>
<span class="sourceLineNo">015</span><a id="line.15"> * KIND, either express or implied. See the License for the</a>
<span class="sourceLineNo">016</span><a id="line.16"> * specific language governing permissions and limitations</a>
<span class="sourceLineNo">017</span><a id="line.17"> * under the License.</a>
<span class="sourceLineNo">018</span><a id="line.18"> */</a>
<span class="sourceLineNo">019</span><a id="line.19">package org.apache.shiro.realm.ldap;</a>
<span class="sourceLineNo">020</span><a id="line.20"></a>
<span class="sourceLineNo">021</span><a id="line.21">import org.apache.shiro.authc.AuthenticationException;</a>
<span class="sourceLineNo">022</span><a id="line.22">import org.apache.shiro.authc.AuthenticationInfo;</a>
<span class="sourceLineNo">023</span><a id="line.23">import org.apache.shiro.authc.AuthenticationToken;</a>
<span class="sourceLineNo">024</span><a id="line.24">import org.apache.shiro.authz.AuthorizationException;</a>
<span class="sourceLineNo">025</span><a id="line.25">import org.apache.shiro.authz.AuthorizationInfo;</a>
<span class="sourceLineNo">026</span><a id="line.26">import org.apache.shiro.realm.AuthorizingRealm;</a>
<span class="sourceLineNo">027</span><a id="line.27">import org.apache.shiro.subject.PrincipalCollection;</a>
<span class="sourceLineNo">028</span><a id="line.28">import org.slf4j.Logger;</a>
<span class="sourceLineNo">029</span><a id="line.29">import org.slf4j.LoggerFactory;</a>
<span class="sourceLineNo">030</span><a id="line.30"></a>
<span class="sourceLineNo">031</span><a id="line.31">import javax.naming.NamingException;</a>
<span class="sourceLineNo">032</span><a id="line.32"></a>
<span class="sourceLineNo">033</span><a id="line.33">/**</a>
<span class="sourceLineNo">034</span><a id="line.34"> * &lt;p&gt;A {@link org.apache.shiro.realm.Realm} that authenticates with an LDAP</a>
<span class="sourceLineNo">035</span><a id="line.35"> * server to build the Subject for a user. This implementation only returns roles for a</a>
<span class="sourceLineNo">036</span><a id="line.36"> * particular user, and not permissions - but it can be subclassed to build a permission</a>
<span class="sourceLineNo">037</span><a id="line.37"> * list as well.&lt;/p&gt;</a>
<span class="sourceLineNo">038</span><a id="line.38"> *</a>
<span class="sourceLineNo">039</span><a id="line.39"> * &lt;p&gt;Implementations would need to implement the</a>
<span class="sourceLineNo">040</span><a id="line.40"> * {@link #queryForAuthenticationInfo(org.apache.shiro.authc.AuthenticationToken ,LdapContextFactory)} and</a>
<span class="sourceLineNo">041</span><a id="line.41"> * {@link #queryForAuthorizationInfo(org.apache.shiro.subject.PrincipalCollection ,LdapContextFactory)} abstract methods.&lt;/p&gt;</a>
<span class="sourceLineNo">042</span><a id="line.42"> *</a>
<span class="sourceLineNo">043</span><a id="line.43"> * &lt;p&gt;By default, this implementation will create an instance of {@link DefaultLdapContextFactory} to use for</a>
<span class="sourceLineNo">044</span><a id="line.44"> * creating LDAP connections using the principalSuffix, searchBase, url, systemUsername, and systemPassword properties</a>
<span class="sourceLineNo">045</span><a id="line.45"> * specified on the realm. The remaining settings use the defaults of {@link DefaultLdapContextFactory}, which are usually</a>
<span class="sourceLineNo">046</span><a id="line.46"> * sufficient. If more customized connections are needed, you should inject a custom {@link LdapContextFactory}, which</a>
<span class="sourceLineNo">047</span><a id="line.47"> * will cause these properties specified on the realm to be ignored.&lt;/p&gt;</a>
<span class="sourceLineNo">048</span><a id="line.48"> *</a>
<span class="sourceLineNo">049</span><a id="line.49"> * @see #queryForAuthenticationInfo(org.apache.shiro.authc.AuthenticationToken , LdapContextFactory)</a>
<span class="sourceLineNo">050</span><a id="line.50"> * @see #queryForAuthorizationInfo(org.apache.shiro.subject.PrincipalCollection , LdapContextFactory)</a>
<span class="sourceLineNo">051</span><a id="line.51"> * @since 0.1</a>
<span class="sourceLineNo">052</span><a id="line.52"> */</a>
<span class="sourceLineNo">053</span><a id="line.53">public abstract class AbstractLdapRealm extends AuthorizingRealm {</a>
<span class="sourceLineNo">054</span><a id="line.54"></a>
<span class="sourceLineNo">055</span><a id="line.55"> //TODO - complete JavaDoc</a>
<span class="sourceLineNo">056</span><a id="line.56"></a>
<span class="sourceLineNo">057</span><a id="line.57"> /*--------------------------------------------</a>
<span class="sourceLineNo">058</span><a id="line.58"> | C O N S T A N T S |</a>
<span class="sourceLineNo">059</span><a id="line.59"> ============================================*/</a>
<span class="sourceLineNo">060</span><a id="line.60"></a>
<span class="sourceLineNo">061</span><a id="line.61"> private static final Logger log = LoggerFactory.getLogger(AbstractLdapRealm.class);</a>
<span class="sourceLineNo">062</span><a id="line.62"></a>
<span class="sourceLineNo">063</span><a id="line.63"> /*--------------------------------------------</a>
<span class="sourceLineNo">064</span><a id="line.64"> | I N S T A N C E V A R I A B L E S |</a>
<span class="sourceLineNo">065</span><a id="line.65"> ============================================*/</a>
<span class="sourceLineNo">066</span><a id="line.66"></a>
<span class="sourceLineNo">067</span><a id="line.67"> /**</a>
<span class="sourceLineNo">068</span><a id="line.68"> * Defines the Suffix added to the User Principal Name when looking up groups (e.g. "memberOf")</a>
<span class="sourceLineNo">069</span><a id="line.69"> * AD Example:</a>
<span class="sourceLineNo">070</span><a id="line.70"> * User's Principal Name be "John.Doe"</a>
<span class="sourceLineNo">071</span><a id="line.71"> * User's E-Mail Address be "John.Doe@example.com"</a>
<span class="sourceLineNo">072</span><a id="line.72"> *</a>
<span class="sourceLineNo">073</span><a id="line.73"> * For the example below, set:</a>
<span class="sourceLineNo">074</span><a id="line.74"> * realm.principalSuffix = @example.com</a>
<span class="sourceLineNo">075</span><a id="line.75"> *</a>
<span class="sourceLineNo">076</span><a id="line.76"> * Only then, "John.Doe" and also "John.Doe@example.com" can authorize against groups</a>
<span class="sourceLineNo">077</span><a id="line.77"> */</a>
<span class="sourceLineNo">078</span><a id="line.78"> protected String principalSuffix = null;</a>
<span class="sourceLineNo">079</span><a id="line.79"></a>
<span class="sourceLineNo">080</span><a id="line.80"> protected String searchBase = null;</a>
<span class="sourceLineNo">081</span><a id="line.81"></a>
<span class="sourceLineNo">082</span><a id="line.82"> protected String url = null;</a>
<span class="sourceLineNo">083</span><a id="line.83"></a>
<span class="sourceLineNo">084</span><a id="line.84"> protected String systemUsername = null;</a>
<span class="sourceLineNo">085</span><a id="line.85"></a>
<span class="sourceLineNo">086</span><a id="line.86"> protected String systemPassword = null;</a>
<span class="sourceLineNo">087</span><a id="line.87"></a>
<span class="sourceLineNo">088</span><a id="line.88"> //SHIRO-115 - prevent potential code injection:</a>
<span class="sourceLineNo">089</span><a id="line.89"> protected String searchFilter = "(&amp;(objectClass=*)(userPrincipalName={0}))";</a>
<span class="sourceLineNo">090</span><a id="line.90"></a>
<span class="sourceLineNo">091</span><a id="line.91"> private LdapContextFactory ldapContextFactory = null;</a>
<span class="sourceLineNo">092</span><a id="line.92"></a>
<span class="sourceLineNo">093</span><a id="line.93"> /*--------------------------------------------</a>
<span class="sourceLineNo">094</span><a id="line.94"> | C O N S T R U C T O R S |</a>
<span class="sourceLineNo">095</span><a id="line.95"> ============================================*/</a>
<span class="sourceLineNo">096</span><a id="line.96"></a>
<span class="sourceLineNo">097</span><a id="line.97"> /*--------------------------------------------</a>
<span class="sourceLineNo">098</span><a id="line.98"> | A C C E S S O R S / M O D I F I E R S |</a>
<span class="sourceLineNo">099</span><a id="line.99"> ============================================*/</a>
<span class="sourceLineNo">100</span><a id="line.100"></a>
<span class="sourceLineNo">101</span><a id="line.101"> /*--------------------------------------------</a>
<span class="sourceLineNo">102</span><a id="line.102"> | M E T H O D S |</a>
<span class="sourceLineNo">103</span><a id="line.103"> ============================================*/</a>
<span class="sourceLineNo">104</span><a id="line.104"></a>
<span class="sourceLineNo">105</span><a id="line.105"></a>
<span class="sourceLineNo">106</span><a id="line.106"> /**</a>
<span class="sourceLineNo">107</span><a id="line.107"> * Used when initializing the default {@link LdapContextFactory}. This property is ignored if a custom</a>
<span class="sourceLineNo">108</span><a id="line.108"> * &lt;tt&gt;LdapContextFactory&lt;/tt&gt; is specified.</a>
<span class="sourceLineNo">109</span><a id="line.109"> *</a>
<span class="sourceLineNo">110</span><a id="line.110"> * @param principalSuffix the suffix.</a>
<span class="sourceLineNo">111</span><a id="line.111"> * @see DefaultLdapContextFactory#setPrincipalSuffix(String)</a>
<span class="sourceLineNo">112</span><a id="line.112"> */</a>
<span class="sourceLineNo">113</span><a id="line.113"> public void setPrincipalSuffix(String principalSuffix) {</a>
<span class="sourceLineNo">114</span><a id="line.114"> this.principalSuffix = principalSuffix;</a>
<span class="sourceLineNo">115</span><a id="line.115"> }</a>
<span class="sourceLineNo">116</span><a id="line.116"></a>
<span class="sourceLineNo">117</span><a id="line.117"> /**</a>
<span class="sourceLineNo">118</span><a id="line.118"> * Used when initializing the default {@link LdapContextFactory}. This property is ignored if a custom</a>
<span class="sourceLineNo">119</span><a id="line.119"> * &lt;tt&gt;LdapContextFactory&lt;/tt&gt; is specified.</a>
<span class="sourceLineNo">120</span><a id="line.120"> *</a>
<span class="sourceLineNo">121</span><a id="line.121"> * @param searchBase the search base.</a>
<span class="sourceLineNo">122</span><a id="line.122"> * @see DefaultLdapContextFactory#setSearchBase(String)</a>
<span class="sourceLineNo">123</span><a id="line.123"> */</a>
<span class="sourceLineNo">124</span><a id="line.124"> public void setSearchBase(String searchBase) {</a>
<span class="sourceLineNo">125</span><a id="line.125"> this.searchBase = searchBase;</a>
<span class="sourceLineNo">126</span><a id="line.126"> }</a>
<span class="sourceLineNo">127</span><a id="line.127"></a>
<span class="sourceLineNo">128</span><a id="line.128"> /**</a>
<span class="sourceLineNo">129</span><a id="line.129"> * Used when initializing the default {@link LdapContextFactory}. This property is ignored if a custom</a>
<span class="sourceLineNo">130</span><a id="line.130"> * &lt;tt&gt;LdapContextFactory&lt;/tt&gt; is specified.</a>
<span class="sourceLineNo">131</span><a id="line.131"> *</a>
<span class="sourceLineNo">132</span><a id="line.132"> * @param url the LDAP url.</a>
<span class="sourceLineNo">133</span><a id="line.133"> * @see DefaultLdapContextFactory#setUrl(String)</a>
<span class="sourceLineNo">134</span><a id="line.134"> */</a>
<span class="sourceLineNo">135</span><a id="line.135"> public void setUrl(String url) {</a>
<span class="sourceLineNo">136</span><a id="line.136"> this.url = url;</a>
<span class="sourceLineNo">137</span><a id="line.137"> }</a>
<span class="sourceLineNo">138</span><a id="line.138"></a>
<span class="sourceLineNo">139</span><a id="line.139"> /**</a>
<span class="sourceLineNo">140</span><a id="line.140"> * Used when initializing the default {@link LdapContextFactory}. This property is ignored if a custom</a>
<span class="sourceLineNo">141</span><a id="line.141"> * &lt;tt&gt;LdapContextFactory&lt;/tt&gt; is specified.</a>
<span class="sourceLineNo">142</span><a id="line.142"> *</a>
<span class="sourceLineNo">143</span><a id="line.143"> * @param systemUsername the username to use when logging into the LDAP server for authorization.</a>
<span class="sourceLineNo">144</span><a id="line.144"> * @see DefaultLdapContextFactory#setSystemUsername(String)</a>
<span class="sourceLineNo">145</span><a id="line.145"> */</a>
<span class="sourceLineNo">146</span><a id="line.146"> public void setSystemUsername(String systemUsername) {</a>
<span class="sourceLineNo">147</span><a id="line.147"> this.systemUsername = systemUsername;</a>
<span class="sourceLineNo">148</span><a id="line.148"> }</a>
<span class="sourceLineNo">149</span><a id="line.149"></a>
<span class="sourceLineNo">150</span><a id="line.150"></a>
<span class="sourceLineNo">151</span><a id="line.151"> /**</a>
<span class="sourceLineNo">152</span><a id="line.152"> * Used when initializing the default {@link LdapContextFactory}. This property is ignored if a custom</a>
<span class="sourceLineNo">153</span><a id="line.153"> * &lt;tt&gt;LdapContextFactory&lt;/tt&gt; is specified.</a>
<span class="sourceLineNo">154</span><a id="line.154"> *</a>
<span class="sourceLineNo">155</span><a id="line.155"> * @param systemPassword the password to use when logging into the LDAP server for authorization.</a>
<span class="sourceLineNo">156</span><a id="line.156"> * @see DefaultLdapContextFactory#setSystemPassword(String)</a>
<span class="sourceLineNo">157</span><a id="line.157"> */</a>
<span class="sourceLineNo">158</span><a id="line.158"> public void setSystemPassword(String systemPassword) {</a>
<span class="sourceLineNo">159</span><a id="line.159"> this.systemPassword = systemPassword;</a>
<span class="sourceLineNo">160</span><a id="line.160"> }</a>
<span class="sourceLineNo">161</span><a id="line.161"></a>
<span class="sourceLineNo">162</span><a id="line.162"></a>
<span class="sourceLineNo">163</span><a id="line.163"> /**</a>
<span class="sourceLineNo">164</span><a id="line.164"> * Configures the {@link LdapContextFactory} implementation that is used to create LDAP connections for</a>
<span class="sourceLineNo">165</span><a id="line.165"> * authentication and authorization. If this is set, the {@link LdapContextFactory} provided will be used.</a>
<span class="sourceLineNo">166</span><a id="line.166"> * Otherwise, a {@link DefaultLdapContextFactory} instance will be created based on the properties specified</a>
<span class="sourceLineNo">167</span><a id="line.167"> * in this realm.</a>
<span class="sourceLineNo">168</span><a id="line.168"> *</a>
<span class="sourceLineNo">169</span><a id="line.169"> * @param ldapContextFactory the factory to use - if not specified, a default factory will be created automatically.</a>
<span class="sourceLineNo">170</span><a id="line.170"> */</a>
<span class="sourceLineNo">171</span><a id="line.171"> public void setLdapContextFactory(LdapContextFactory ldapContextFactory) {</a>
<span class="sourceLineNo">172</span><a id="line.172"> this.ldapContextFactory = ldapContextFactory;</a>
<span class="sourceLineNo">173</span><a id="line.173"> }</a>
<span class="sourceLineNo">174</span><a id="line.174"></a>
<span class="sourceLineNo">175</span><a id="line.175"></a>
<span class="sourceLineNo">176</span><a id="line.176"> public void setSearchFilter(String searchFilter) {</a>
<span class="sourceLineNo">177</span><a id="line.177"> this.searchFilter = searchFilter;</a>
<span class="sourceLineNo">178</span><a id="line.178"> }</a>
<span class="sourceLineNo">179</span><a id="line.179"></a>
<span class="sourceLineNo">180</span><a id="line.180"> /*--------------------------------------------</a>
<span class="sourceLineNo">181</span><a id="line.181"> | M E T H O D S |</a>
<span class="sourceLineNo">182</span><a id="line.182"> ============================================*/</a>
<span class="sourceLineNo">183</span><a id="line.183"></a>
<span class="sourceLineNo">184</span><a id="line.184"> protected void onInit() {</a>
<span class="sourceLineNo">185</span><a id="line.185"> super.onInit();</a>
<span class="sourceLineNo">186</span><a id="line.186"> ensureContextFactory();</a>
<span class="sourceLineNo">187</span><a id="line.187"> }</a>
<span class="sourceLineNo">188</span><a id="line.188"></a>
<span class="sourceLineNo">189</span><a id="line.189"> private LdapContextFactory ensureContextFactory() {</a>
<span class="sourceLineNo">190</span><a id="line.190"> if (this.ldapContextFactory == null) {</a>
<span class="sourceLineNo">191</span><a id="line.191"></a>
<span class="sourceLineNo">192</span><a id="line.192"> if (log.isDebugEnabled()) {</a>
<span class="sourceLineNo">193</span><a id="line.193"> log.debug("No LdapContextFactory specified - creating a default instance.");</a>
<span class="sourceLineNo">194</span><a id="line.194"> }</a>
<span class="sourceLineNo">195</span><a id="line.195"></a>
<span class="sourceLineNo">196</span><a id="line.196"> DefaultLdapContextFactory defaultFactory = new DefaultLdapContextFactory();</a>
<span class="sourceLineNo">197</span><a id="line.197"> defaultFactory.setPrincipalSuffix(this.principalSuffix);</a>
<span class="sourceLineNo">198</span><a id="line.198"> defaultFactory.setSearchBase(this.searchBase);</a>
<span class="sourceLineNo">199</span><a id="line.199"> defaultFactory.setUrl(this.url);</a>
<span class="sourceLineNo">200</span><a id="line.200"> defaultFactory.setSystemUsername(this.systemUsername);</a>
<span class="sourceLineNo">201</span><a id="line.201"> defaultFactory.setSystemPassword(this.systemPassword);</a>
<span class="sourceLineNo">202</span><a id="line.202"></a>
<span class="sourceLineNo">203</span><a id="line.203"> this.ldapContextFactory = defaultFactory;</a>
<span class="sourceLineNo">204</span><a id="line.204"> }</a>
<span class="sourceLineNo">205</span><a id="line.205"> return this.ldapContextFactory;</a>
<span class="sourceLineNo">206</span><a id="line.206"> }</a>
<span class="sourceLineNo">207</span><a id="line.207"></a>
<span class="sourceLineNo">208</span><a id="line.208"></a>
<span class="sourceLineNo">209</span><a id="line.209"> protected AuthenticationInfo doGetAuthenticationInfo(AuthenticationToken token) throws AuthenticationException {</a>
<span class="sourceLineNo">210</span><a id="line.210"> AuthenticationInfo info;</a>
<span class="sourceLineNo">211</span><a id="line.211"> try {</a>
<span class="sourceLineNo">212</span><a id="line.212"> info = queryForAuthenticationInfo(token, ensureContextFactory());</a>
<span class="sourceLineNo">213</span><a id="line.213"> } catch (javax.naming.AuthenticationException e) {</a>
<span class="sourceLineNo">214</span><a id="line.214"> throw new AuthenticationException("LDAP authentication failed.", e);</a>
<span class="sourceLineNo">215</span><a id="line.215"> } catch (NamingException e) {</a>
<span class="sourceLineNo">216</span><a id="line.216"> String msg = "LDAP naming error while attempting to authenticate user.";</a>
<span class="sourceLineNo">217</span><a id="line.217"> throw new AuthenticationException(msg, e);</a>
<span class="sourceLineNo">218</span><a id="line.218"> }</a>
<span class="sourceLineNo">219</span><a id="line.219"></a>
<span class="sourceLineNo">220</span><a id="line.220"> return info;</a>
<span class="sourceLineNo">221</span><a id="line.221"> }</a>
<span class="sourceLineNo">222</span><a id="line.222"></a>
<span class="sourceLineNo">223</span><a id="line.223"></a>
<span class="sourceLineNo">224</span><a id="line.224"> protected AuthorizationInfo doGetAuthorizationInfo(PrincipalCollection principals) {</a>
<span class="sourceLineNo">225</span><a id="line.225"> AuthorizationInfo info;</a>
<span class="sourceLineNo">226</span><a id="line.226"> try {</a>
<span class="sourceLineNo">227</span><a id="line.227"> info = queryForAuthorizationInfo(principals, ensureContextFactory());</a>
<span class="sourceLineNo">228</span><a id="line.228"> } catch (NamingException e) {</a>
<span class="sourceLineNo">229</span><a id="line.229"> String msg = "LDAP naming error while attempting to retrieve authorization for user [" + principals + "].";</a>
<span class="sourceLineNo">230</span><a id="line.230"> throw new AuthorizationException(msg, e);</a>
<span class="sourceLineNo">231</span><a id="line.231"> }</a>
<span class="sourceLineNo">232</span><a id="line.232"></a>
<span class="sourceLineNo">233</span><a id="line.233"> return info;</a>
<span class="sourceLineNo">234</span><a id="line.234"> }</a>
<span class="sourceLineNo">235</span><a id="line.235"></a>
<span class="sourceLineNo">236</span><a id="line.236"></a>
<span class="sourceLineNo">237</span><a id="line.237"> /**</a>
<span class="sourceLineNo">238</span><a id="line.238"> * &lt;p&gt;Abstract method that should be implemented by subclasses to builds an</a>
<span class="sourceLineNo">239</span><a id="line.239"> * {@link AuthenticationInfo} object by querying the LDAP context for the</a>
<span class="sourceLineNo">240</span><a id="line.240"> * specified username.&lt;/p&gt;</a>
<span class="sourceLineNo">241</span><a id="line.241"> *</a>
<span class="sourceLineNo">242</span><a id="line.242"> * @param token the authentication token given during authentication.</a>
<span class="sourceLineNo">243</span><a id="line.243"> * @param ldapContextFactory factory used to retrieve LDAP connections.</a>
<span class="sourceLineNo">244</span><a id="line.244"> * @return an {@link AuthenticationInfo} instance containing information retrieved from the LDAP server.</a>
<span class="sourceLineNo">245</span><a id="line.245"> * @throws NamingException if any LDAP errors occur during the search.</a>
<span class="sourceLineNo">246</span><a id="line.246"> */</a>
<span class="sourceLineNo">247</span><a id="line.247"> protected abstract AuthenticationInfo queryForAuthenticationInfo(AuthenticationToken token, LdapContextFactory ldapContextFactory) throws NamingException;</a>
<span class="sourceLineNo">248</span><a id="line.248"></a>
<span class="sourceLineNo">249</span><a id="line.249"></a>
<span class="sourceLineNo">250</span><a id="line.250"> /**</a>
<span class="sourceLineNo">251</span><a id="line.251"> * &lt;p&gt;Abstract method that should be implemented by subclasses to builds an</a>
<span class="sourceLineNo">252</span><a id="line.252"> * {@link AuthorizationInfo} object by querying the LDAP context for the</a>
<span class="sourceLineNo">253</span><a id="line.253"> * specified principal.&lt;/p&gt;</a>
<span class="sourceLineNo">254</span><a id="line.254"> *</a>
<span class="sourceLineNo">255</span><a id="line.255"> * @param principal the principal of the Subject whose AuthenticationInfo should be queried from the LDAP server.</a>
<span class="sourceLineNo">256</span><a id="line.256"> * @param ldapContextFactory factory used to retrieve LDAP connections.</a>
<span class="sourceLineNo">257</span><a id="line.257"> * @return an {@link AuthorizationInfo} instance containing information retrieved from the LDAP server.</a>
<span class="sourceLineNo">258</span><a id="line.258"> * @throws NamingException if any LDAP errors occur during the search.</a>
<span class="sourceLineNo">259</span><a id="line.259"> */</a>
<span class="sourceLineNo">260</span><a id="line.260"> protected abstract AuthorizationInfo queryForAuthorizationInfo(PrincipalCollection principal, LdapContextFactory ldapContextFactory) throws NamingException;</a>
<span class="sourceLineNo">261</span><a id="line.261"></a>
<span class="sourceLineNo">262</span><a id="line.262">}</a>
</pre>
</div>
</main>
</body>
</html>