ldapreferralexception.html

API資料大全

</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TD><B>Methods inherited from class java.lang.<A HREF="../../../java/lang/Object.html">Object</A></B></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="../../../java/lang/Object.html#clone()">clone</A>, <A HREF="../../../java/lang/Object.html#equals(java.lang.Object)">equals</A>, <A HREF="../../../java/lang/Object.html#finalize()">finalize</A>, <A HREF="../../../java/lang/Object.html#getClass()">getClass</A>, <A HREF="../../../java/lang/Object.html#hashCode()">hashCode</A>, <A HREF="../../../java/lang/Object.html#notify()">notify</A>, <A HREF="../../../java/lang/Object.html#notifyAll()">notifyAll</A>, <A HREF="../../../java/lang/Object.html#wait()">wait</A>, <A HREF="../../../java/lang/Object.html#wait(long)">wait</A>, <A HREF="../../../java/lang/Object.html#wait(long, int)">wait</A></CODE></TD>
</TR>
</TABLE>
&nbsp;
<P>

<!-- ============ FIELD DETAIL =========== -->


<!-- ========= CONSTRUCTOR DETAIL ======== -->

<A NAME="constructor_detail"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN=1><FONT SIZE="+2">
<B>Constructor Detail</B></FONT></TD>
</TR>
</TABLE>

<A NAME="LdapReferralException(java.lang.String)"><!-- --></A><H3>
LdapReferralException</H3>
<PRE>
protected <B>LdapReferralException</B>(<A HREF="../../../java/lang/String.html">String</A>&nbsp;explanation)</PRE>
<DL>
<DD>Constructs a new instance of LdapReferralException using the
 explanation supplied. All other fields are set to null.<DD><DL>
<DT><B>Parameters:</B><DD><CODE>explanation</CODE> - Additional detail about this exception. Can be null.<DT><B>See Also: </B><DD><A HREF="../../../java/lang/Throwable.html#getMessage()"><CODE>Throwable.getMessage()</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="LdapReferralException()"><!-- --></A><H3>
LdapReferralException</H3>
<PRE>
protected <B>LdapReferralException</B>()</PRE>
<DL>
<DD>Constructs a new instance of LdapReferralException.
 All fields are set to null.</DL>

<!-- ============ METHOD DETAIL ========== -->

<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN=1><FONT SIZE="+2">
<B>Method Detail</B></FONT></TD>
</TR>
</TABLE>

<A NAME="getReferralContext()"><!-- --></A><H3>
getReferralContext</H3>
<PRE>
public abstract <A HREF="../../../javax/naming/Context.html">Context</A> <B>getReferralContext</B>()
                                    throws <A HREF="../../../javax/naming/NamingException.html">NamingException</A></PRE>
<DL>
<DD>Retrieves the context at which to continue the method using the
 context's environment and no controls.
 The referral context is created using the environment properties of
 the context that threw the <tt>ReferralException</tt> and no controls.
<p>
 This method is equivalent to
<blockquote><pre>
 getReferralContext(ctx.getEnvironment(), null);
</pre></blockquote>
 where <tt>ctx</tt> is the context that threw the <tt>ReferralException.</tt>
<p>
 It is overridden in this class for documentation purposes only.
 See <tt>ReferralException</tt> for how to use this method.<DD><DL>
<DT><B>Overrides:</B><DD><CODE><A HREF="../../../javax/naming/ReferralException.html#getReferralContext()">getReferralContext</A></CODE> in class <CODE><A HREF="../../../javax/naming/ReferralException.html">ReferralException</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>The non-null context at which to continue the method.<DT><B>Throws:</B><DD><CODE><A HREF="../../../javax/naming/NamingException.html">NamingException</A></CODE> - If a naming exception was encountered.
 Call either <tt>retryReferral()</tt> or <tt>skipReferral()</tt>
 to continue processing referrals.</DL>
</DD>
</DL>
<HR>

<A NAME="getReferralContext(java.util.Hashtable)"><!-- --></A><H3>
getReferralContext</H3>
<PRE>
public abstract <A HREF="../../../javax/naming/Context.html">Context</A> <B>getReferralContext</B>(<A HREF="../../../java/util/Hashtable.html">Hashtable</A>&nbsp;env)
                                    throws <A HREF="../../../javax/naming/NamingException.html">NamingException</A></PRE>
<DL>
<DD>Retrieves the context at which to continue the method using 
 environment properties and no controls.
 The referral context is created using <tt>env</tt> as its environment
 properties and no controls.
<p>
 This method is equivalent to
<blockquote><pre>
 getReferralContext(env, null);
