com.unboundid.ldap.sdk
Class LDAPExtendedOperationException

java.lang.Object
  extended by java.lang.Throwable
      extended by java.lang.Exception
          extended by com.unboundid.util.LDAPSDKException
              extended by com.unboundid.ldap.sdk.LDAPException
                  extended by com.unboundid.ldap.sdk.LDAPExtendedOperationException
All Implemented Interfaces:
java.io.Serializable

public class LDAPExtendedOperationException
extends LDAPException

This class defines an exception that can be thrown if the server returns an extended response that indicates that the operation did not complete successfully. This may be used to obtain access to any response OID and/or value that may have been included in the extended result.

See Also:
Serialized Form

Field Summary
 
Fields inherited from class com.unboundid.ldap.sdk.LDAPException
NO_CONTROLS, NO_REFERRALS
 
Constructor Summary
LDAPExtendedOperationException(ExtendedResult extendedResult)
          Creates a new LDAP extended operation exception from the provided extended result.
 
Method Summary
 ExtendedResult getExtendedResult()
          Retrieves the extended result that was returned by the server.
 java.lang.String getResponseOID()
          Retrieves the response OID from the extended result, if any.
 ASN1OctetString getResponseValue()
          Retrieves the response value from the extended result, if any.
 LDAPResult toLDAPResult()
          Creates a new LDAPResult object from this exception.
 
Methods inherited from class com.unboundid.ldap.sdk.LDAPException
getDiagnosticMessage, getExceptionMessage, getMatchedDN, getReferralURLs, getResponseControl, getResponseControls, getResultCode, getResultString, hasResponseControl, hasResponseControl, toString
 
Methods inherited from class com.unboundid.util.LDAPSDKException
toString
 
Methods inherited from class java.lang.Throwable
fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

LDAPExtendedOperationException

public LDAPExtendedOperationException(ExtendedResult extendedResult)
Creates a new LDAP extended operation exception from the provided extended result.

Parameters:
extendedResult - The extended result to use to create this exception.
Method Detail

toLDAPResult

public LDAPResult toLDAPResult()
Creates a new LDAPResult object from this exception.

Overrides:
toLDAPResult in class LDAPException
Returns:
The LDAPResult object created from this exception.

getExtendedResult

public ExtendedResult getExtendedResult()
Retrieves the extended result that was returned by the server.

Returns:
The extended result that was returned by the server.

getResponseOID

public java.lang.String getResponseOID()
Retrieves the response OID from the extended result, if any.

Returns:
The response OID from the extended result, or null if the result did not include an OID.

getResponseValue

public ASN1OctetString getResponseValue()
Retrieves the response value from the extended result, if any.

Returns:
The response value from the extended result, or null if the result did not include a value.