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