</pre></blockquote>
<p>
 It is overridden in this class for documentation purposes only.
 See <tt>ReferralException</tt> for how to use this method.<DD><DL>
<DT><B>Overrides:</B><DD><CODE><A HREF="../../../javax/naming/ReferralException.html#getReferralContext(java.util.Hashtable)">getReferralContext</A></CODE> in class <CODE><A HREF="../../../javax/naming/ReferralException.html">ReferralException</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>env</CODE> - The possibly null environment to use when retrieving the 
 		referral context. If null, no environment properties will be used.<DT><B>Returns:</B><DD>The non-null context at which to continue the method.<DT><B>Throws:</B><DD><CODE><A HREF="../../../javax/naming/NamingException.html">NamingException</A></CODE> - If a naming exception was encountered.
 Call either <tt>retryReferral()</tt> or <tt>skipReferral()</tt>
 to continue processing referrals.</DL>
</DD>
</DL>
<HR>

<A NAME="getReferralContext(java.util.Hashtable, javax.naming.ldap.Control[])"><!-- --></A><H3>
getReferralContext</H3>
<PRE>
public abstract <A HREF="../../../javax/naming/Context.html">Context</A> <B>getReferralContext</B>(<A HREF="../../../java/util/Hashtable.html">Hashtable</A>&nbsp;env,
                                           <A HREF="../../../javax/naming/ldap/Control.html">Control</A>[]&nbsp;reqCtls)
                                    throws <A HREF="../../../javax/naming/NamingException.html">NamingException</A></PRE>
<DL>
<DD>Retrieves the context at which to continue the method using
 request controls and environment properties.
 Regardless of whether a referral is encountered directly during a 
 context operation, or indirectly, for example, during a search
 enumeration, the referral exception should provide a context
 at which to continue the operation.
 To continue the operation, the client program should re-invoke
 the method using the same arguments as the original invocation.
<p>
 <tt>reqCtls</tt> is used when creating the connection to the referred
 server. These controls will be used as the connection request controls for
 the context and context instances
 derived from the context. 
 <tt>reqCtls</tt> will also be the context's request controls for 
 subsequent context operations. See the <tt>LdapContext</tt> class
 description for details.
<p>
 This method should be used instead of the other two overloaded forms
 when the caller needs to supply request controls for creating the
 the referral context. It might need to do this, for example, when
 it needs to supply special controls relating to authentication.
<p>
 Service provider implementors should read the "Service Provider" section
 in the <tt>LdapContext</tt> class description for implementation details.<DD><DL>
<DT><B>Parameters:</B><DD><CODE>reqCtls</CODE> - The possibly null request controls to use for the new context.
 If null or the empty array means use no request controls.<DD><CODE>env</CODE> - The possibly null environment properties to use when
 for the new context. If null, the context is initialized with no environment
 properties.<DT><B>Returns:</B><DD>The non-null context at which to continue the method.<DT><B>Throws:</B><DD><CODE><A HREF="../../../javax/naming/NamingException.html">NamingException</A></CODE> - If a naming exception was encountered.
 Call either <tt>retryReferral()</tt> or <tt>skipReferral()</tt>
 to continue processing referrals.</DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>

<!-- ========== START OF NAVBAR ========== -->
<A NAME="navbar_bottom"><!-- --></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
  <TR ALIGN="center" VALIGN="top">
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/LdapReferralException.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  </TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
<b>Java<sup><font size=-2>TM</font></sup>&nbsp;2&nbsp;Platform<br>Std.&nbsp;Ed. v1.3</b></EM>
</TD>
</TR>

<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;PREV CLASS&nbsp;
&nbsp;NEXT CLASS</FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  <A HREF="../../../index.html" TARGET="_top"><B>FRAMES</B></A>  &nbsp;
&nbsp;<A HREF="LdapReferralException.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  SUMMARY: &nbsp;INNER&nbsp;|&nbsp;<A HREF="#fields_inherited_from_class_javax.naming.NamingException">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: &nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<!-- =========== END OF NAVBAR =========== -->

<HR>
<font size="-1"><a href="http://java.sun.com/cgi-bin/bugreport.cgi">Submit a bug or feature</a><br>For further API reference and developer documentation, see <a href="http://java.sun.com/products/jdk/1.3/devdocs-vs-specs.html">Java 2 SDK SE Developer Documentation</a>. That documentation  contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples. <p>Java, Java 2D, and JDBC are trademarks or registered trademarks of Sun Microsystems, Inc. in the US and other countries.<br>Copyright 1993-2000 Sun Microsystems, Inc. 901 San Antonio Road<br>Palo Alto, California, 94303, U.S.A.  All Rights Reserved.</font>
</BODY>
</HTML>