Package netscape.ldap.client.opers
Class JDAPSearchRequest
java.lang.Object
netscape.ldap.client.opers.JDAPBaseDNRequest
netscape.ldap.client.opers.JDAPSearchRequest
- All Implemented Interfaces:
JDAPProtocolOp
This class implements the search request. This object is
sent to the ldap server.
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), attrsOnly BOOLEAN, filter Filter, attributes SEQUENCE OF AttributeType }
- Version:
- 1.0
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final int
search scopestatic final String
static final int
static final int
static final int
protected String[]
protected boolean
protected String
Private variablesprotected int
protected String
protected JDAPFilter
protected int
protected int
protected int
static final int
alias dereferencestatic final int
static final int
Fields inherited from interface netscape.ldap.client.opers.JDAPProtocolOp
ABANDON_REQUEST, ADD_REQUEST, ADD_RESPONSE, BIND_REQUEST, BIND_RESPONSE, COMPARE_REQUEST, COMPARE_RESPONSE, DEL_REQUEST, DEL_RESPONSE, EXTENDED_REQUEST, EXTENDED_RESPONSE, MODIFY_RDN_REQUEST, MODIFY_RDN_RESPONSE, MODIFY_REQUEST, MODIFY_RESPONSE, SEARCH_REQUEST, SEARCH_RESPONSE, SEARCH_RESULT, SEARCH_RESULT_REFERENCE, UNBIND_REQUEST
-
Constructor Summary
ConstructorsConstructorDescriptionJDAPSearchRequest
(String base_dn, int scope, int deref, int size_limit, int time_limit, boolean attrs_only, String filter, String[] attrs) Constructs search request. -
Method Summary
-
Field Details
-
BASE_OBJECT
public static final int BASE_OBJECTsearch scope- See Also:
-
SINGLE_LEVEL
public static final int SINGLE_LEVEL- See Also:
-
WHOLE_SUBTREE
public static final int WHOLE_SUBTREE- See Also:
-
NEVER_DEREF_ALIASES
public static final int NEVER_DEREF_ALIASESalias dereference- See Also:
-
DEREF_IN_SEARCHING
public static final int DEREF_IN_SEARCHING- See Also:
-
DEREF_FINDING_BASE_OBJ
public static final int DEREF_FINDING_BASE_OBJ- See Also:
-
DEREF_ALWAYS
public static final int DEREF_ALWAYS- See Also:
-
DEFAULT_FILTER
- See Also:
-
m_base_dn
Private variables -
m_scope
protected int m_scope -
m_deref
protected int m_deref -
m_size_limit
protected int m_size_limit -
m_time_limit
protected int m_time_limit -
m_attrs_only
protected boolean m_attrs_only -
m_filter
-
m_parsedFilter
-
m_attrs
-
-
Constructor Details
-
JDAPSearchRequest
public JDAPSearchRequest(String base_dn, int scope, int deref, int size_limit, int time_limit, boolean attrs_only, String filter, String[] attrs) throws IllegalArgumentException Constructs search request.- Parameters:
base_dn
- base object entry relative to the searchscope
- scope of the searchderef
- how alias objects should be handledsize_limit
- maximum number of entriestime_limit
- maximum time (in time) allowedattrs_only
- should return type onlyfilter
- string filter based on RFC1558attrs
- list of attribute types- Throws:
IllegalArgumentException
- if the filter has bad syntax
-
-
Method Details
-
getType
public int getType()Retrieves the protocol operation type.- Specified by:
getType
in interfaceJDAPProtocolOp
- Returns:
- operation type
-
setBaseDN
Sets the base dn component.- Specified by:
setBaseDN
in classJDAPBaseDNRequest
- Parameters:
basedn
- base dn
-
getBaseDN
Gets the base dn component.- Specified by:
getBaseDN
in classJDAPBaseDNRequest
- Returns:
- base dn
-
getBERElement
Gets the ber representation of search request.- Specified by:
getBERElement
in interfaceJDAPProtocolOp
- Returns:
- ber representation of request.
-
toString
Retrieves the string representation of the request.- Specified by:
toString
in interfaceJDAPProtocolOp
- Overrides:
toString
in classObject
- Returns:
- string representation
-