| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!--NewPage--> |
| <HTML> |
| <HEAD> |
| <!-- Generated by javadoc (build 1.6.0_65) on Tue Feb 25 18:15:49 EST 2014 --> |
| <META http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <TITLE> |
| DefaultLdapContextFactory (Apache Shiro 1.2.3 API) |
| </TITLE> |
| |
| <META NAME="date" CONTENT="2014-02-25"> |
| |
| <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style"> |
| |
| <SCRIPT type="text/javascript"> |
| function windowTitle() |
| { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="DefaultLdapContextFactory (Apache Shiro 1.2.3 API)"; |
| } |
| } |
| </SCRIPT> |
| <NOSCRIPT> |
| </NOSCRIPT> |
| |
| </HEAD> |
| |
| <BODY BGCOLOR="white" onload="windowTitle();"> |
| <HR> |
| |
| |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <A NAME="navbar_top"><!-- --></A> |
| <A HREF="#skip-navbar_top" title="Skip navigation links"></A> |
| <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> |
| <TR> |
| <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> |
| <A NAME="navbar_top_firstrow"><!-- --></A> |
| <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> |
| <TR ALIGN="center" VALIGN="top"> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> |
| <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/DefaultLdapContextFactory.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> |
| </TR> |
| </TABLE> |
| </TD> |
| <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> |
| </EM> |
| </TD> |
| </TR> |
| |
| <TR> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../../org/apache/shiro/realm/ldap/AbstractLdapRealm.html" title="class in org.apache.shiro.realm.ldap"><B>PREV CLASS</B></A> |
| <A HREF="../../../../../org/apache/shiro/realm/ldap/JndiLdapContextFactory.html" title="class in org.apache.shiro.realm.ldap"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../../index.html?org/apache/shiro/realm/ldap/DefaultLdapContextFactory.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="DefaultLdapContextFactory.html" target="_top"><B>NO FRAMES</B></A> |
| <SCRIPT type="text/javascript"> |
| <!-- |
| if(window==top) { |
| document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>'); |
| } |
| //--> |
| </SCRIPT> |
| <NOSCRIPT> |
| <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A> |
| </NOSCRIPT> |
| |
| |
| </FONT></TD> |
| </TR> |
| <TR> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> |
| </TR> |
| </TABLE> |
| <A NAME="skip-navbar_top"></A> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| |
| <HR> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <H2> |
| <FONT SIZE="-1"> |
| org.apache.shiro.realm.ldap</FONT> |
| <BR> |
| Class DefaultLdapContextFactory</H2> |
| <PRE> |
| <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> |
| <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><B>org.apache.shiro.realm.ldap.DefaultLdapContextFactory</B> |
| </PRE> |
| <DL> |
| <DT><B>All Implemented Interfaces:</B> <DD><A HREF="../../../../../org/apache/shiro/realm/ldap/LdapContextFactory.html" title="interface in org.apache.shiro.realm.ldap">LdapContextFactory</A></DD> |
| </DL> |
| <HR> |
| <B>Deprecated.</B> <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> |
| <P> |
| <DL> |
| <DT><PRE><FONT SIZE="-1"><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> |
| </FONT>public class <A HREF="../../../../../src-html/org/apache/shiro/realm/ldap/DefaultLdapContextFactory.html#line.48"><B>DefaultLdapContextFactory</B></A><DT>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><DT>implements <A HREF="../../../../../org/apache/shiro/realm/ldap/LdapContextFactory.html" title="interface in org.apache.shiro.realm.ldap">LdapContextFactory</A></DL> |
| </PRE> |
| |
| <P> |
| <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> |
| <P> |
| |
| <P> |
| <DL> |
| <DT><B>Since:</B></DT> |
| <DD>0.2</DD> |
| </DL> |
| <HR> |
| |
| <P> |
| <!-- =========== FIELD SUMMARY =========== --> |
| |
| <A NAME="field_summary"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> |
| <B>Field Summary</B></FONT></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <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></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/shiro/realm/ldap/DefaultLdapContextFactory.html#authentication">authentication</A></B></CODE> |
| |
| <BR> |
| <B>Deprecated.</B> </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <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></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/shiro/realm/ldap/DefaultLdapContextFactory.html#contextFactoryClassName">contextFactoryClassName</A></B></CODE> |
| |
| <BR> |
| <B>Deprecated.</B> </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <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></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/shiro/realm/ldap/DefaultLdapContextFactory.html#principalSuffix">principalSuffix</A></B></CODE> |
| |
| <BR> |
| <B>Deprecated.</B> </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <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></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/shiro/realm/ldap/DefaultLdapContextFactory.html#referral">referral</A></B></CODE> |
| |
| <BR> |
| <B>Deprecated.</B> </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <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></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/shiro/realm/ldap/DefaultLdapContextFactory.html#searchBase">searchBase</A></B></CODE> |
| |
| <BR> |
| <B>Deprecated.</B> </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <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></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/shiro/realm/ldap/DefaultLdapContextFactory.html#SUN_CONNECTION_POOLING_PROPERTY">SUN_CONNECTION_POOLING_PROPERTY</A></B></CODE> |
| |
| <BR> |
| <B>Deprecated.</B> The Sun LDAP property used to enable connection pooling.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <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></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/shiro/realm/ldap/DefaultLdapContextFactory.html#systemPassword">systemPassword</A></B></CODE> |
| |
| <BR> |
| <B>Deprecated.</B> </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <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></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/shiro/realm/ldap/DefaultLdapContextFactory.html#systemUsername">systemUsername</A></B></CODE> |
| |
| <BR> |
| <B>Deprecated.</B> </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <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></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/shiro/realm/ldap/DefaultLdapContextFactory.html#url">url</A></B></CODE> |
| |
| <BR> |
| <B>Deprecated.</B> </TD> |
| </TR> |
| </TABLE> |
| |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| |
| <A NAME="constructor_summary"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> |
| <B>Constructor Summary</B></FONT></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><B><A HREF="../../../../../org/apache/shiro/realm/ldap/DefaultLdapContextFactory.html#DefaultLdapContextFactory()">DefaultLdapContextFactory</A></B>()</CODE> |
| |
| <BR> |
| <B>Deprecated.</B> </TD> |
| </TR> |
| </TABLE> |
| |
| <!-- ========== METHOD SUMMARY =========== --> |
| |
| <A NAME="method_summary"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> |
| <B>Method Summary</B></FONT></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected <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></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/shiro/realm/ldap/DefaultLdapContextFactory.html#createLdapContext(java.util.Hashtable)">createLdapContext</A></B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/util/Hashtable.html?is-external=true" title="class or interface in java.util">Hashtable</A> env)</CODE> |
| |
| <BR> |
| <B>Deprecated.</B> Creates and returns a new <A HREF="http://java.sun.com/javase/6/docs/api/javax/naming/ldap/InitialLdapContext.html?is-external=true" title="class or interface in javax.naming.ldap"><CODE>InitialLdapContext</CODE></A> instance.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <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></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/shiro/realm/ldap/DefaultLdapContextFactory.html#getLdapContext(java.lang.Object, java.lang.Object)">getLdapContext</A></B>(<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> |
| |
| <BR> |
| <B>Deprecated.</B> Creates (or retrieves from a pool) an <code>LdapContext</code> connection bound using the specified principal and |
| credentials.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <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></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/shiro/realm/ldap/DefaultLdapContextFactory.html#getLdapContext(java.lang.String, java.lang.String)">getLdapContext</A></B>(<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> |
| |
| <BR> |
| <B>Deprecated.</B> <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></TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <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></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/shiro/realm/ldap/DefaultLdapContextFactory.html#getSystemLdapContext()">getSystemLdapContext</A></B>()</CODE> |
| |
| <BR> |
| <B>Deprecated.</B> Creates (or retrieves from a pool) a <code>LdapContext</code> connection bound using the system account, or |
| anonymously if no system account is configured.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/shiro/realm/ldap/DefaultLdapContextFactory.html#setAdditionalEnvironment(java.util.Map)">setAdditionalEnvironment</A></B>(<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> |
| |
| <BR> |
| <B>Deprecated.</B> These entries are added to the environment map before initializing the LDAP context.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/shiro/realm/ldap/DefaultLdapContextFactory.html#setAuthentication(java.lang.String)">setAuthentication</A></B>(<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> |
| |
| <BR> |
| <B>Deprecated.</B> Sets the type of LDAP authentication to perform when connecting to the LDAP server.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/shiro/realm/ldap/DefaultLdapContextFactory.html#setContextFactoryClassName(java.lang.String)">setContextFactoryClassName</A></B>(<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> |
| |
| <BR> |
| <B>Deprecated.</B> The context factory to use.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/shiro/realm/ldap/DefaultLdapContextFactory.html#setPrincipalSuffix(java.lang.String)">setPrincipalSuffix</A></B>(<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> |
| |
| <BR> |
| <B>Deprecated.</B> A suffix appended to the username.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/shiro/realm/ldap/DefaultLdapContextFactory.html#setReferral(java.lang.String)">setReferral</A></B>(<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> |
| |
| <BR> |
| <B>Deprecated.</B> Sets the LDAP referral property.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/shiro/realm/ldap/DefaultLdapContextFactory.html#setSearchBase(java.lang.String)">setSearchBase</A></B>(<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> |
| |
| <BR> |
| <B>Deprecated.</B> <I>this attribute existed, but was never used in Shiro 1.x. It will be removed prior to Shiro 2.0.</I></TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/shiro/realm/ldap/DefaultLdapContextFactory.html#setSystemPassword(java.lang.String)">setSystemPassword</A></B>(<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> |
| |
| <BR> |
| <B>Deprecated.</B> The system password that will be used when connecting to the LDAP server to retrieve authorization |
| information about a user.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/shiro/realm/ldap/DefaultLdapContextFactory.html#setSystemUsername(java.lang.String)">setSystemUsername</A></B>(<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> |
| |
| <BR> |
| <B>Deprecated.</B> The system username that will be used when connecting to the LDAP server to retrieve authorization |
| information about a user.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/shiro/realm/ldap/DefaultLdapContextFactory.html#setUrl(java.lang.String)">setUrl</A></B>(<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> |
| |
| <BR> |
| <B>Deprecated.</B> The LDAP url to connect to.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/shiro/realm/ldap/DefaultLdapContextFactory.html#setUsePooling(boolean)">setUsePooling</A></B>(boolean usePooling)</CODE> |
| |
| <BR> |
| <B>Deprecated.</B> Determines whether or not LdapContext pooling is enabled for connections made using the system |
| user account.</TD> |
| </TR> |
| </TABLE> |
| <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
| <TH ALIGN="left"><B>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></B></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><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></TD> |
| </TR> |
| </TABLE> |
| |
| <P> |
| |
| <!-- ============ FIELD DETAIL =========== --> |
| |
| <A NAME="field_detail"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> |
| <B>Field Detail</B></FONT></TH> |
| </TR> |
| </TABLE> |
| |
| <A NAME="SUN_CONNECTION_POOLING_PROPERTY"><!-- --></A><H3> |
| SUN_CONNECTION_POOLING_PROPERTY</H3> |
| <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.59"><B>SUN_CONNECTION_POOLING_PROPERTY</B></A></PRE> |
| <DL> |
| <DD><B>Deprecated.</B> <DD>The Sun LDAP property used to enable connection pooling. This is used in the default implementation |
| to enable LDAP connection pooling. |
| <P> |
| <DL> |
| <DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.shiro.realm.ldap.DefaultLdapContextFactory.SUN_CONNECTION_POOLING_PROPERTY">Constant Field Values</A></DL> |
| </DL> |
| <HR> |
| |
| <A NAME="authentication"><!-- --></A><H3> |
| authentication</H3> |
| <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.68"><B>authentication</B></A></PRE> |
| <DL> |
| <DD><B>Deprecated.</B> <DL> |
| </DL> |
| </DL> |
| <HR> |
| |
| <A NAME="principalSuffix"><!-- --></A><H3> |
| principalSuffix</H3> |
| <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.70"><B>principalSuffix</B></A></PRE> |
| <DL> |
| <DD><B>Deprecated.</B> <DL> |
| </DL> |
| </DL> |
| <HR> |
| |
| <A NAME="searchBase"><!-- --></A><H3> |
| searchBase</H3> |
| <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.72"><B>searchBase</B></A></PRE> |
| <DL> |
| <DD><B>Deprecated.</B> <DL> |
| </DL> |
| </DL> |
| <HR> |
| |
| <A NAME="contextFactoryClassName"><!-- --></A><H3> |
| contextFactoryClassName</H3> |
| <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.74"><B>contextFactoryClassName</B></A></PRE> |
| <DL> |
| <DD><B>Deprecated.</B> <DL> |
| </DL> |
| </DL> |
| <HR> |
| |
| <A NAME="url"><!-- --></A><H3> |
| url</H3> |
| <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.76"><B>url</B></A></PRE> |
| <DL> |
| <DD><B>Deprecated.</B> <DL> |
| </DL> |
| </DL> |
| <HR> |
| |
| <A NAME="referral"><!-- --></A><H3> |
| referral</H3> |
| <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.78"><B>referral</B></A></PRE> |
| <DL> |
| <DD><B>Deprecated.</B> <DL> |
| </DL> |
| </DL> |
| <HR> |
| |
| <A NAME="systemUsername"><!-- --></A><H3> |
| systemUsername</H3> |
| <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.80"><B>systemUsername</B></A></PRE> |
| <DL> |
| <DD><B>Deprecated.</B> <DL> |
| </DL> |
| </DL> |
| <HR> |
| |
| <A NAME="systemPassword"><!-- --></A><H3> |
| systemPassword</H3> |
| <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.82"><B>systemPassword</B></A></PRE> |
| <DL> |
| <DD><B>Deprecated.</B> <DL> |
| </DL> |
| </DL> |
| |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| |
| <A NAME="constructor_detail"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> |
| <B>Constructor Detail</B></FONT></TH> |
| </TR> |
| </TABLE> |
| |
| <A NAME="DefaultLdapContextFactory()"><!-- --></A><H3> |
| DefaultLdapContextFactory</H3> |
| <PRE> |
| public <A HREF="../../../../../src-html/org/apache/shiro/realm/ldap/DefaultLdapContextFactory.html#line.48"><B>DefaultLdapContextFactory</B></A>()</PRE> |
| <DL> |
| <DD><B>Deprecated.</B> </DL> |
| |
| <!-- ============ METHOD DETAIL ========== --> |
| |
| <A NAME="method_detail"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> |
| <B>Method Detail</B></FONT></TH> |
| </TR> |
| </TABLE> |
| |
| <A NAME="setAuthentication(java.lang.String)"><!-- --></A><H3> |
| setAuthentication</H3> |
| <PRE> |
| public void <A HREF="../../../../../src-html/org/apache/shiro/realm/ldap/DefaultLdapContextFactory.html#line.101"><B>setAuthentication</B></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> |
| <DL> |
| <DD><B>Deprecated.</B> <DD>Sets the type of LDAP authentication to perform when connecting to the LDAP server. Defaults to "simple" |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>authentication</CODE> - the type of LDAP authentication to perform.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setPrincipalSuffix(java.lang.String)"><!-- --></A><H3> |
| setPrincipalSuffix</H3> |
| <PRE> |
| public void <A HREF="../../../../../src-html/org/apache/shiro/realm/ldap/DefaultLdapContextFactory.html#line.111"><B>setPrincipalSuffix</B></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> |
| <DL> |
| <DD><B>Deprecated.</B> <DD>A suffix appended to the username. This is typically for |
| domain names. (e.g. "@MyDomain.local") |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>principalSuffix</CODE> - the suffix.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setSearchBase(java.lang.String)"><!-- --></A><H3> |
| setSearchBase</H3> |
| <PRE> |
| <FONT SIZE="-1"><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> |
| </FONT>public void <A HREF="../../../../../src-html/org/apache/shiro/realm/ldap/DefaultLdapContextFactory.html#line.123"><B>setSearchBase</B></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> |
| <DL> |
| <DD><B>Deprecated.</B> <I>this attribute existed, but was never used in Shiro 1.x. It will be removed prior to Shiro 2.0.</I> |
| <P> |
| <DD>The search base for the search to perform in the LDAP server. |
| (e.g. OU=OrganizationName,DC=MyDomain,DC=local ) |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>searchBase</CODE> - the search base.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setContextFactoryClassName(java.lang.String)"><!-- --></A><H3> |
| setContextFactoryClassName</H3> |
| <PRE> |
| public void <A HREF="../../../../../src-html/org/apache/shiro/realm/ldap/DefaultLdapContextFactory.html#line.133"><B>setContextFactoryClassName</B></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> |
| <DL> |
| <DD><B>Deprecated.</B> <DD>The context factory to use. This defaults to the SUN LDAP JNDI implementation |
| but can be overridden to use custom LDAP factories. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>contextFactoryClassName</CODE> - the context factory that should be used.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setUrl(java.lang.String)"><!-- --></A><H3> |
| setUrl</H3> |
| <PRE> |
| public void <A HREF="../../../../../src-html/org/apache/shiro/realm/ldap/DefaultLdapContextFactory.html#line.142"><B>setUrl</B></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> |
| <DL> |
| <DD><B>Deprecated.</B> <DD>The LDAP url to connect to. (e.g. ldap://<ldapDirectoryHostname>:<port>) |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>url</CODE> - the LDAP url.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setReferral(java.lang.String)"><!-- --></A><H3> |
| setReferral</H3> |
| <PRE> |
| public void <A HREF="../../../../../src-html/org/apache/shiro/realm/ldap/DefaultLdapContextFactory.html#line.151"><B>setReferral</B></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> |
| <DL> |
| <DD><B>Deprecated.</B> <DD>Sets the LDAP referral property. Defaults to "follow" |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>referral</CODE> - the referral property.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setSystemUsername(java.lang.String)"><!-- --></A><H3> |
| setSystemUsername</H3> |
| <PRE> |
| public void <A HREF="../../../../../src-html/org/apache/shiro/realm/ldap/DefaultLdapContextFactory.html#line.162"><B>setSystemUsername</B></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> |
| <DL> |
| <DD><B>Deprecated.</B> <DD>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. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>systemUsername</CODE> - the username to use when logging into the LDAP server for authorization.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setSystemPassword(java.lang.String)"><!-- --></A><H3> |
| setSystemPassword</H3> |
| <PRE> |
| public void <A HREF="../../../../../src-html/org/apache/shiro/realm/ldap/DefaultLdapContextFactory.html#line.174"><B>setSystemPassword</B></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> |
| <DL> |
| <DD><B>Deprecated.</B> <DD>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. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>systemPassword</CODE> - the password to use when logging into the LDAP server for authorization.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setUsePooling(boolean)"><!-- --></A><H3> |
| setUsePooling</H3> |
| <PRE> |
| public void <A HREF="../../../../../src-html/org/apache/shiro/realm/ldap/DefaultLdapContextFactory.html#line.188"><B>setUsePooling</B></A>(boolean usePooling)</PRE> |
| <DL> |
| <DD><B>Deprecated.</B> <DD>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. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>usePooling</CODE> - true to enable pooling, or false to disable it.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setAdditionalEnvironment(java.util.Map)"><!-- --></A><H3> |
| setAdditionalEnvironment</H3> |
| <PRE> |
| public void <A HREF="../../../../../src-html/org/apache/shiro/realm/ldap/DefaultLdapContextFactory.html#line.197"><B>setAdditionalEnvironment</B></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> |
| <DL> |
| <DD><B>Deprecated.</B> <DD>These entries are added to the environment map before initializing the LDAP context. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>additionalEnvironment</CODE> - additional environment entries to be configured on the LDAP context.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getSystemLdapContext()"><!-- --></A><H3> |
| getSystemLdapContext</H3> |
| <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.204"><B>getSystemLdapContext</B></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> |
| <DL> |
| <DD><B>Deprecated.</B> <DD><B>Description copied from interface: <CODE><A HREF="../../../../../org/apache/shiro/realm/ldap/LdapContextFactory.html#getSystemLdapContext()">LdapContextFactory</A></CODE></B></DD> |
| <DD>Creates (or retrieves from a pool) a <code>LdapContext</code> connection bound using the system account, or |
| anonymously if no system account is configured. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><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></DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>a <code>LdapContext</code> bound by the system account, or bound anonymously if no system account |
| is configured. |
| <DT><B>Throws:</B> |
| <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.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getLdapContext(java.lang.String, java.lang.String)"><!-- --></A><H3> |
| getLdapContext</H3> |
| <PRE> |
| <FONT SIZE="-1"><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> |
| </FONT>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.220"><B>getLdapContext</B></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> |
| <DL> |
| <DD><B>Deprecated.</B> <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> |
| <P> |
| <DD>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. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><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></DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>username</CODE> - the username to use when creating the connection.<DD><CODE>password</CODE> - the password to use when creating the connection. |
| <DT><B>Returns:</B><DD>a <code>LdapContext</code> bound using the given username and password. |
| <DT><B>Throws:</B> |
| <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.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getLdapContext(java.lang.Object, java.lang.Object)"><!-- --></A><H3> |
| getLdapContext</H3> |
| <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.227"><B>getLdapContext</B></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> |
| <DL> |
| <DD><B>Deprecated.</B> <DD><B>Description copied from interface: <CODE><A HREF="../../../../../org/apache/shiro/realm/ldap/LdapContextFactory.html#getLdapContext(java.lang.Object, java.lang.Object)">LdapContextFactory</A></CODE></B></DD> |
| <DD>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. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><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></DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>principal</CODE> - the principal to use when acquiring a connection to the LDAP directory<DD><CODE>credentials</CODE> - the credentials (password, X.509 certificate, etc) to use when acquiring a connection to the |
| LDAP directory |
| <DT><B>Returns:</B><DD>the acquired <code>LdapContext</code> connection bound using the specified principal and credentials. |
| <DT><B>Throws:</B> |
| <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.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="createLdapContext(java.util.Hashtable)"><!-- --></A><H3> |
| createLdapContext</H3> |
| <PRE> |
| protected <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.275"><B>createLdapContext</B></A>(<A HREF="http://java.sun.com/javase/6/docs/api/java/util/Hashtable.html?is-external=true" title="class or interface in java.util">Hashtable</A> env) |
| 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> |
| <DL> |
| <DD><B>Deprecated.</B> <DD>Creates and returns a new <A HREF="http://java.sun.com/javase/6/docs/api/javax/naming/ldap/InitialLdapContext.html?is-external=true" title="class or interface in javax.naming.ldap"><CODE>InitialLdapContext</CODE></A> instance. This method exists primarily |
| to support testing where a mock LdapContext can be returned instead of actually creating a connection, but |
| subclasses are free to provide a different implementation if necessary. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>env</CODE> - the JNDI environment settings used to create the LDAP connection |
| <DT><B>Returns:</B><DD>an LdapConnection |
| <DT><B>Throws:</B> |
| <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 a problem occurs creating the connection</DL> |
| </DD> |
| </DL> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <HR> |
| |
| |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <A NAME="navbar_bottom"><!-- --></A> |
| <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> |
| <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> |
| <TR> |
| <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> |
| <A NAME="navbar_bottom_firstrow"><!-- --></A> |
| <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> |
| <TR ALIGN="center" VALIGN="top"> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> |
| <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/DefaultLdapContextFactory.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> |
| </TR> |
| </TABLE> |
| </TD> |
| <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> |
| </EM> |
| </TD> |
| </TR> |
| |
| <TR> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../../org/apache/shiro/realm/ldap/AbstractLdapRealm.html" title="class in org.apache.shiro.realm.ldap"><B>PREV CLASS</B></A> |
| <A HREF="../../../../../org/apache/shiro/realm/ldap/JndiLdapContextFactory.html" title="class in org.apache.shiro.realm.ldap"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../../index.html?org/apache/shiro/realm/ldap/DefaultLdapContextFactory.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="DefaultLdapContextFactory.html" target="_top"><B>NO FRAMES</B></A> |
| <SCRIPT type="text/javascript"> |
| <!-- |
| if(window==top) { |
| document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>'); |
| } |
| //--> |
| </SCRIPT> |
| <NOSCRIPT> |
| <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A> |
| </NOSCRIPT> |
| |
| |
| </FONT></TD> |
| </TR> |
| <TR> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> |
| </TR> |
| </TABLE> |
| <A NAME="skip-navbar_bottom"></A> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| |
| <HR> |
| Copyright © 2004-2014 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved. |
| </BODY> |
| </HTML> |
