com.novell.ldap
Class LDAPReferralException

java.lang.Object
  java.lang.Throwable
      java.lang.Exception
          com.novell.ldap.LDAPException
              com.novell.ldap.LDAPReferralException

All Implemented Interfaces:

java.io.Serializable

public class LDAPReferralException
extends LDAPException

Thrown when a server returns a referral and when a referral has not been followed. It contains a list of URL strings corresponding to the referrals or search continuation references received on an LDAP operation.

See Also:

Serialized Form

Field Summary

private java.lang.String	failedReferral
private java.lang.String[]	referrals

Fields inherited from class com.novell.ldap.LDAPException

ADMIN_LIMIT_EXCEEDED, AFFECTS_MULTIPLE_DSAS, ALIAS_DEREFERENCING_PROBLEM, ALIAS_PROBLEM, AMBIGUOUS_RESPONSE, ATTRIBUTE_OR_VALUE_EXISTS, AUTH_METHOD_NOT_SUPPORTED, AUTH_UNKNOWN, BUSY, CLIENT_LOOP, COMPARE_FALSE, COMPARE_TRUE, CONFIDENTIALITY_REQUIRED, CONNECT_ERROR, CONSTRAINT_VIOLATION, CONTROL_NOT_FOUND, DECODING_ERROR, ENCODING_ERROR, ENTRY_ALREADY_EXISTS, FILTER_ERROR, INAPPROPRIATE_AUTHENTICATION, INAPPROPRIATE_MATCHING, INSUFFICIENT_ACCESS_RIGHTS, INVALID_ATTRIBUTE_SYNTAX, INVALID_CREDENTIALS, INVALID_DN_SYNTAX, INVALID_RESPONSE, IS_LEAF, LDAP_NOT_SUPPORTED, LDAP_PARTIAL_RESULTS, LDAP_TIMEOUT, LOCAL_ERROR, LOOP_DETECT, MORE_RESULTS_TO_RETURN, NAMING_VIOLATION, NO_MEMORY, NO_RESULTS_RETURNED, NO_SUCH_ATTRIBUTE, NO_SUCH_OBJECT, NOT_ALLOWED_ON_NONLEAF, NOT_ALLOWED_ON_RDN, OBJECT_CLASS_MODS_PROHIBITED, OBJECT_CLASS_VIOLATION, OPERATIONS_ERROR, OTHER, PROTOCOL_ERROR, REFERRAL, REFERRAL_LIMIT_EXCEEDED, SASL_BIND_IN_PROGRESS, SERVER_DOWN, SIZE_LIMIT_EXCEEDED, STRONG_AUTH_REQUIRED, SUCCESS, TIME_LIMIT_EXCEEDED, TLS_NOT_SUPPORTED, UNAVAILABLE, UNAVAILABLE_CRITICAL_EXTENSION, UNDEFINED_ATTRIBUTE_TYPE, UNWILLING_TO_PERFORM, USER_CANCELLED

Constructor Summary

LDAPReferralException()
Constructs a default exception with no specific error information.

LDAPReferralException(java.lang.String message)
Constructs a default exception with a specified string as additional information.

LDAPReferralException(java.lang.String message, int resultCode, java.lang.String serverMessage)
Constructs an exception with a specified error string, result code, and an error message from the server.

LDAPReferralException(java.lang.String message, int resultCode, java.lang.String serverMessage, java.lang.Throwable rootException)
Constructs an exception with a specified error string, result code, an error message from the server, and an exception that indicates a failure to follow a referral.

LDAPReferralException(java.lang.String message, java.lang.Object[] arguments)
Constructs a default exception with a specified string as additional information.

LDAPReferralException(java.lang.String message, java.lang.Object[] arguments, int resultCode, java.lang.String serverMessage)
Constructs an exception with a specified error string, result code, and an error message from the server.

LDAPReferralException(java.lang.String message, java.lang.Object[] arguments, int resultCode, java.lang.String serverMessage, java.lang.Throwable rootException)
Constructs an exception with a specified error string, result code, an error message from the server, and an exception that indicates a failure to follow a referral.

LDAPReferralException(java.lang.String message, java.lang.Object[] arguments, java.lang.Throwable rootException)
Constructs a default exception with a specified string as additional information and an exception that indicates a failure to follow a referral.

LDAPReferralException(java.lang.String message, java.lang.Throwable rootException)
Constructs a default exception with a specified string as additional information and an exception that indicates a failure to follow a referral.

Method Summary

