referralexception.html

API資料大全

<TD><CODE><A HREF="../../java/lang/Throwable.html#fillInStackTrace()">fillInStackTrace</A>, <A HREF="../../java/lang/Throwable.html#getLocalizedMessage()">getLocalizedMessage</A>, <A HREF="../../java/lang/Throwable.html#getMessage()">getMessage</A></CODE></TD>
</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="ReferralException(java.lang.String)"><!-- --></A><H3>
ReferralException</H3>
<PRE>
protected <B>ReferralException</B>(<A HREF="../../java/lang/String.html">String</A>&nbsp;explanation)</PRE>
<DL>
<DD>Constructs a new instance of ReferralException 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="ReferralException()"><!-- --></A><H3>
ReferralException</H3>
<PRE>
protected <B>ReferralException</B>()</PRE>
<DL>
<DD>Constructs a new instance of ReferralException.
 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="getReferralInfo()"><!-- --></A><H3>
getReferralInfo</H3>
<PRE>
public abstract <A HREF="../../java/lang/Object.html">Object</A> <B>getReferralInfo</B>()</PRE>
<DL>
<DD>Retrieves information (such as URLs) related to this referral.
 The program may examine or display this information
 to the user to determine whether to continue with the referral,
 or to determine additional information needs to be supplied in order
 to continue with the referral.<DD><DL>
<DT><B>Returns:</B><DD>Non-null referral information related to this referral.</DL>
</DD>
</DL>
<HR>

<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.
 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. The referral context is
 created using the environment properties of the context
 that threw the ReferralException.

<p>
 To continue the operation, the client program should re-invoke
 the method using the same arguments as the original invocation.<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.
 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.
<p>
 The referral context is created using <tt>env</tt> as its environment
 properties.
 This method should be used instead of the no-arg overloaded form
 when the caller needs to use different environment properties for
 the referral context. It might need to do this, for example, when
 it needs to supply different authentication information to the referred
 server in order to create the referral context.
<p>
 To continue the operation, the client program should re-invoke
 the method using the same arguments as the original invocation.<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="skipReferral()"><!-- --></A><H3>
skipReferral</H3>
<PRE>
public abstract boolean <B>skipReferral</B>()</PRE>
<DL>
<DD>Discards the referral about to be processed.
 A call to this method should be followed by a call to
 <code>getReferralContext</code> to allow the processing of
 other referrals to continue.
 The following code fragment shows a typical usage pattern.
 <p><blockquote><pre>
	} catch (ReferralException e) {
	    if (!shallIFollow(e.getReferralInfo())) {
		if (!e.skipReferral()) {
		    return;
		}
	    }
	    ctx = e.getReferralContext();
	}
 </pre></blockquote><DD><DL>
<DT><B>Returns:</B><DD>true If more referral processing is pending; false otherwise.</DL>
</DD>
</DL>
<HR>

<A NAME="retryReferral()"><!-- --></A><H3>
retryReferral</H3>
<PRE>
public abstract void <B>retryReferral</B>()</PRE>
<DL>
<DD>Retries the referral currently being processed.
 A call to this method should be followed by a call to
 <code>getReferralContext</code> to allow the current
 referral to be retried.
 The following code fragment shows a typical usage pattern.
 <p><blockquote><pre>
	} catch (ReferralException e) {
	    while (true) {
		try {
		    ctx = e.getReferralContext(env);
		    break;
		} catch (NamingException ne) {
		    if (! shallIRetry()) {
			return;
		    }
		    // modify environment properties (env), if necessary
		    e.retryReferral();
		}
	    }
	}
 </pre></blockquote></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/ReferralException.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;<A HREF="../../javax/naming/PartialResultException.html"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../javax/naming/ServiceUnavailableException.html"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  <A HREF="../../index.html" TARGET="_top"><B>FRAMES</B></A>  &nbsp;
&nbsp;<A HREF="ReferralException.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>