|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectnetscape.ldap.client.opers.JDAPBaseDNRequest
netscape.ldap.client.opers.JDAPSearchRequest
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 }
Field Summary | |
---|---|
static int |
BASE_OBJECT
search scope |
static java.lang.String |
DEFAULT_FILTER
|
static int |
DEREF_ALWAYS
|
static int |
DEREF_FINDING_BASE_OBJ
|
static int |
DEREF_IN_SEARCHING
|
protected java.lang.String[] |
m_attrs
|
protected boolean |
m_attrs_only
|
protected java.lang.String |
m_base_dn
Private variables |
protected int |
m_deref
|
protected java.lang.String |
m_filter
|
protected JDAPFilter |
m_parsedFilter
|
protected int |
m_scope
|
protected int |
m_size_limit
|
protected int |
m_time_limit
|
static int |
NEVER_DEREF_ALIASES
alias dereference |
static int |
SINGLE_LEVEL
|
static int |
WHOLE_SUBTREE
|
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 | |
---|---|
JDAPSearchRequest(java.lang.String base_dn,
int scope,
int deref,
int size_limit,
int time_limit,
boolean attrs_only,
java.lang.String filter,
java.lang.String[] attrs)
Constructs search request. |
Method Summary | |
---|---|
java.lang.String |
getBaseDN()
Gets the base dn component. |
BERElement |
getBERElement()
Gets the ber representation of search request. |
int |
getType()
Retrieves the protocol operation type. |
void |
setBaseDN(java.lang.String basedn)
Sets the base dn component. |
java.lang.String |
toString()
Retrieves the string representation of the request. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final int BASE_OBJECT
public static final int SINGLE_LEVEL
public static final int WHOLE_SUBTREE
public static final int NEVER_DEREF_ALIASES
public static final int DEREF_IN_SEARCHING
public static final int DEREF_FINDING_BASE_OBJ
public static final int DEREF_ALWAYS
public static final java.lang.String DEFAULT_FILTER
protected java.lang.String m_base_dn
protected int m_scope
protected int m_deref
protected int m_size_limit
protected int m_time_limit
protected boolean m_attrs_only
protected java.lang.String m_filter
protected JDAPFilter m_parsedFilter
protected java.lang.String[] m_attrs
Constructor Detail |
---|
public JDAPSearchRequest(java.lang.String base_dn, int scope, int deref, int size_limit, int time_limit, boolean attrs_only, java.lang.String filter, java.lang.String[] attrs) throws java.lang.IllegalArgumentException
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
java.lang.IllegalArgumentException
- if the filter has bad syntaxMethod Detail |
---|
public int getType()
getType
in interface JDAPProtocolOp
public void setBaseDN(java.lang.String basedn)
setBaseDN
in class JDAPBaseDNRequest
basedn
- base dnpublic java.lang.String getBaseDN()
getBaseDN
in class JDAPBaseDNRequest
public BERElement getBERElement()
getBERElement
in interface JDAPProtocolOp
public java.lang.String toString()
toString
in interface JDAPProtocolOp
toString
in class java.lang.Object
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |