ldapmanager.html

开源软件openfire的API文件。进行openfire的二次开发所必需的工具。

public void <B>setPort</B>(int&nbsp;port)</PRE>
<DL>
<DD>Sets the LDAP server port number. The default is 389. This value is
 stored as the Jive property <tt>ldap.port</tt>.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>port</CODE> - the LDAP server port number.</DL>
</DD>
</DL>
<HR>

<A NAME="isDebugEnabled()"><!-- --></A><H3>
isDebugEnabled</H3>
<PRE>
public boolean <B>isDebugEnabled</B>()</PRE>
<DL>
<DD>Returns true if LDAP connection debugging is turned on. When on, trace
 information about BER buffers sent and received by the LDAP provider is
 written to System.out. Debugging is turned off by default.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>true if LDAP debugging is turned on.</DL>
</DD>
</DL>
<HR>

<A NAME="setDebugEnabled(boolean)"><!-- --></A><H3>
setDebugEnabled</H3>
<PRE>
public void <B>setDebugEnabled</B>(boolean&nbsp;debugEnabled)</PRE>
<DL>
<DD>Sets whether LDAP connection debugging is turned on. When on, trace
 information about BER buffers sent and received by the LDAP provider is
 written to System.out. Debugging is turned off by default.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>debugEnabled</CODE> - true if debugging should be turned on.</DL>
</DD>
</DL>
<HR>

<A NAME="isSslEnabled()"><!-- --></A><H3>
isSslEnabled</H3>
<PRE>
public boolean <B>isSslEnabled</B>()</PRE>
<DL>
<DD>Returns true if LDAP connection is via SSL or not. SSL is turned off by default.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>true if SSL connections are enabled or not.</DL>
</DD>
</DL>
<HR>

<A NAME="setSslEnabled(boolean)"><!-- --></A><H3>
setSslEnabled</H3>
<PRE>
public void <B>setSslEnabled</B>(boolean&nbsp;sslEnabled)</PRE>
<DL>
<DD>Sets whether the connection to the LDAP server should be made via ssl or not.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>sslEnabled</CODE> - true if ssl should be enabled, false otherwise.</DL>
</DD>
</DL>
<HR>

<A NAME="getUsernameField()"><!-- --></A><H3>
getUsernameField</H3>
<PRE>
public <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> <B>getUsernameField</B>()</PRE>
<DL>
<DD>Returns the LDAP field name that the username lookup will be performed
 on. By default this is "uid".
<P>
<DD><DL>

<DT><B>Returns:</B><DD>the LDAP field that the username lookup will be performed on.</DL>
</DD>
</DL>
<HR>

<A NAME="getUsernameSuffix()"><!-- --></A><H3>
getUsernameSuffix</H3>
<PRE>
public <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> <B>getUsernameSuffix</B>()</PRE>
<DL>
<DD>Returns the suffix appended to the username when LDAP lookups are performed.
 By default this is "".
<P>
<DD><DL>

<DT><B>Returns:</B><DD>the suffix appened to usernames when LDAP lookups are performed.</DL>
</DD>
</DL>
<HR>

<A NAME="setUsernameField(java.lang.String)"><!-- --></A><H3>
setUsernameField</H3>
<PRE>
public void <B>setUsernameField</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;usernameField)</PRE>
<DL>
<DD>Sets the LDAP field name that the username lookup will be performed on.
 By default this is "uid".
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>usernameField</CODE> - the LDAP field that the username lookup will be
      performed on.</DL>
</DD>
</DL>
<HR>

<A NAME="setUsernameSuffix(java.lang.String)"><!-- --></A><H3>
setUsernameSuffix</H3>
<PRE>
public void <B>setUsernameSuffix</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;usernameSuffix)</PRE>
<DL>
<DD>Set the suffix appended to the username whenever LDAP lookups are performed.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>usernameSuffix</CODE> - the String to append to usernames for lookups</DL>
</DD>
</DL>
<HR>

<A NAME="getNameField()"><!-- --></A><H3>
getNameField</H3>
<PRE>
public <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> <B>getNameField</B>()</PRE>
<DL>
<DD>Returns the LDAP field name that the user's name is stored in. By default
 this is "cn". Another common value is "displayName".
<P>
<DD><DL>

<DT><B>Returns:</B><DD>the LDAP field that that corresponds to the user's name.</DL>
</DD>
</DL>
<HR>

<A NAME="setNameField(java.lang.String)"><!-- --></A><H3>
setNameField</H3>
<PRE>
public void <B>setNameField</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;nameField)</PRE>
<DL>
<DD>Sets the LDAP field name that the user's name is stored in. By default
 this is "cn". Another common value is "displayName".
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>nameField</CODE> - the LDAP field that that corresponds to the user's name.</DL>
</DD>
</DL>
<HR>

<A NAME="getEmailField()"><!-- --></A><H3>
getEmailField</H3>
<PRE>
public <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> <B>getEmailField</B>()</PRE>
<DL>
<DD>Returns the LDAP field name that the user's email address is stored in.
 By default this is "mail".
<P>
<DD><DL>

<DT><B>Returns:</B><DD>the LDAP field that that corresponds to the user's email
      address.</DL>
</DD>
</DL>
<HR>

<A NAME="setEmailField(java.lang.String)"><!-- --></A><H3>
setEmailField</H3>
<PRE>
public void <B>setEmailField</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;emailField)</PRE>
<DL>
<DD>Sets the LDAP field name that the user's email address is stored in.
 By default this is "mail".
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>emailField</CODE> - the LDAP field that that corresponds to the user's
      email address.</DL>
</DD>
</DL>
<HR>

<A NAME="getBaseDN()"><!-- --></A><H3>
getBaseDN</H3>
<PRE>
public <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> <B>getBaseDN</B>()</PRE>
<DL>
<DD>Returns the starting DN that searches for users will performed with.
 Searches will performed on the entire sub-tree under the base DN.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>the starting DN used for performing searches.</DL>
</DD>
</DL>
<HR>

<A NAME="setBaseDN(java.lang.String)"><!-- --></A><H3>
setBaseDN</H3>
<PRE>
public void <B>setBaseDN</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;baseDN)</PRE>
<DL>
<DD>Sets the starting DN that searches for users will performed with.
 Searches will performed on the entire sub-tree under the base DN.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>baseDN</CODE> - the starting DN used for performing searches.</DL>
</DD>
</DL>
<HR>

<A NAME="getAlternateBaseDN()"><!-- --></A><H3>
getAlternateBaseDN</H3>
<PRE>
public <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> <B>getAlternateBaseDN</B>()</PRE>
<DL>
<DD>Returns the alternate starting DN that searches for users will performed with.
 Searches will performed on the entire sub-tree under the alternate base DN after
 they are performed on the main base DN.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>the alternate starting DN used for performing searches. If no alternate
      DN is set, this method will return <tt>null</tt>.</DL>
</DD>
</DL>
<HR>

<A NAME="setAlternateBaseDN(java.lang.String)"><!-- --></A><H3>
setAlternateBa