| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (version 1.7.0_21) on Thu May 30 14:51:26 PDT 2013 --> |
| <meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> |
| <title>DefaultLdapContextFactory (Apache Shiro 1.2.1 API)</title> |
| <meta name="date" content="2013-05-30"> |
| <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="DefaultLdapContextFactory (Apache Shiro 1.2.1 API)"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar_top"> |
| <!-- --> |
| </a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/DefaultLdapContextFactory.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../org/apache/shiro/realm/ldap/AbstractLdapRealm.html" title="class in org.apache.shiro.realm.ldap"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/shiro/realm/ldap/JndiLdapContextFactory.html" title="class in org.apache.shiro.realm.ldap"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/shiro/realm/ldap/DefaultLdapContextFactory.html" target="_top">Frames</a></li> |
| <li><a href="DefaultLdapContextFactory.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li><a href="#field_summary">Field</a> | </li> |
| <li><a href="#constructor_summary">Constr</a> | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field_detail">Field</a> | </li> |
| <li><a href="#constructor_detail">Constr</a> | </li> |
| <li><a href="#method_detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip-navbar_top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.apache.shiro.realm.ldap</div> |
| <h2 title="Class DefaultLdapContextFactory" class="title">Class DefaultLdapContextFactory</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.shiro.realm.ldap.DefaultLdapContextFactory</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><a href="../../../../../org/apache/shiro/realm/ldap/LdapContextFactory.html" title="interface in org.apache.shiro.realm.ldap">LdapContextFactory</a></dd> |
| </dl> |
| <hr> |
| <div class="block"><strong>Deprecated.</strong> |
| <div class="block"><i>replaced by the <a href="../../../../../org/apache/shiro/realm/ldap/JndiLdapContextFactory.html" title="class in org.apache.shiro.realm.ldap"><code>JndiLdapContextFactory</code></a> implementation. This implementation will be removed |
| prior to Shiro 2.0</i></div> |
| </div> |
| <br> |
| <pre><a href="http://java.sun.com/javase/6/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a> |
| public class <a href="../../../../../src-html/org/apache/shiro/realm/ldap/DefaultLdapContextFactory.html#line.46">DefaultLdapContextFactory</a> |
| extends <a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> |
| implements <a href="../../../../../org/apache/shiro/realm/ldap/LdapContextFactory.html" title="interface in org.apache.shiro.realm.ldap">LdapContextFactory</a></pre> |
| <div class="block"><p>Default implementation of <a href="../../../../../org/apache/shiro/realm/ldap/LdapContextFactory.html" title="interface in org.apache.shiro.realm.ldap"><code>LdapContextFactory</code></a> that can be configured or extended to |
| customize the way <a href="http://java.sun.com/javase/6/docs/api/javax/naming/ldap/LdapContext.html?is-external=true" title="class or interface in javax.naming.ldap"><code>LdapContext</code></a> objects are retrieved.</p> |
| <p/> |
| <p>This implementation of <a href="../../../../../org/apache/shiro/realm/ldap/LdapContextFactory.html" title="interface in org.apache.shiro.realm.ldap"><code>LdapContextFactory</code></a> is used by the <a href="../../../../../org/apache/shiro/realm/ldap/AbstractLdapRealm.html" title="class in org.apache.shiro.realm.ldap"><code>AbstractLdapRealm</code></a> if a |
| factory is not explictly configured.</p> |
| <p/> |
| <p>Connection pooling is enabled by default on this factory, but can be disabled using the |
| <a href="../../../../../org/apache/shiro/realm/ldap/DefaultLdapContextFactory.html#usePooling"><code>usePooling</code></a> property.</p></div> |
| <dl><dt><span class="strong">Since:</span></dt> |
| <dd>0.2</dd></dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field_summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> |
| <caption><span>Fields</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Field and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected <a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/shiro/realm/ldap/DefaultLdapContextFactory.html#authentication">authentication</a></strong></code> |
| <div class="block"><strong>Deprecated.</strong> </div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected <a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/shiro/realm/ldap/DefaultLdapContextFactory.html#contextFactoryClassName">contextFactoryClassName</a></strong></code> |
| <div class="block"><strong>Deprecated.</strong> </div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected <a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/shiro/realm/ldap/DefaultLdapContextFactory.html#principalSuffix">principalSuffix</a></strong></code> |
| <div class="block"><strong>Deprecated.</strong> </div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected <a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/shiro/realm/ldap/DefaultLdapContextFactory.html#referral">referral</a></strong></code> |
| <div class="block"><strong>Deprecated.</strong> </div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected <a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/shiro/realm/ldap/DefaultLdapContextFactory.html#searchBase">searchBase</a></strong></code> |
| <div class="block"><strong>Deprecated.</strong> </div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected static <a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/shiro/realm/ldap/DefaultLdapContextFactory.html#SUN_CONNECTION_POOLING_PROPERTY">SUN_CONNECTION_POOLING_PROPERTY</a></strong></code> |
| <div class="block"><strong>Deprecated.</strong> </div> |
| <div class="block">The Sun LDAP property used to enable connection pooling.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected <a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/shiro/realm/ldap/DefaultLdapContextFactory.html#systemPassword">systemPassword</a></strong></code> |
| <div class="block"><strong>Deprecated.</strong> </div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected <a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/shiro/realm/ldap/DefaultLdapContextFactory.html#systemUsername">systemUsername</a></strong></code> |
| <div class="block"><strong>Deprecated.</strong> </div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected <a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/shiro/realm/ldap/DefaultLdapContextFactory.html#url">url</a></strong></code> |
| <div class="block"><strong>Deprecated.</strong> </div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor_summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colOne" scope="col">Constructor and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><strong><a href="../../../../../org/apache/shiro/realm/ldap/DefaultLdapContextFactory.html#DefaultLdapContextFactory()">DefaultLdapContextFactory</a></strong>()</code> |
| <div class="block"><strong>Deprecated.</strong> </div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method_summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span>Methods</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="http://java.sun.com/javase/6/docs/api/javax/naming/ldap/LdapContext.html?is-external=true" title="class or interface in javax.naming.ldap">LdapContext</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/shiro/realm/ldap/DefaultLdapContextFactory.html#getLdapContext(java.lang.Object, java.lang.Object)">getLdapContext</a></strong>(<a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> principal, |
| <a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> credentials)</code> |
| <div class="block"><strong>Deprecated.</strong> </div> |
| <div class="block">Creates (or retrieves from a pool) an <code>LdapContext</code> connection bound using the specified principal and |
| credentials.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="http://java.sun.com/javase/6/docs/api/javax/naming/ldap/LdapContext.html?is-external=true" title="class or interface in javax.naming.ldap">LdapContext</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/shiro/realm/ldap/DefaultLdapContextFactory.html#getLdapContext(java.lang.String, java.lang.String)">getLdapContext</a></strong>(<a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> username, |
| <a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> password)</code> |
| <div class="block"><strong>Deprecated.</strong> |
| <div class="block"><i>the <a href="../../../../../org/apache/shiro/realm/ldap/DefaultLdapContextFactory.html#getLdapContext(java.lang.Object, java.lang.Object)"><code>getLdapContext(Object, Object)</code></a> method should be used in all cases to ensure more than |
| String principals and credentials can be used. Shiro no longer calls this method - it will be |
| removed before the 2.0 release.</i></div> |
| </div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="http://java.sun.com/javase/6/docs/api/javax/naming/ldap/LdapContext.html?is-external=true" title="class or interface in javax.naming.ldap">LdapContext</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/shiro/realm/ldap/DefaultLdapContextFactory.html#getSystemLdapContext()">getSystemLdapContext</a></strong>()</code> |
| <div class="block"><strong>Deprecated.</strong> </div> |
| <div class="block">Creates (or retrieves from a pool) a <code>LdapContext</code> connection bound using the system account, or |
| anonymously if no system account is configured.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/shiro/realm/ldap/DefaultLdapContextFactory.html#setAdditionalEnvironment(java.util.Map)">setAdditionalEnvironment</a></strong>(<a href="http://java.sun.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> additionalEnvironment)</code> |
| <div class="block"><strong>Deprecated.</strong> </div> |
| <div class="block">These entries are added to the environment map before initializing the LDAP context.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/shiro/realm/ldap/DefaultLdapContextFactory.html#setAuthentication(java.lang.String)">setAuthentication</a></strong>(<a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> authentication)</code> |
| <div class="block"><strong>Deprecated.</strong> </div> |
| <div class="block">Sets the type of LDAP authentication to perform when connecting to the LDAP server.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/shiro/realm/ldap/DefaultLdapContextFactory.html#setContextFactoryClassName(java.lang.String)">setContextFactoryClassName</a></strong>(<a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> contextFactoryClassName)</code> |
| <div class="block"><strong>Deprecated.</strong> </div> |
| <div class="block">The context factory to use.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/shiro/realm/ldap/DefaultLdapContextFactory.html#setPrincipalSuffix(java.lang.String)">setPrincipalSuffix</a></strong>(<a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> principalSuffix)</code> |
| <div class="block"><strong>Deprecated.</strong> </div> |
| <div class="block">A suffix appended to the username.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/shiro/realm/ldap/DefaultLdapContextFactory.html#setReferral(java.lang.String)">setReferral</a></strong>(<a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> referral)</code> |
| <div class="block"><strong>Deprecated.</strong> </div> |
| <div class="block">Sets the LDAP referral property.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/shiro/realm/ldap/DefaultLdapContextFactory.html#setSearchBase(java.lang.String)">setSearchBase</a></strong>(<a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> searchBase)</code> |
| <div class="block"><strong>Deprecated.</strong> |
| <div class="block"><i>this attribute existed, but was never used in Shiro 1.x. It will be removed prior to Shiro 2.0.</i></div> |
| </div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/shiro/realm/ldap/DefaultLdapContextFactory.html#setSystemPassword(java.lang.String)">setSystemPassword</a></strong>(<a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> systemPassword)</code> |
| <div class="block"><strong>Deprecated.</strong> </div> |
| <div class="block">The system password that will be used when connecting to the LDAP server to retrieve authorization |
| information about a user.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/shiro/realm/ldap/DefaultLdapContextFactory.html#setSystemUsername(java.lang.String)">setSystemUsername</a></strong>(<a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> systemUsername)</code> |
| <div class="block"><strong>Deprecated.</strong> </div> |
| <div class="block">The system username that will be used when connecting to the LDAP server to retrieve authorization |
| information about a user.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/shiro/realm/ldap/DefaultLdapContextFactory.html#setUrl(java.lang.String)">setUrl</a></strong>(<a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> url)</code> |
| <div class="block"><strong>Deprecated.</strong> </div> |
| <div class="block">The LDAP url to connect to.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/shiro/realm/ldap/DefaultLdapContextFactory.html#setUsePooling(boolean)">setUsePooling</a></strong>(boolean usePooling)</code> |
| <div class="block"><strong>Deprecated.</strong> </div> |
| <div class="block">Determines whether or not LdapContext pooling is enabled for connections made using the system |
| user account.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.<a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> |
| <code><a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field_detail"> |
| <!-- --> |
| </a> |
| <h3>Field Detail</h3> |
| <a name="SUN_CONNECTION_POOLING_PROPERTY"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>SUN_CONNECTION_POOLING_PROPERTY</h4> |
| <pre>protected static final <a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/shiro/realm/ldap/DefaultLdapContextFactory.html#line.57">SUN_CONNECTION_POOLING_PROPERTY</a></pre> |
| <div class="block"><span class="strong">Deprecated.</span> </div> |
| <div class="block">The Sun LDAP property used to enable connection pooling. This is used in the default implementation |
| to enable LDAP connection pooling.</div> |
| <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.shiro.realm.ldap.DefaultLdapContextFactory.SUN_CONNECTION_POOLING_PROPERTY">Constant Field Values</a></dd></dl> |
| </li> |
| </ul> |
| <a name="authentication"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>authentication</h4> |
| <pre>protected <a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/shiro/realm/ldap/DefaultLdapContextFactory.html#line.65">authentication</a></pre> |
| <div class="block"><span class="strong">Deprecated.</span> </div> |
| </li> |
| </ul> |
| <a name="principalSuffix"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>principalSuffix</h4> |
| <pre>protected <a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/shiro/realm/ldap/DefaultLdapContextFactory.html#line.67">principalSuffix</a></pre> |
| <div class="block"><span class="strong">Deprecated.</span> </div> |
| </li> |
| </ul> |
| <a name="searchBase"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>searchBase</h4> |
| <pre>protected <a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/shiro/realm/ldap/DefaultLdapContextFactory.html#line.69">searchBase</a></pre> |
| <div class="block"><span class="strong">Deprecated.</span> </div> |
| </li> |
| </ul> |
| <a name="contextFactoryClassName"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>contextFactoryClassName</h4> |
| <pre>protected <a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/shiro/realm/ldap/DefaultLdapContextFactory.html#line.71">contextFactoryClassName</a></pre> |
| <div class="block"><span class="strong">Deprecated.</span> </div> |
| </li> |
| </ul> |
| <a name="url"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>url</h4> |
| <pre>protected <a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/shiro/realm/ldap/DefaultLdapContextFactory.html#line.73">url</a></pre> |
| <div class="block"><span class="strong">Deprecated.</span> </div> |
| </li> |
| </ul> |
| <a name="referral"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>referral</h4> |
| <pre>protected <a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/shiro/realm/ldap/DefaultLdapContextFactory.html#line.75">referral</a></pre> |
| <div class="block"><span class="strong">Deprecated.</span> </div> |
| </li> |
| </ul> |
| <a name="systemUsername"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>systemUsername</h4> |
| <pre>protected <a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/shiro/realm/ldap/DefaultLdapContextFactory.html#line.77">systemUsername</a></pre> |
| <div class="block"><span class="strong">Deprecated.</span> </div> |
| </li> |
| </ul> |
| <a name="systemPassword"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>systemPassword</h4> |
| <pre>protected <a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/shiro/realm/ldap/DefaultLdapContextFactory.html#line.79">systemPassword</a></pre> |
| <div class="block"><span class="strong">Deprecated.</span> </div> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor_detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="DefaultLdapContextFactory()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>DefaultLdapContextFactory</h4> |
| <pre>public <a href="../../../../../src-html/org/apache/shiro/realm/ldap/DefaultLdapContextFactory.html#line.46">DefaultLdapContextFactory</a>()</pre> |
| <div class="block"><span class="strong">Deprecated.</span> </div> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method_detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="setAuthentication(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setAuthentication</h4> |
| <pre>public void <a href="../../../../../src-html/org/apache/shiro/realm/ldap/DefaultLdapContextFactory.html#line.98">setAuthentication</a>(<a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> authentication)</pre> |
| <div class="block"><span class="strong">Deprecated.</span> </div> |
| <div class="block">Sets the type of LDAP authentication to perform when connecting to the LDAP server. Defaults to "simple"</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>authentication</code> - the type of LDAP authentication to perform.</dd></dl> |
| </li> |
| </ul> |
| <a name="setPrincipalSuffix(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setPrincipalSuffix</h4> |
| <pre>public void <a href="../../../../../src-html/org/apache/shiro/realm/ldap/DefaultLdapContextFactory.html#line.108">setPrincipalSuffix</a>(<a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> principalSuffix)</pre> |
| <div class="block"><span class="strong">Deprecated.</span> </div> |
| <div class="block">A suffix appended to the username. This is typically for |
| domain names. (e.g. "@MyDomain.local")</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>principalSuffix</code> - the suffix.</dd></dl> |
| </li> |
| </ul> |
| <a name="setSearchBase(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setSearchBase</h4> |
| <pre><a href="http://java.sun.com/javase/6/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a> |
| public void <a href="../../../../../src-html/org/apache/shiro/realm/ldap/DefaultLdapContextFactory.html#line.120">setSearchBase</a>(<a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> searchBase)</pre> |
| <div class="block"><span class="strong">Deprecated.</span> <i>this attribute existed, but was never used in Shiro 1.x. It will be removed prior to Shiro 2.0.</i></div> |
| <div class="block">The search base for the search to perform in the LDAP server. |
| (e.g. OU=OrganizationName,DC=MyDomain,DC=local )</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>searchBase</code> - the search base.</dd></dl> |
| </li> |
| </ul> |
| <a name="setContextFactoryClassName(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setContextFactoryClassName</h4> |
| <pre>public void <a href="../../../../../src-html/org/apache/shiro/realm/ldap/DefaultLdapContextFactory.html#line.130">setContextFactoryClassName</a>(<a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> contextFactoryClassName)</pre> |
| <div class="block"><span class="strong">Deprecated.</span> </div> |
| <div class="block">The context factory to use. This defaults to the SUN LDAP JNDI implementation |
| but can be overridden to use custom LDAP factories.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>contextFactoryClassName</code> - the context factory that should be used.</dd></dl> |
| </li> |
| </ul> |
| <a name="setUrl(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setUrl</h4> |
| <pre>public void <a href="../../../../../src-html/org/apache/shiro/realm/ldap/DefaultLdapContextFactory.html#line.139">setUrl</a>(<a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> url)</pre> |
| <div class="block"><span class="strong">Deprecated.</span> </div> |
| <div class="block">The LDAP url to connect to. (e.g. ldap://<ldapDirectoryHostname>:<port>)</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>url</code> - the LDAP url.</dd></dl> |
| </li> |
| </ul> |
| <a name="setReferral(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setReferral</h4> |
| <pre>public void <a href="../../../../../src-html/org/apache/shiro/realm/ldap/DefaultLdapContextFactory.html#line.148">setReferral</a>(<a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> referral)</pre> |
| <div class="block"><span class="strong">Deprecated.</span> </div> |
| <div class="block">Sets the LDAP referral property. Defaults to "follow"</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>referral</code> - the referral property.</dd></dl> |
| </li> |
| </ul> |
| <a name="setSystemUsername(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setSystemUsername</h4> |
| <pre>public void <a href="../../../../../src-html/org/apache/shiro/realm/ldap/DefaultLdapContextFactory.html#line.159">setSystemUsername</a>(<a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> systemUsername)</pre> |
| <div class="block"><span class="strong">Deprecated.</span> </div> |
| <div class="block">The system username that will be used when connecting to the LDAP server to retrieve authorization |
| information about a user. This must be specified for LDAP authorization to work, but is not required for |
| only authentication.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>systemUsername</code> - the username to use when logging into the LDAP server for authorization.</dd></dl> |
| </li> |
| </ul> |
| <a name="setSystemPassword(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setSystemPassword</h4> |
| <pre>public void <a href="../../../../../src-html/org/apache/shiro/realm/ldap/DefaultLdapContextFactory.html#line.171">setSystemPassword</a>(<a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> systemPassword)</pre> |
| <div class="block"><span class="strong">Deprecated.</span> </div> |
| <div class="block">The system password that will be used when connecting to the LDAP server to retrieve authorization |
| information about a user. This must be specified for LDAP authorization to work, but is not required for |
| only authentication.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>systemPassword</code> - the password to use when logging into the LDAP server for authorization.</dd></dl> |
| </li> |
| </ul> |
| <a name="setUsePooling(boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setUsePooling</h4> |
| <pre>public void <a href="../../../../../src-html/org/apache/shiro/realm/ldap/DefaultLdapContextFactory.html#line.185">setUsePooling</a>(boolean usePooling)</pre> |
| <div class="block"><span class="strong">Deprecated.</span> </div> |
| <div class="block">Determines whether or not LdapContext pooling is enabled for connections made using the system |
| user account. In the default implementation, this simply |
| sets the <tt>com.sun.jndi.ldap.connect.pool</tt> property in the LDAP context environment. If you use an |
| LDAP Context Factory that is not Sun's default implementation, you will need to override the |
| default behavior to use this setting in whatever way your underlying LDAP ContextFactory |
| supports. By default, pooling is enabled.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>usePooling</code> - true to enable pooling, or false to disable it.</dd></dl> |
| </li> |
| </ul> |
| <a name="setAdditionalEnvironment(java.util.Map)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setAdditionalEnvironment</h4> |
| <pre>public void <a href="../../../../../src-html/org/apache/shiro/realm/ldap/DefaultLdapContextFactory.html#line.194">setAdditionalEnvironment</a>(<a href="http://java.sun.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> additionalEnvironment)</pre> |
| <div class="block"><span class="strong">Deprecated.</span> </div> |
| <div class="block">These entries are added to the environment map before initializing the LDAP context.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>additionalEnvironment</code> - additional environment entries to be configured on the LDAP context.</dd></dl> |
| </li> |
| </ul> |
| <a name="getSystemLdapContext()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSystemLdapContext</h4> |
| <pre>public <a href="http://java.sun.com/javase/6/docs/api/javax/naming/ldap/LdapContext.html?is-external=true" title="class or interface in javax.naming.ldap">LdapContext</a> <a href="../../../../../src-html/org/apache/shiro/realm/ldap/DefaultLdapContextFactory.html#line.201">getSystemLdapContext</a>() |
| throws <a href="http://java.sun.com/javase/6/docs/api/javax/naming/NamingException.html?is-external=true" title="class or interface in javax.naming">NamingException</a></pre> |
| <div class="block"><span class="strong">Deprecated.</span> </div> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../../org/apache/shiro/realm/ldap/LdapContextFactory.html#getSystemLdapContext()">LdapContextFactory</a></code></strong></div> |
| <div class="block">Creates (or retrieves from a pool) a <code>LdapContext</code> connection bound using the system account, or |
| anonymously if no system account is configured.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../../org/apache/shiro/realm/ldap/LdapContextFactory.html#getSystemLdapContext()">getSystemLdapContext</a></code> in interface <code><a href="../../../../../org/apache/shiro/realm/ldap/LdapContextFactory.html" title="interface in org.apache.shiro.realm.ldap">LdapContextFactory</a></code></dd> |
| <dt><span class="strong">Returns:</span></dt><dd>a <code>LdapContext</code> bound by the system account, or bound anonymously if no system account |
| is configured.</dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="http://java.sun.com/javase/6/docs/api/javax/naming/NamingException.html?is-external=true" title="class or interface in javax.naming">NamingException</a></code> - if there is an error creating the context.</dd></dl> |
| </li> |
| </ul> |
| <a name="getLdapContext(java.lang.String, java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getLdapContext</h4> |
| <pre><a href="http://java.sun.com/javase/6/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a> |
| public <a href="http://java.sun.com/javase/6/docs/api/javax/naming/ldap/LdapContext.html?is-external=true" title="class or interface in javax.naming.ldap">LdapContext</a> <a href="../../../../../src-html/org/apache/shiro/realm/ldap/DefaultLdapContextFactory.html#line.217">getLdapContext</a>(<a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> username, |
| <a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> password) |
| throws <a href="http://java.sun.com/javase/6/docs/api/javax/naming/NamingException.html?is-external=true" title="class or interface in javax.naming">NamingException</a></pre> |
| <div class="block"><span class="strong">Deprecated.</span> <i>the <a href="../../../../../org/apache/shiro/realm/ldap/DefaultLdapContextFactory.html#getLdapContext(java.lang.Object, java.lang.Object)"><code>getLdapContext(Object, Object)</code></a> method should be used in all cases to ensure more than |
| String principals and credentials can be used. Shiro no longer calls this method - it will be |
| removed before the 2.0 release.</i></div> |
| <div class="block">Deprecated - use <a href="../../../../../org/apache/shiro/realm/ldap/DefaultLdapContextFactory.html#getLdapContext(java.lang.Object, java.lang.Object)"><code>getLdapContext(Object, Object)</code></a> instead. This will be removed before Apache Shiro 2.0.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../../org/apache/shiro/realm/ldap/LdapContextFactory.html#getLdapContext(java.lang.String, java.lang.String)">getLdapContext</a></code> in interface <code><a href="../../../../../org/apache/shiro/realm/ldap/LdapContextFactory.html" title="interface in org.apache.shiro.realm.ldap">LdapContextFactory</a></code></dd> |
| <dt><span class="strong">Parameters:</span></dt><dd><code>username</code> - the username to use when creating the connection.</dd><dd><code>password</code> - the password to use when creating the connection.</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>a <code>LdapContext</code> bound using the given username and password.</dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="http://java.sun.com/javase/6/docs/api/javax/naming/NamingException.html?is-external=true" title="class or interface in javax.naming">NamingException</a></code> - if there is an error creating the context.</dd></dl> |
| </li> |
| </ul> |
| <a name="getLdapContext(java.lang.Object, java.lang.Object)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getLdapContext</h4> |
| <pre>public <a href="http://java.sun.com/javase/6/docs/api/javax/naming/ldap/LdapContext.html?is-external=true" title="class or interface in javax.naming.ldap">LdapContext</a> <a href="../../../../../src-html/org/apache/shiro/realm/ldap/DefaultLdapContextFactory.html#line.224">getLdapContext</a>(<a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> principal, |
| <a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> credentials) |
| throws <a href="http://java.sun.com/javase/6/docs/api/javax/naming/NamingException.html?is-external=true" title="class or interface in javax.naming">NamingException</a></pre> |
| <div class="block"><span class="strong">Deprecated.</span> </div> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../../org/apache/shiro/realm/ldap/LdapContextFactory.html#getLdapContext(java.lang.Object, java.lang.Object)">LdapContextFactory</a></code></strong></div> |
| <div class="block">Creates (or retrieves from a pool) an <code>LdapContext</code> connection bound using the specified principal and |
| credentials. The format of the principal and credentials are whatever is supported by the underlying |
| LDAP <a href="http://java.sun.com/javase/6/docs/api/javax/naming/spi/InitialContextFactory.html?is-external=true" title="class or interface in javax.naming.spi"><code>InitialContextFactory</code></a> implementation. The default Sun |
| (now Oracle) implementation supports |
| <a href="http://download-llnw.oracle.com/javase/tutorial/jndi/ldap/auth_mechs.html">anonymous, simple, and |
| SASL-based mechanisms</a>. |
| <p/> |
| This method was added in Shiro 1.1 to address the fact that principals and credentials can be more than just |
| <code>String</code> user DNs and passwords for connecting to LDAP. For example, the credentials can be an |
| <code>X.509</code> certificate.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../../org/apache/shiro/realm/ldap/LdapContextFactory.html#getLdapContext(java.lang.Object, java.lang.Object)">getLdapContext</a></code> in interface <code><a href="../../../../../org/apache/shiro/realm/ldap/LdapContextFactory.html" title="interface in org.apache.shiro.realm.ldap">LdapContextFactory</a></code></dd> |
| <dt><span class="strong">Parameters:</span></dt><dd><code>principal</code> - the principal to use when acquiring a connection to the LDAP directory</dd><dd><code>credentials</code> - the credentials (password, X.509 certificate, etc) to use when acquiring a connection to the |
| LDAP directory</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>the acquired <code>LdapContext</code> connection bound using the specified principal and credentials.</dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="http://java.sun.com/javase/6/docs/api/javax/naming/NamingException.html?is-external=true" title="class or interface in javax.naming">NamingException</a></code> - if unable to acquire a connection.</dd></dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar_bottom"> |
| <!-- --> |
| </a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/DefaultLdapContextFactory.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../org/apache/shiro/realm/ldap/AbstractLdapRealm.html" title="class in org.apache.shiro.realm.ldap"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/shiro/realm/ldap/JndiLdapContextFactory.html" title="class in org.apache.shiro.realm.ldap"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/shiro/realm/ldap/DefaultLdapContextFactory.html" target="_top">Frames</a></li> |
| <li><a href="DefaultLdapContextFactory.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li><a href="#field_summary">Field</a> | </li> |
| <li><a href="#constructor_summary">Constr</a> | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field_detail">Field</a> | </li> |
| <li><a href="#constructor_detail">Constr</a> | </li> |
| <li><a href="#method_detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip-navbar_bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small>Copyright © 2004-2013 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.</small></p> |
| </body> |
| </html> |
| |