| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <html lang="en"> |
| <head> |
| <title>Source code</title> |
| <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> |
| </head> |
| <body> |
| <div class="sourceContainer"> |
| <pre><span class="sourceLineNo">001</span>/*<a name="line.1"></a> |
| <span class="sourceLineNo">002</span> * Licensed to the Apache Software Foundation (ASF) under one<a name="line.2"></a> |
| <span class="sourceLineNo">003</span> * or more contributor license agreements. See the NOTICE file<a name="line.3"></a> |
| <span class="sourceLineNo">004</span> * distributed with this work for additional information<a name="line.4"></a> |
| <span class="sourceLineNo">005</span> * regarding copyright ownership. The ASF licenses this file<a name="line.5"></a> |
| <span class="sourceLineNo">006</span> * to you under the Apache License, Version 2.0 (the<a name="line.6"></a> |
| <span class="sourceLineNo">007</span> * "License"); you may not use this file except in compliance<a name="line.7"></a> |
| <span class="sourceLineNo">008</span> * with the License. You may obtain a copy of the License at<a name="line.8"></a> |
| <span class="sourceLineNo">009</span> *<a name="line.9"></a> |
| <span class="sourceLineNo">010</span> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.10"></a> |
| <span class="sourceLineNo">011</span> *<a name="line.11"></a> |
| <span class="sourceLineNo">012</span> * Unless required by applicable law or agreed to in writing,<a name="line.12"></a> |
| <span class="sourceLineNo">013</span> * software distributed under the License is distributed on an<a name="line.13"></a> |
| <span class="sourceLineNo">014</span> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY<a name="line.14"></a> |
| <span class="sourceLineNo">015</span> * KIND, either express or implied. See the License for the<a name="line.15"></a> |
| <span class="sourceLineNo">016</span> * specific language governing permissions and limitations<a name="line.16"></a> |
| <span class="sourceLineNo">017</span> * under the License.<a name="line.17"></a> |
| <span class="sourceLineNo">018</span> */<a name="line.18"></a> |
| <span class="sourceLineNo">019</span>package org.apache.shiro.realm.ldap;<a name="line.19"></a> |
| <span class="sourceLineNo">020</span><a name="line.20"></a> |
| <span class="sourceLineNo">021</span>import javax.naming.NamingException;<a name="line.21"></a> |
| <span class="sourceLineNo">022</span>import javax.naming.ldap.LdapContext;<a name="line.22"></a> |
| <span class="sourceLineNo">023</span><a name="line.23"></a> |
| <span class="sourceLineNo">024</span>/**<a name="line.24"></a> |
| <span class="sourceLineNo">025</span> * Interface that encapsulates the creation of {@code LdapContext} objects that are used by {@link DefaultLdapRealm}s to<a name="line.25"></a> |
| <span class="sourceLineNo">026</span> * perform authentication attempts and query for authorization data.<a name="line.26"></a> |
| <span class="sourceLineNo">027</span> *<a name="line.27"></a> |
| <span class="sourceLineNo">028</span> * @since 0.2<a name="line.28"></a> |
| <span class="sourceLineNo">029</span> */<a name="line.29"></a> |
| <span class="sourceLineNo">030</span>public interface LdapContextFactory {<a name="line.30"></a> |
| <span class="sourceLineNo">031</span><a name="line.31"></a> |
| <span class="sourceLineNo">032</span> /**<a name="line.32"></a> |
| <span class="sourceLineNo">033</span> * Creates (or retrieves from a pool) a {@code LdapContext} connection bound using the system account, or<a name="line.33"></a> |
| <span class="sourceLineNo">034</span> * anonymously if no system account is configured.<a name="line.34"></a> |
| <span class="sourceLineNo">035</span> *<a name="line.35"></a> |
| <span class="sourceLineNo">036</span> * @return a {@code LdapContext} bound by the system account, or bound anonymously if no system account<a name="line.36"></a> |
| <span class="sourceLineNo">037</span> * is configured.<a name="line.37"></a> |
| <span class="sourceLineNo">038</span> * @throws javax.naming.NamingException if there is an error creating the context.<a name="line.38"></a> |
| <span class="sourceLineNo">039</span> */<a name="line.39"></a> |
| <span class="sourceLineNo">040</span> LdapContext getSystemLdapContext() throws NamingException;<a name="line.40"></a> |
| <span class="sourceLineNo">041</span><a name="line.41"></a> |
| <span class="sourceLineNo">042</span> /**<a name="line.42"></a> |
| <span class="sourceLineNo">043</span> * Creates (or retrieves from a pool) a {@code LdapContext} connection bound using the username and password<a name="line.43"></a> |
| <span class="sourceLineNo">044</span> * specified.<a name="line.44"></a> |
| <span class="sourceLineNo">045</span> *<a name="line.45"></a> |
| <span class="sourceLineNo">046</span> * @param username the username to use when creating the connection.<a name="line.46"></a> |
| <span class="sourceLineNo">047</span> * @param password the password to use when creating the connection.<a name="line.47"></a> |
| <span class="sourceLineNo">048</span> * @return a {@code LdapContext} bound using the given username and password.<a name="line.48"></a> |
| <span class="sourceLineNo">049</span> * @throws javax.naming.NamingException if there is an error creating the context.<a name="line.49"></a> |
| <span class="sourceLineNo">050</span> * @deprecated the {@link #getLdapContext(Object, Object)} method should be used in all cases to ensure more than<a name="line.50"></a> |
| <span class="sourceLineNo">051</span> * String principals and credentials can be used.<a name="line.51"></a> |
| <span class="sourceLineNo">052</span> */<a name="line.52"></a> |
| <span class="sourceLineNo">053</span> @Deprecated<a name="line.53"></a> |
| <span class="sourceLineNo">054</span> LdapContext getLdapContext(String username, String password) throws NamingException;<a name="line.54"></a> |
| <span class="sourceLineNo">055</span><a name="line.55"></a> |
| <span class="sourceLineNo">056</span> /**<a name="line.56"></a> |
| <span class="sourceLineNo">057</span> * Creates (or retrieves from a pool) an {@code LdapContext} connection bound using the specified principal and<a name="line.57"></a> |
| <span class="sourceLineNo">058</span> * credentials. The format of the principal and credentials are whatever is supported by the underlying<a name="line.58"></a> |
| <span class="sourceLineNo">059</span> * LDAP {@link javax.naming.spi.InitialContextFactory InitialContextFactory} implementation. The default Sun<a name="line.59"></a> |
| <span class="sourceLineNo">060</span> * (now Oracle) implementation supports<a name="line.60"></a> |
| <span class="sourceLineNo">061</span> * <a href="http://download-llnw.oracle.com/javase/tutorial/jndi/ldap/auth_mechs.html">anonymous, simple, and<a name="line.61"></a> |
| <span class="sourceLineNo">062</span> * SASL-based mechanisms</a>.<a name="line.62"></a> |
| <span class="sourceLineNo">063</span> * <p/><a name="line.63"></a> |
| <span class="sourceLineNo">064</span> * This method was added in Shiro 1.1 to address the fact that principals and credentials can be more than just<a name="line.64"></a> |
| <span class="sourceLineNo">065</span> * {@code String} user DNs and passwords for connecting to LDAP. For example, the credentials can be an<a name="line.65"></a> |
| <span class="sourceLineNo">066</span> * {@code X.509} certificate.<a name="line.66"></a> |
| <span class="sourceLineNo">067</span> *<a name="line.67"></a> |
| <span class="sourceLineNo">068</span> * @param principal the principal to use when acquiring a connection to the LDAP directory<a name="line.68"></a> |
| <span class="sourceLineNo">069</span> * @param credentials the credentials (password, X.509 certificate, etc) to use when acquiring a connection to the<a name="line.69"></a> |
| <span class="sourceLineNo">070</span> * LDAP directory<a name="line.70"></a> |
| <span class="sourceLineNo">071</span> * @return the acquired {@code LdapContext} connection bound using the specified principal and credentials.<a name="line.71"></a> |
| <span class="sourceLineNo">072</span> * @throws NamingException if unable to acquire a connection.<a name="line.72"></a> |
| <span class="sourceLineNo">073</span> * @since 1.1<a name="line.73"></a> |
| <span class="sourceLineNo">074</span> */<a name="line.74"></a> |
| <span class="sourceLineNo">075</span> LdapContext getLdapContext(Object principal, Object credentials) throws NamingException;<a name="line.75"></a> |
| <span class="sourceLineNo">076</span> <a name="line.76"></a> |
| <span class="sourceLineNo">077</span>}<a name="line.77"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |
