Java Doc for LdapReferralException.java in  » 6.0-JDK-Modules-com.sun » jndi » com » sun » jndi » ldap » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation
1. 6.0 JDK Core
2. 6.0 JDK Modules
3. 6.0 JDK Modules com.sun
4. 6.0 JDK Modules com.sun.java
5. 6.0 JDK Modules sun
6. 6.0 JDK Platform
7. Ajax
8. Apache Harmony Java SE
9. Aspect oriented
10. Authentication Authorization
11. Blogger System
12. Build
13. Byte Code
14. Cache
15. Chart
16. Chat
17. Code Analyzer
18. Collaboration
19. Content Management System
20. Database Client
21. Database DBMS
22. Database JDBC Connection Pool
23. Database ORM
24. Development
25. EJB Server geronimo
26. EJB Server GlassFish
27. EJB Server JBoss 4.2.1
28. EJB Server resin 3.1.5
29. ERP CRM Financial
30. ESB
31. Forum
32. GIS
33. Graphic Library
34. Groupware
35. HTML Parser
36. IDE
37. IDE Eclipse
38. IDE Netbeans
39. Installer
40. Internationalization Localization
41. Inversion of Control
42. Issue Tracking
43. J2EE
44. JBoss
45. JMS
46. JMX
47. Library
48. Mail Clients
49. Net
50. Parser
51. PDF
52. Portal
53. Profiler
54. Project Management
55. Report
56. RSS RDF
57. Rule Engine
58. Science
59. Scripting
60. Search Engine
61. Security
62. Sevlet Container
63. Source Control
64. Swing Library
65. Template Engine
66. Test Coverage
67. Testing
68. UML
69. Web Crawler
70. Web Framework
71. Web Mail
72. Web Server
73. Web Services
74. Web Services apache cxf 2.0.1
75. Web Services AXIS2
76. Wiki Engine
77. Workflow Engines
78. XML
79. XML UI
Java
Java Tutorial
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net Tutorial
Flash / Flex / ActionScript
VBA / Excel / Access / Word
XML
XML Tutorial
Microsoft Office PowerPoint 2007 Tutorial
Microsoft Office Excel 2007 Tutorial
Microsoft Office Word 2007 Tutorial
Java Source Code / Java Documentation » 6.0 JDK Modules com.sun » jndi » com.sun.jndi.ldap 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   java.lang.Throwable
      java.lang.Exception
         javax.naming.NamingException
            javax.naming.ReferralException
               javax.naming.ldap.LdapReferralException
                  com.sun.jndi.ldap.LdapReferralException

LdapReferralException
final public class LdapReferralException extends javax.naming.ldap.LdapReferralException (Code)
This exception is raised when a referral to an alternative context is encountered.

An LdapReferralException object contains one or more referrals. Each referral is an alternative location for the same target entry. For example, a referral may be an LDAP URL. The referrals are attempted in sequence until one is successful or all have failed. In the case of the latter then the exception generated by the final referral is recorded and presented later.

A referral may be skipped or may be retried. For example, in the case of an authentication error, a referral may be retried with different environment properties.

An LdapReferralException object may also contain a reference to a chain of unprocessed LdapReferralException objects. Once the current set of referrals have been exhausted and unprocessed LdapReferralException objects remain, then the LdapReferralException object referenced by the current object is thrown and the cycle continues.

If new LdapReferralException objects are generated while following an existing referral then these new objects are appended to the end of the chain of unprocessed LdapReferralException objects.

If an exception was recorded while processing a chain of LdapReferralException objects then is is throw once processing has completed.
author:
   Vincent Ryan



Field Summary
 LdapReferralExceptionnextReferralEx
    

Constructor Summary
 LdapReferralException(Name resolvedName, Object resolvedObj, Name remainingName, String explanation, Hashtable envprops, String nextName, int handleReferrals, Control[] reqCtls)
     Constructs a new instance of LdapReferralException.

Method Summary
 LdapReferralExceptionappendUnprocessedReferrals(LdapReferralException back)
     Appends the supplied (chain of) referral exception onto the end of the current (chain of) referral exception.
 voiddump()
     Display the state of each element in a chain of LdapReferralException objects.
 NamingExceptiongetNamingException()
     Gets the exception generated while processing a referral.
 StringgetNewRdn()
     Gets the new RDN name.
 StringgetNextReferral()
     Gets the next referral.
public  ContextgetReferralContext()
     Gets a context at which to continue processing.
public  ContextgetReferralContext(Hashtable newProps)
     Gets a context at which to continue processing.
public  ContextgetReferralContext(Hashtable newProps, Control[] connCtls)
     Gets a context at which to continue processing.
public  ObjectgetReferralInfo()
     Gets referral information.
 booleanhasMoreReferralExceptions()
     Tests if there are any referral exceptions remaining to be processed.
 booleanhasMoreReferrals()
     Tests if there are any referrals remaining to be processed.
public  voidretryReferral()
     Marks the current referral as one to be retried.
 voidsetHopCount(int hopCount)
     Sets the counter which records the number of hops that result from following a sequence of referrals.
 voidsetNameResolved(boolean resolved)
     Sets the flag to indicate that the target name has been resolved.
 voidsetNamingException(NamingException e)
     Sets the exception generated while processing a referral.
 voidsetNewRdn(String newRdn)
     Sets the new RDN name so that the rename operation can be completed (when a referral is being followed).
 voidsetReferralInfo(Vector referrals, boolean continuationRef)
     Sets referral information.
public  booleanskipReferral()
     Marks the current referral as one to be ignored.

Field Detail
nextReferralEx
LdapReferralException nextReferralEx(Code)




