All LDAP Classes
Internal LDAP Classes

com.novell.ldap.rfc2251
Class RfcSearchRequest

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.RfcSearchRequest
All Implemented Interfaces:
RfcRequest, java.io.Serializable

public class RfcSearchRequest
extends ASN1Sequence
implements RfcRequest

Represents an LDAP Search Request.

       SearchRequest ::= [APPLICATION 3] SEQUENCE {
               baseObject      LDAPDN,
               scope           ENUMERATED {
                       baseObject              (0),
                       singleLevel             (1),
                       wholeSubtree            (2) },
               derefAliases    ENUMERATED {
                       neverDerefAliases       (0),
                       derefInSearching        (1),
                       derefFindingBaseObj     (2),
                       derefAlways             (3) },
               sizeLimit       INTEGER (0 .. maxInt),
               timeLimit       INTEGER (0 .. maxInt),
               typesOnly       BOOLEAN,
               filter          Filter,
               attributes      AttributeDescriptionList }

See Also:
Serialized Form

Field Summary
 
Fields inherited from class com.novell.ldap.asn1.ASN1Sequence
TAG
 
Constructor Summary
RfcSearchRequest(ASN1Object[] origRequest, java.lang.String base, java.lang.String filter, boolean request)
          Constructs a new Search Request copying from an existing request.
RfcSearchRequest(RfcLDAPDN baseObject, ASN1Enumerated scope, ASN1Enumerated derefAliases, ASN1Integer sizeLimit, ASN1Integer timeLimit, ASN1Boolean typesOnly, RfcFilter filter, RfcAttributeDescriptionList attributes)
           
 
Method Summary
 RfcRequest dupRequest(java.lang.String base, java.lang.String filter, boolean request)
          Builds a new request using the data from the this object.
 ASN1Identifier getIdentifier()
          Override getIdentifier to return an application-wide id.
 java.lang.String getRequestDN()
          Builds a new request using the data from the this object.
 
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
 

Constructor Detail

RfcSearchRequest

public RfcSearchRequest(RfcLDAPDN baseObject,
                        ASN1Enumerated scope,
                        ASN1Enumerated derefAliases,
                        ASN1Integer sizeLimit,
                        ASN1Integer timeLimit,
                        ASN1Boolean typesOnly,
                        RfcFilter filter,
                        RfcAttributeDescriptionList attributes)

RfcSearchRequest

RfcSearchRequest(ASN1Object[] origRequest,
                 java.lang.String base,
                 java.lang.String filter,
                 boolean request)
           throws LDAPException
Constructs a new Search Request copying from an existing request.

Throws:
LDAPException
Method Detail

getIdentifier

public final ASN1Identifier getIdentifier()
Override getIdentifier to return an application-wide id.
 ID = CLASS: APPLICATION, FORM: CONSTRUCTED, TAG: 3. (0x63)

Overrides:
getIdentifier in class ASN1Object

dupRequest

public final RfcRequest dupRequest(java.lang.String base,
                                   java.lang.String filter,
                                   boolean request)
                            throws LDAPException
Description copied from interface: RfcRequest
Builds a new request using the data from the this object.

Specified by:
dupRequest in interface RfcRequest
Throws:
LDAPException

getRequestDN

public final java.lang.String getRequestDN()
Description copied from interface: RfcRequest
Builds a new request using the data from the this object.

Specified by:
getRequestDN in interface RfcRequest

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