java.lang.String	getFailedReferral()
java.lang.String[]	getReferrals() Gets the list of referral URLs (LDAP URLs to other servers) returned by the LDAP server.
void	setFailedReferral(java.lang.String url) Sets a referral that could not be processed
(package private) void	setReferrals(java.lang.String[] urls) Sets the list of referrals
java.lang.String	toString() returns a string of information about the exception and the the nested exceptions, if any.

Methods inherited from class com.novell.ldap.LDAPException

getCause, getExceptionString, getLDAPErrorMessage, getLocalizedMessage, getMatchedDN, getMessage, getResultCode, resultCodeToString, resultCodeToString, resultCodeToString, resultCodeToString

Methods inherited from class java.lang.Throwable

fillInStackTrace, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

failedReferral

private java.lang.String failedReferral

referrals

private java.lang.String[] referrals

Constructor Detail

LDAPReferralException

public LDAPReferralException()

Constructs a default exception with no specific error information.

LDAPReferralException

public LDAPReferralException(java.lang.String message)

Constructs a default exception with a specified string as additional information.

This form is used for lower-level errors.

Parameters:

message - The additional error information.

LDAPReferralException

public LDAPReferralException(java.lang.String message,
                             java.lang.Object[] arguments)

Constructs a default exception with a specified string as additional information.

This form is used for lower-level errors.

Parameters:

arguments - The modifying arguments to be included in the message string.

message - The additional error information.

LDAPReferralException

public LDAPReferralException(java.lang.String message,
                             java.lang.Throwable rootException)

Constructs a default exception with a specified string as additional information and an exception that indicates a failure to follow a referral. This excepiton applies only to synchronous operations and is thrown only on receipt of a referral when the referral was not followed.

Parameters:

message - The additional error information.

rootException - An exception which caused referral following to fail.

LDAPReferralException

public LDAPReferralException(java.lang.String message,
                             java.lang.Object[] arguments,
                             java.lang.Throwable rootException)

Constructs a default exception with a specified string as additional information and an exception that indicates a failure to follow a referral. This excepiton applies only to synchronous operations and is thrown only on receipt of a referral when the referral was not followed.

Parameters:

message - The additional error information.

arguments - The modifying arguments to be included in the message string.

rootException - An exception which caused referral following to fail.

LDAPReferralException

public LDAPReferralException(java.lang.String message,
                             int resultCode,
                             java.lang.String serverMessage)

Constructs an exception with a specified error string, result code, and an error message from the server.

Parameters:

message - The additional error information.

resultCode - The result code returned.

serverMessage - Error message specifying additional information from the server.

LDAPReferralException

public LDAPReferralException(java.lang.String message,
                             java.lang.Object[] arguments,
                             int resultCode,
                             java.lang.String serverMessage)

Constructs an exception with a specified error string, result code, and an error message from the server.

Parameters:

message - The additional error information.

arguments - The modifying arguments to be included in the message string.

resultCode - The result code returned.

serverMessage - Error message specifying additional information from the server.

LDAPReferralException

public LDAPReferralException(java.lang.String message,
                             int resultCode,
                             java.lang.String serverMessage,
                             java.lang.Throwable rootException)

Constructs an exception with a specified error string, result code, an error message from the server, and an exception that indicates a failure to follow a referral.

Parameters:

message - The additional error information.

resultCode - The result code returned.

serverMessage - Error message specifying additional information from the server.

LDAPReferralException

public LDAPReferralException(java.lang.String message,
                             java.lang.Object[] arguments,
                             int resultCode,
                             java.lang.String serverMessage,
                             java.lang.Throwable rootException)

Constructs an exception with a specified error string, result code, an error message from the server, and an exception that indicates a failure to follow a referral.

Parameters:

message - The additional error information.

arguments - The modifying arguments to be included in the message string.

resultCode - The result code returned.

serverMessage - Error message specifying additional information from the server.

Method Detail

getFailedReferral

public java.lang.String getFailedReferral()

getReferrals

public java.lang.String[] getReferrals()

Gets the list of referral URLs (LDAP URLs to other servers) returned by the LDAP server. The referral list may include URLs of a type other than ones for an LDAP server (for example, a referral URL other than ldap://something).

Returns:

The list of URLs that comprise this referral

setFailedReferral

public void setFailedReferral(java.lang.String url)

Sets a referral that could not be processed

Parameters:

url - The referral URL that could not be processed.

setReferrals

void setReferrals(java.lang.String[] urls)

Sets the list of referrals

Parameters:

urls - the list of referrals returned by the LDAP server in a single response.

toString

public java.lang.String toString()

returns a string of information about the exception and the the nested exceptions, if any.

Overrides:

toString in class LDAPException