Constructor Detail
LdapReferralException
LdapReferralException(Name resolvedName, Object resolvedObj, Name remainingName, String explanation, Hashtable envprops, String nextName, int handleReferrals, Control[] reqCtls)(Code)
Constructs a new instance of LdapReferralException.
Parameters:
  resolvedName - The part of the name that has been successfullyresolved.
Parameters:
  resolvedObj - The object to which resolution was successful.
Parameters:
  remainingName - The remaining unresolved portion of the name.
Parameters:
  explanation - Additional detail about this exception.




Method Detail
appendUnprocessedReferrals
LdapReferralException appendUnprocessedReferrals(LdapReferralException back)(Code)
Appends the supplied (chain of) referral exception onto the end of the current (chain of) referral exception. Spent referral exceptions are trimmed off.



dump
void dump()(Code)
Display the state of each element in a chain of LdapReferralException objects.



getNamingException
NamingException getNamingException()(Code)
Gets the exception generated while processing a referral.



getNewRdn
String getNewRdn()(Code)
Gets the new RDN name.



getNextReferral
String getNextReferral() throws ReferralException(Code)
Gets the next referral. When the current set of referrals have been exhausted then the next referral exception is thrown, if available.



getReferralContext
public Context getReferralContext() throws NamingException(Code)
Gets a context at which to continue processing. The current environment properties are re-used.



getReferralContext
public Context getReferralContext(Hashtable newProps) throws NamingException(Code)
Gets a context at which to continue processing. The supplied environment properties are used.



getReferralContext
public Context getReferralContext(Hashtable newProps, Control[] connCtls) throws NamingException(Code)
Gets a context at which to continue processing. The supplied environment properties and connection controls are used.



getReferralInfo
public Object getReferralInfo()(Code)
Gets referral information.



hasMoreReferralExceptions
boolean hasMoreReferralExceptions()(Code)
Tests if there are any referral exceptions remaining to be processed.



hasMoreReferrals
boolean hasMoreReferrals()(Code)
Tests if there are any referrals remaining to be processed. If name resolution has already completed then any remaining referrals (in the current referral exception) will be ignored.



retryReferral
public void retryReferral()(Code)
Marks the current referral as one to be retried.



setHopCount
void setHopCount(int hopCount)(Code)
Sets the counter which records the number of hops that result from following a sequence of referrals.



setNameResolved
void setNameResolved(boolean resolved)(Code)
Sets the flag to indicate that the target name has been resolved.



setNamingException
void setNamingException(NamingException e)(Code)
Sets the exception generated while processing a referral. Only the first exception is recorded.



setNewRdn
void setNewRdn(String newRdn)(Code)
Sets the new RDN name so that the rename operation can be completed (when a referral is being followed).



setReferralInfo
void setReferralInfo(Vector referrals, boolean continuationRef)(Code)
Sets referral information.



skipReferral
public boolean skipReferral()(Code)
Marks the current referral as one to be ignored. Returns false when there are no referrals remaining to be processed.



Methods inherited from javax.naming.ldap.LdapReferralException
abstract public Context getReferralContext() throws NamingException(Code)(Java Doc)
abstract public Context getReferralContext(Hashtable env) throws NamingException(Code)(Java Doc)
abstract public Context getReferralContext(Hashtable env, Control[] reqCtls) throws NamingException(Code)(Java Doc)

Methods inherited from javax.naming.ReferralException
abstract public Context getReferralContext() throws NamingException(Code)(Java Doc)
abstract public Context getReferralContext(Hashtable env) throws NamingException(Code)(Java Doc)
abstract public Object getReferralInfo()(Code)(Java Doc)
abstract public void retryReferral()(Code)(Java Doc)
abstract public boolean skipReferral()(Code)(Java Doc)

Fields inherited from javax.naming.NamingException
protected Name remainingName(Code)(Java Doc)
protected Name resolvedName(Code)(Java Doc)
protected Object resolvedObj(Code)(Java Doc)
protected Throwable rootException(Code)(Java Doc)

Methods inherited from javax.naming.NamingException
public void appendRemainingComponent(String name)(Code)(Java Doc)
public void appendRemainingName(Name name)(Code)(Java Doc)
public Throwable getCause()(Code)(Java Doc)
public String getExplanation()(Code)(Java Doc)
public Name getRemainingName()(Code)(Java Doc)
public Name getResolvedName()(Code)(Java Doc)
public Object getResolvedObj()(Code)(Java Doc)
public Throwable getRootCause()(Code)(Java Doc)
public Throwable initCause(Throwable cause)(Code)(Java Doc)
public void setRemainingName(Name name)(Code)(Java Doc)
public void setResolvedName(Name name)(Code)(Java Doc)
public void setResolvedObj(Object obj)(Code)(Java Doc)
public void setRootCause(Throwable e)(Code)(Java Doc)
public String toString()(Code)(Java Doc)
public String toString(boolean detail)(Code)(Java Doc)


Methods inherited from java.lang.Throwable
native public synchronized Throwable fillInStackTrace()(Code)(Java Doc)
public Throwable getCause()(Code)(Java Doc)
public String getLocalizedMessage()(Code)(Java Doc)
public String getMessage()(Code)(Java Doc)
public StackTraceElement[] getStackTrace()(Code)(Java Doc)
public synchronized Throwable initCause(Throwable cause)(Code)(Java Doc)
public void printStackTrace()(Code)(Java Doc)
public void printStackTrace(PrintStream s)(Code)(Java Doc)
public void printStackTrace(PrintWriter s)(Code)(Java Doc)
public void setStackTrace(StackTraceElement[] stackTrace)(Code)(Java Doc)
public String toString()(Code)(Java Doc)

Methods inherited from java.lang.Object
native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.