netscape.ldap.client.opers
Class JDAPSearchRequest
- JDAPProtocolOp
public class JDAPSearchRequest
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
}
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 |
JDAPSearchRequest(String base_dn, int scope, int deref, int size_limit, int time_limit, boolean attrs_only, String filter, attrs[] ) - Constructs search request.
|
BERElement | getBERElement() - Gets the ber representation of search request.
|
String | getBaseDN() - Gets the base dn component.
|
int | getType() - Retrieves the protocol operation type.
|
void | setBaseDN(String basedn) - Sets the base dn component.
|
String | toString() - Retrieves the string representation of the request.
|
BASE_OBJECT
public static final int BASE_OBJECT
search scope
DEFAULT_FILTER
public static final String DEFAULT_FILTER
DEREF_ALWAYS
public static final int DEREF_ALWAYS
DEREF_FINDING_BASE_OBJ
public static final int DEREF_FINDING_BASE_OBJ
DEREF_IN_SEARCHING
public static final int DEREF_IN_SEARCHING
NEVER_DEREF_ALIASES
public static final int NEVER_DEREF_ALIASES
alias dereference
SINGLE_LEVEL
public static final int SINGLE_LEVEL
WHOLE_SUBTREE
public static final int WHOLE_SUBTREE
m_attrs
protected String[] m_attrs
m_attrs_only
protected boolean m_attrs_only
m_base_dn
protected String m_base_dn
Private variables
m_deref
protected int m_deref
m_filter
protected String m_filter
m_scope
protected int m_scope
m_size_limit
protected int m_size_limit
m_time_limit
protected int m_time_limit
JDAPSearchRequest
public JDAPSearchRequest(String base_dn,
int scope,
int deref,
int size_limit,
int time_limit,
boolean attrs_only,
String filter,
attrs[] )
throws IllegalArgumentException
Constructs search request.
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 RFC1558
toString
public String toString()
Retrieves the string representation of the request.
- toString in interface JDAPProtocolOp