com.novell.ldap.rfc2251
Class RfcLDAPResult

java.lang.Object
  com.novell.ldap.asn1.ASN1Object
      com.novell.ldap.asn1.ASN1Structured
          com.novell.ldap.asn1.ASN1Sequence
              com.novell.ldap.rfc2251.RfcLDAPResult

All Implemented Interfaces:

RfcResponse, java.io.Serializable

Direct Known Subclasses:

RfcAddResponse, RfcCompareResponse, RfcDelResponse, RfcModifyDNResponse, RfcModifyResponse, RfcSearchResultDone

public class RfcLDAPResult

extends ASN1Sequence

implements RfcResponse

Represents an LDAPResult.

        LDAPResult ::= SEQUENCE {
               resultCode      ENUMERATED {
                            success                      (0),
                            operationsError              (1),
                            protocolError                (2),
                            timeLimitExceeded            (3),
                            sizeLimitExceeded            (4),
                            compareFalse                 (5),
                            compareTrue                  (6),
                            authMethodNotSupported       (7),
                            strongAuthRequired           (8),
                                      -- 9 reserved --
                            referral                     (10),  -- new
                            adminLimitExceeded           (11),  -- new
                            unavailableCriticalExtension (12),  -- new
                            confidentialityRequired      (13),  -- new
                            saslBindInProgress           (14),  -- new
                            noSuchAttribute              (16),
                            undefinedAttributeType       (17),
                            inappropriateMatching        (18),
                            constraintViolation          (19),
                            attributeOrValueExists       (20),
                            invalidAttributeSyntax       (21),
                                       -- 22-31 unused --
                            noSuchObject                 (32),
                            aliasProblem                 (33),
                            invalidDNSyntax              (34),
                            -- 35 reserved for undefined isLeaf --
                            aliasDereferencingProblem    (36),
                                       -- 37-47 unused --
                            inappropriateAuthentication  (48),

                            invalidCredentials           (49),
                            insufficientAccessRights     (50),
                            busy                         (51),
                            unavailable                  (52),
                            unwillingToPerform           (53),
                            loopDetect                   (54),
                                       -- 55-63 unused --
                            namingViolation              (64),
                            objectClassViolation         (65),
                            notAllowedOnNonLeaf          (66),
                            notAllowedOnRDN              (67),
                            entryAlreadyExists           (68),
                            objectClassModsProhibited    (69),
                                       -- 70 reserved for CLDAP --
                            affectsMultipleDSAs          (71), -- new
                                       -- 72-79 unused --
                            other                        (80) },
                            -- 81-90 reserved for APIs --
               matchedDN       LDAPDN,
               errorMessage    LDAPString,
               referral        [3] Referral OPTIONAL }

See Also:

Serialized Form

Field Summary

static int

REFERRAL Context-specific TAG for optional Referral.

Fields inherited from class com.novell.ldap.asn1.ASN1Sequence

TAG

Fields inherited from class com.novell.ldap.asn1.ASN1Structured

Fields inherited from class com.novell.ldap.asn1.ASN1Object

Constructor Summary

RfcLDAPResult(ASN1Decoder dec, java.io.InputStream in, int len)
Constructs an RfcLDAPResult from the inputstream

RfcLDAPResult(ASN1Enumerated resultCode, RfcLDAPDN matchedDN, RfcLDAPString errorMessage)
Constructs an RfcLDAPResult from parameters

RfcLDAPResult(ASN1Enumerated resultCode, RfcLDAPDN matchedDN, RfcLDAPString errorMessage, RfcReferral referral)
Constructs an RfcLDAPResult from parameters

Method Summary

RfcLDAPString	getErrorMessage() Returns the error message from the server
RfcLDAPDN	getMatchedDN() Returns the matched DN from the server
RfcReferral	getReferral() Returns the referral(s) from the server
ASN1Enumerated	getResultCode() Returns the result code from the server

Methods inherited from class com.novell.ldap.asn1.ASN1Sequence

toString

Methods inherited from class com.novell.ldap.asn1.ASN1Structured

add, decodeStructured, encode, get, set, size, toArray, toString

Methods inherited from class com.novell.ldap.asn1.ASN1Object

getEncoding, getIdentifier, setIdentifier

Methods inherited from class java.lang.Object

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

Field Detail

REFERRAL

public static final int REFERRAL

Context-specific TAG for optional Referral.

See Also:

Constant Field Values

Constructor Detail

RfcLDAPResult

public RfcLDAPResult(ASN1Enumerated resultCode,
                     RfcLDAPDN matchedDN,
                     RfcLDAPString errorMessage)

Constructs an RfcLDAPResult from parameters

Parameters:

resultCode - the result code of the operation

matchedDN - the matched DN returned from the server

errorMessage - the diagnostic message returned from the server

RfcLDAPResult

public RfcLDAPResult(ASN1Enumerated resultCode,
                     RfcLDAPDN matchedDN,
                     RfcLDAPString errorMessage,
                     RfcReferral referral)

Constructs an RfcLDAPResult from parameters

Parameters:

resultCode - the result code of the operation

matchedDN - the matched DN returned from the server

errorMessage - the diagnostic message returned from the server

referral - the referral(s) returned by the server

RfcLDAPResult

public RfcLDAPResult(ASN1Decoder dec,
                     java.io.InputStream in,
                     int len)
              throws java.io.IOException

Constructs an RfcLDAPResult from the inputstream

Method Detail

getResultCode

public final ASN1Enumerated getResultCode()

Returns the result code from the server

Specified by:

getResultCode in interface RfcResponse

Returns:

the result code

getMatchedDN

public final RfcLDAPDN getMatchedDN()

Returns the matched DN from the server

Specified by:

getMatchedDN in interface RfcResponse

Returns:

the matched DN

getErrorMessage

public final RfcLDAPString getErrorMessage()

Returns the error message from the server

Specified by:

getErrorMessage in interface RfcResponse

Returns:

the server error message

getReferral

public final RfcReferral getReferral()

Returns the referral(s) from the server

Specified by:

getReferral in interface RfcResponse

Returns:

the referral(s)