All LDAP Classes
Internal LDAP Classes

com.novell.ldap.rfc2251
Class RfcExtendedResponse

java.lang.Object
  extended by com.novell.ldap.asn1.ASN1Object
      extended by com.novell.ldap.asn1.ASN1Structured
          extended by com.novell.ldap.asn1.ASN1Sequence
              extended by com.novell.ldap.rfc2251.RfcExtendedResponse
All Implemented Interfaces:
RfcResponse, java.io.Serializable

public class RfcExtendedResponse
extends ASN1Sequence
implements RfcResponse

Represents an LDAP Extended Response.

       ExtendedResponse ::= [APPLICATION 24] SEQUENCE {
               COMPONENTS OF LDAPResult,
               responseName     [10] LDAPOID OPTIONAL,
               response         [11] OCTET STRING OPTIONAL }

See Also:
Serialized Form

Field Summary
private  int referralIndex
           
static int RESPONSE
          Context-specific TAG for optional response.
static int RESPONSE_NAME
          Context-specific TAG for optional responseName.
private  int responseIndex
           
private  int responseNameIndex
           
 
Fields inherited from class com.novell.ldap.asn1.ASN1Sequence
TAG
 
Constructor Summary
RfcExtendedResponse(ASN1Decoder dec, java.io.InputStream in, int len)
          The only time a client will create a ExtendedResponse is when it is decoding it from an InputStream
RfcExtendedResponse(ASN1Enumerated resultCode, RfcLDAPDN matchedDN, RfcLDAPString errorMessage, RfcReferral referral, RfcLDAPOID responseName, ASN1OctetString response)
          Creates the RFC Extended Response Object passing the individual parameters.
 
Method Summary
 RfcLDAPString getErrorMessage()
           
 ASN1Identifier getIdentifier()
          Override getIdentifier to return an application-wide id.
 RfcLDAPDN getMatchedDN()
           
 RfcReferral getReferral()
           
 ASN1OctetString getResponse()
           
 RfcLDAPOID getResponseName()
           
 ASN1Enumerated getResultCode()
           
 
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, setIdentifier
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

RESPONSE_NAME

public static final int RESPONSE_NAME
Context-specific TAG for optional responseName.

See Also:
Constant Field Values

RESPONSE

public static final int RESPONSE
Context-specific TAG for optional response.

See Also:
Constant Field Values

referralIndex

private int referralIndex

responseNameIndex

private int responseNameIndex

responseIndex

private int responseIndex
Constructor Detail

RfcExtendedResponse

public RfcExtendedResponse(ASN1Enumerated resultCode,
                           RfcLDAPDN matchedDN,
                           RfcLDAPString errorMessage,
                           RfcReferral referral,
                           RfcLDAPOID responseName,
                           ASN1OctetString response)
Creates the RFC Extended Response Object passing the individual parameters.

Parameters:
resultCode - The result code as defined in LDAPException.
matchedDN - The name of the lowest entry that was matched for some error result codes, an empty string or null if none.
errorMessage - A diagnostic message returned by the server, an empty string or null if none.
referral - The referral URLs returned for a REFERRAL result code or null if none.
responseName - The LDAPOID for this extended operation
response - Any Response returned by the server

RfcExtendedResponse

public RfcExtendedResponse(ASN1Decoder dec,
                           java.io.InputStream in,
                           int len)
                    throws java.io.IOException
The only time a client will create a ExtendedResponse is when it is decoding it from an InputStream

Throws:
java.io.IOException
Method Detail

getResultCode

public final ASN1Enumerated getResultCode()
Specified by:
getResultCode in interface RfcResponse

getMatchedDN

public final RfcLDAPDN getMatchedDN()
Specified by:
getMatchedDN in interface RfcResponse

getErrorMessage

public final RfcLDAPString getErrorMessage()
Specified by:
getErrorMessage in interface RfcResponse

getReferral

public final RfcReferral getReferral()
Specified by:
getReferral in interface RfcResponse

getResponseName

public final RfcLDAPOID getResponseName()

getResponse

public final ASN1OctetString getResponse()

getIdentifier

public final ASN1Identifier getIdentifier()
Override getIdentifier to return an application-wide id.

Overrides:
getIdentifier in class ASN1Object

All LDAP Classes
Internal LDAP Classes

Copyright ? 2002 Novell, Inc. All Rights Reserved.
Novell, Inc.
1800 South Novell Place
Provo, Ut 84606
Phone: (801) 861-5000