|
LDAP Classes Implements Java LDAP |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.novell.ldap.LDAPMessage com.novell.ldap.LDAPSearchRequest
Represents an LDAP Search request.
LDAPConnection.sendRequest(com.novell.ldap.LDAPMessage, com.novell.ldap.LDAPMessageQueue)
,
Serialized FormField Summary | |
static int |
AND
Search Filter Identifier for an AND component. |
static int |
ANY
Search Filter Identifier for an ANY component of a SUBSTRING. |
static int |
APPROX_MATCH
Search Filter Identifier for an APPROX_MATCH component. |
static int |
EQUALITY_MATCH
Search Filter Identifier for an EQUALITY_MATCH component. |
static int |
EXTENSIBLE_MATCH
Search Filter Identifier for an EXTENSIBLE_MATCH component. |
static int |
FINAL
Search Filter Identifier for a FINAL component of a SUBSTRING. |
static int |
GREATER_OR_EQUAL
Search Filter Identifier for a GREATER_OR_EQUAL component. |
static int |
INITIAL
Search Filter Identifier for an INITIAL component of a SUBSTRING. |
static int |
LESS_OR_EQUAL
Search Filter Identifier for a LESS_OR_EQUAL component. |
static int |
NOT
Search Filter Identifier for a NOT component. |
static int |
OR
Search Filter Identifier for an OR component. |
static int |
PRESENT
Search Filter Identifier for a PRESENT component. |
static int |
SUBSTRINGS
Search Filter Identifier for a SUBSTRINGS component. |
Fields inherited from class com.novell.ldap.LDAPMessage |
ABANDON_REQUEST, ADD_REQUEST, ADD_RESPONSE, BIND_REQUEST, BIND_RESPONSE, COMPARE_REQUEST, COMPARE_RESPONSE, DEL_REQUEST, DEL_RESPONSE, EXTENDED_REQUEST, EXTENDED_RESPONSE, INTERMEDIATE_RESPONSE, message, MODIFY_RDN_REQUEST, MODIFY_RDN_RESPONSE, MODIFY_REQUEST, MODIFY_RESPONSE, SEARCH_REQUEST, SEARCH_RESPONSE, SEARCH_RESULT, SEARCH_RESULT_REFERENCE, UNBIND_REQUEST |
Constructor Summary | |
LDAPSearchRequest()
This constructor was added to support default Serialization |
|
LDAPSearchRequest(java.lang.String base,
int scope,
com.novell.ldap.rfc2251.RfcFilter filter,
java.lang.String[] attrs,
int dereference,
int maxResults,
int serverTimeLimit,
boolean typesOnly,
LDAPControl[] cont)
Constructs an LDAP Search Request with a filter in ASN1 format. |
|
LDAPSearchRequest(java.lang.String base,
int scope,
java.lang.String filter,
java.lang.String[] attrs,
int dereference,
int maxResults,
int serverTimeLimit,
boolean typesOnly,
LDAPControl[] cont)
Constructs an LDAP Search Request. |
Method Summary | |
java.lang.String[] |
getAttributes()
Retrieves an array of attribute names to request for in a search. |
int |
getDereference()
Retrieves the behaviour of dereferencing aliases on a search request. |
java.lang.String |
getDN()
Retrieves the Base DN for a search request. |
int |
getMaxResults()
Retrieves the maximum number of entries to be returned on a search. |
int |
getScope()
Retrieves the scope of a search request. |
java.util.Iterator |
getSearchFilter()
Retrieves an Iterator object representing the parsed filter for this search request. |
int |
getServerTimeLimit()
Retrieves the server time limit for a search request. |
java.lang.String |
getStringFilter()
Creates a string representation of the filter in this search request. |
boolean |
isTypesOnly()
Retrieves whether attribute values or only attribute types(names) should be returned in a search request. |
protected void |
setDeserializedValues(LDAPMessage readObject,
com.novell.ldap.rfc2251.RfcControls asn1Ctrls)
|
Methods inherited from class com.novell.ldap.LDAPMessage |
getControls, getMessageID, getTag, getType, isRequest, readDSML, readExternal, setTag, toString, writeDSML, writeExternal |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
public static final int AND
public static final int OR
public static final int NOT
public static final int EQUALITY_MATCH
public static final int SUBSTRINGS
public static final int GREATER_OR_EQUAL
public static final int LESS_OR_EQUAL
public static final int PRESENT
public static final int APPROX_MATCH
public static final int EXTENSIBLE_MATCH
public static final int INITIAL
public static final int ANY
public static final int FINAL
Constructor Detail |
public LDAPSearchRequest()
public LDAPSearchRequest(java.lang.String base, int scope, java.lang.String filter, java.lang.String[] attrs, int dereference, int maxResults, int serverTimeLimit, boolean typesOnly, LDAPControl[] cont) throws LDAPException
base
- The base distinguished name to search from.
scope
- The scope of the entries to search. The following
are the valid options:
filter
- The search filter specifying the search criteria.
attrs
- The names of attributes to retrieve.
operation exceeds the time limit.
dereference
- Specifies when aliases should be dereferenced.
Must be one of the constants defined in
LDAPConstraints, which are DEREF_NEVER,
DEREF_FINDING, DEREF_SEARCHING, or DEREF_ALWAYS.
maxResults
- The maximum number of search results to return
for a search request.
The search operation will be terminated by the server
with an LDAPException.SIZE_LIMIT_EXCEEDED if the
number of results exceed the maximum.
serverTimeLimit
- The maximum time in seconds that the server
should spend returning search results. This is a
server-enforced limit. A value of 0 means
no time limit.
typesOnly
- If true, returns the names but not the values of
the attributes found. If false, returns the
names and values for attributes found.
cont
- Any controls that apply to the search request.
or null if none.LDAPConnection.search(java.lang.String, int, java.lang.String, java.lang.String[], boolean)
,
LDAPSearchConstraints
public LDAPSearchRequest(java.lang.String base, int scope, com.novell.ldap.rfc2251.RfcFilter filter, java.lang.String[] attrs, int dereference, int maxResults, int serverTimeLimit, boolean typesOnly, LDAPControl[] cont)
base
- The base distinguished name to search from.
scope
- The scope of the entries to search. The following
are the valid options:
filter
- The search filter specifying the search criteria.
attrs
- The names of attributes to retrieve.
operation exceeds the time limit.
dereference
- Specifies when aliases should be dereferenced.
Must be either one of the constants defined in
LDAPConstraints, which are DEREF_NEVER,
DEREF_FINDING, DEREF_SEARCHING, or DEREF_ALWAYS.
maxResults
- The maximum number of search results to return
for a search request.
The search operation will be terminated by the server
with an LDAPException.SIZE_LIMIT_EXCEEDED if the
number of results exceed the maximum.
serverTimeLimit
- The maximum time in seconds that the server
should spend returning search results. This is a
server-enforced limit. A value of 0 means
no time limit.
typesOnly
- If true, returns the names but not the values of
the attributes found. If false, returns the
names and values for attributes found.
cont
- Any controls that apply to the search request.
or null if none.LDAPConnection.search(java.lang.String, int, java.lang.String, java.lang.String[], boolean)
,
LDAPSearchConstraints
Method Detail |
public java.lang.String getDN()
public int getScope()
LDAPConnection.SCOPE_BASE
,
LDAPConnection.SCOPE_ONE
,
* @see com.novell.ldap.LDAPConnection#SCOPE_SUBORDINATESUBTREE
public int getDereference()
LDAPSearchConstraints.DEREF_ALWAYS
,
LDAPSearchConstraints.DEREF_FINDING
,
LDAPSearchConstraints.DEREF_NEVER
,
LDAPSearchConstraints.DEREF_SEARCHING
public int getMaxResults()
public int getServerTimeLimit()
public boolean isTypesOnly()
public java.lang.String[] getAttributes()
public java.lang.String getStringFilter()
public java.util.Iterator getSearchFilter()
The first object returned from the Iterator is an Integer indicating the type of filter component. One or more values follow the component type as subsequent items in the Iterator. The pattern of Integer component type followed by values continues until the end of the filter.
Values returned as a byte array may represent UTF-8 characters or may be binary values. The possible Integer components of a search filter and the associated values that follow are:
protected void setDeserializedValues(LDAPMessage readObject, com.novell.ldap.rfc2251.RfcControls asn1Ctrls) throws java.io.IOException, java.lang.ClassNotFoundException
setDeserializedValues
in class LDAPMessage
java.io.IOException
java.lang.ClassNotFoundException
|
LDAP Classes Implements Java LDAP |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |