| <!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 javax.naming.NamingException;</a> |
| <span class="sourceLineNo">022</span><a id="line.22">import javax.naming.ldap.LdapContext;</a> |
| <span class="sourceLineNo">023</span><a id="line.23"></a> |
| <span class="sourceLineNo">024</span><a id="line.24">/**</a> |
| <span class="sourceLineNo">025</span><a id="line.25"> * Interface that encapsulates the creation of {@code LdapContext} objects that are used by {@link DefaultLdapRealm}s to</a> |
| <span class="sourceLineNo">026</span><a id="line.26"> * perform authentication attempts and query for authorization data.</a> |
| <span class="sourceLineNo">027</span><a id="line.27"> *</a> |
| <span class="sourceLineNo">028</span><a id="line.28"> * @since 0.2</a> |
| <span class="sourceLineNo">029</span><a id="line.29"> */</a> |
| <span class="sourceLineNo">030</span><a id="line.30">public interface LdapContextFactory {</a> |
| <span class="sourceLineNo">031</span><a id="line.31"></a> |
| <span class="sourceLineNo">032</span><a id="line.32"> /**</a> |
| <span class="sourceLineNo">033</span><a id="line.33"> * Creates (or retrieves from a pool) a {@code LdapContext} connection bound using the system account, or</a> |
| <span class="sourceLineNo">034</span><a id="line.34"> * anonymously if no system account is configured.</a> |
| <span class="sourceLineNo">035</span><a id="line.35"> *</a> |
| <span class="sourceLineNo">036</span><a id="line.36"> * @return a {@code LdapContext} bound by the system account, or bound anonymously if no system account</a> |
| <span class="sourceLineNo">037</span><a id="line.37"> * is configured.</a> |
| <span class="sourceLineNo">038</span><a id="line.38"> * @throws javax.naming.NamingException if there is an error creating the context.</a> |
| <span class="sourceLineNo">039</span><a id="line.39"> */</a> |
| <span class="sourceLineNo">040</span><a id="line.40"> LdapContext getSystemLdapContext() throws NamingException;</a> |
| <span class="sourceLineNo">041</span><a id="line.41"></a> |
| <span class="sourceLineNo">042</span><a id="line.42"> /**</a> |
| <span class="sourceLineNo">043</span><a id="line.43"> * Creates (or retrieves from a pool) a {@code LdapContext} connection bound using the username and password</a> |
| <span class="sourceLineNo">044</span><a id="line.44"> * specified.</a> |
| <span class="sourceLineNo">045</span><a id="line.45"> *</a> |
| <span class="sourceLineNo">046</span><a id="line.46"> * @param username the username to use when creating the connection.</a> |
| <span class="sourceLineNo">047</span><a id="line.47"> * @param password the password to use when creating the connection.</a> |
| <span class="sourceLineNo">048</span><a id="line.48"> * @return a {@code LdapContext} bound using the given username and password.</a> |
| <span class="sourceLineNo">049</span><a id="line.49"> * @throws javax.naming.NamingException if there is an error creating the context.</a> |
| <span class="sourceLineNo">050</span><a id="line.50"> * @deprecated the {@link #getLdapContext(Object, Object)} method should be used in all cases to ensure more than</a> |
| <span class="sourceLineNo">051</span><a id="line.51"> * String principals and credentials can be used.</a> |
| <span class="sourceLineNo">052</span><a id="line.52"> */</a> |
| <span class="sourceLineNo">053</span><a id="line.53"> @Deprecated</a> |
| <span class="sourceLineNo">054</span><a id="line.54"> LdapContext getLdapContext(String username, String password) throws NamingException;</a> |
| <span class="sourceLineNo">055</span><a id="line.55"></a> |
| <span class="sourceLineNo">056</span><a id="line.56"> /**</a> |
| <span class="sourceLineNo">057</span><a id="line.57"> * Creates (or retrieves from a pool) an {@code LdapContext} connection bound using the specified principal and</a> |
| <span class="sourceLineNo">058</span><a id="line.58"> * credentials. The format of the principal and credentials are whatever is supported by the underlying</a> |
| <span class="sourceLineNo">059</span><a id="line.59"> * LDAP {@link javax.naming.spi.InitialContextFactory InitialContextFactory} implementation. The default Sun</a> |
| <span class="sourceLineNo">060</span><a id="line.60"> * (now Oracle) implementation supports</a> |
| <span class="sourceLineNo">061</span><a id="line.61"> * <a href="http://download-llnw.oracle.com/javase/tutorial/jndi/ldap/auth_mechs.html">anonymous, simple, and</a> |
| <span class="sourceLineNo">062</span><a id="line.62"> * SASL-based mechanisms</a>.</a> |
| <span class="sourceLineNo">063</span><a id="line.63"> * <p/></a> |
| <span class="sourceLineNo">064</span><a id="line.64"> * This method was added in Shiro 1.1 to address the fact that principals and credentials can be more than just</a> |
| <span class="sourceLineNo">065</span><a id="line.65"> * {@code String} user DNs and passwords for connecting to LDAP. For example, the credentials can be an</a> |
| <span class="sourceLineNo">066</span><a id="line.66"> * {@code X.509} certificate.</a> |
| <span class="sourceLineNo">067</span><a id="line.67"> *</a> |
| <span class="sourceLineNo">068</span><a id="line.68"> * @param principal the principal to use when acquiring a connection to the LDAP directory</a> |
| <span class="sourceLineNo">069</span><a id="line.69"> * @param credentials the credentials (password, X.509 certificate, etc) to use when acquiring a connection to the</a> |
| <span class="sourceLineNo">070</span><a id="line.70"> * LDAP directory</a> |
| <span class="sourceLineNo">071</span><a id="line.71"> * @return the acquired {@code LdapContext} connection bound using the specified principal and credentials.</a> |
| <span class="sourceLineNo">072</span><a id="line.72"> * @throws NamingException if unable to acquire a connection.</a> |
| <span class="sourceLineNo">073</span><a id="line.73"> * @since 1.1</a> |
| <span class="sourceLineNo">074</span><a id="line.74"> */</a> |
| <span class="sourceLineNo">075</span><a id="line.75"> LdapContext getLdapContext(Object principal, Object credentials) throws NamingException;</a> |
| <span class="sourceLineNo">076</span><a id="line.76"> </a> |
| <span class="sourceLineNo">077</span><a id="line.77">}</a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </main> |
| </body> |
| </html> |
