Contains the functionality for performing LDAP queries.
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
LDAP_AUTH_SIMPLE
public static final int LDAP_AUTH_SIMPLE
Value that represents LDAP "simple" authentication mode.
Note that in this authentication mode passwords are transmitted in cleartext.
See section 4.2.2 of
RFC2251 (Lightweight Directory Access Protocol (v3))
for details about LDAP authentication modes.
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
LDAP_CONN_DEFAULT
public static final int LDAP_CONN_DEFAULT
Value that represents a "default" LDAP connection type.
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
LDAP_CONN_SSL_OR_TLS
public static final int LDAP_CONN_SSL_OR_TLS
Value that represents an "SSL or TLS" LDAP connection type.
This causes the connection to use the "ldaps" protocol and the URL used by this object will
begin with "ldaps://". The default port for this protocol is 636. Note that the usage of
ldaps was deprecated along with LDAPv2. Also, note that ldaps was never formally specified.
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
LDAP_ERROR_ATTRIBUTE_IN_USE_EXCEPTION
public static final int LDAP_ERROR_ATTRIBUTE_IN_USE_EXCEPTION
Since:
JDE 4.0.0
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
LDAP_ERROR_ATTRIBUTE_MODIFICATION_EXCEPTION
public static final int LDAP_ERROR_ATTRIBUTE_MODIFICATION_EXCEPTION
Since:
JDE 4.0.0
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
LDAP_ERROR_AUTHENTICATION_EXCEPTION
public static final int LDAP_ERROR_AUTHENTICATION_EXCEPTION
Since:
JDE 4.0.0
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
LDAP_ERROR_AUTHENTICATION_NOT_SUPPORTED_EXCEPTION
public static final int LDAP_ERROR_AUTHENTICATION_NOT_SUPPORTED_EXCEPTION
Since:
JDE 4.0.0
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
LDAP_ERROR_BAD_DEFAULT_AUTHENTICATION_EXCEPTION
public static final int LDAP_ERROR_BAD_DEFAULT_AUTHENTICATION_EXCEPTION
Since:
JDE 4.3.0
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
LDAP_ERROR_CANNOT_PROCEED_EXCEPTION
public static final int LDAP_ERROR_CANNOT_PROCEED_EXCEPTION
Since:
JDE 4.0.0
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
LDAP_ERROR_COMMUNICATION_EXCEPTION
public static final int LDAP_ERROR_COMMUNICATION_EXCEPTION
Since:
JDE 4.0.0
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
LDAP_ERROR_CONFIGURATION_EXCEPTION
public static final int LDAP_ERROR_CONFIGURATION_EXCEPTION
Since:
JDE 4.0.0
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
LDAP_ERROR_CONTEXT_NOT_EMPTY_EXCEPTION
public static final int LDAP_ERROR_CONTEXT_NOT_EMPTY_EXCEPTION
Since:
JDE 4.0.0
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
LDAP_ERROR_INSUFFICIENT_RESOURCES_EXCEPTION
public static final int LDAP_ERROR_INSUFFICIENT_RESOURCES_EXCEPTION
Since:
JDE 4.0.0
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
LDAP_ERROR_INTERNAL_PROXY_PROVIDER_ERROR
public static final int LDAP_ERROR_INTERNAL_PROXY_PROVIDER_ERROR
Since:
JDE 4.0.0
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
LDAP_ERROR_INTERRUPTED_NAMING_EXCEPTION
public static final int LDAP_ERROR_INTERRUPTED_NAMING_EXCEPTION
Since:
JDE 4.0.0
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
LDAP_ERROR_INVALID_ATTRIBUTE_IDENTIFIER_EXCEPTION
public static final int LDAP_ERROR_INVALID_ATTRIBUTE_IDENTIFIER_EXCEPTION
Since:
JDE 4.0.0
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
LDAP_ERROR_INVALID_ATTRIBUTE_VALUE_EXCEPTION
public static final int LDAP_ERROR_INVALID_ATTRIBUTE_VALUE_EXCEPTION
Since:
JDE 4.0.0
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
LDAP_ERROR_INVALID_ATTRIBUTES_EXCEPTION
public static final int LDAP_ERROR_INVALID_ATTRIBUTES_EXCEPTION
Since:
JDE 4.0.0
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
LDAP_ERROR_INVALID_NAME_EXCEPTION
public static final int LDAP_ERROR_INVALID_NAME_EXCEPTION
Since:
JDE 4.0.0
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
LDAP_ERROR_INVALID_SCOPE_SYNTAX
public static final int LDAP_ERROR_INVALID_SCOPE_SYNTAX
Since:
JDE 4.0.0
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
LDAP_ERROR_INVALID_SEARCH_CONTROLS_EXCEPTION
public static final int LDAP_ERROR_INVALID_SEARCH_CONTROLS_EXCEPTION
Since:
JDE 4.0.0
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
LDAP_ERROR_INVALID_SEARCH_FILTER_EXCEPTION
public static final int LDAP_ERROR_INVALID_SEARCH_FILTER_EXCEPTION
Since:
JDE 4.0.0
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
LDAP_ERROR_LIMIT_EXCEEDED_EXCEPTION
public static final int LDAP_ERROR_LIMIT_EXCEEDED_EXCEPTION
Since:
JDE 4.0.0
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
LDAP_ERROR_LINK_EXCEPTION
public static final int LDAP_ERROR_LINK_EXCEPTION
Since:
JDE 4.0.0
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
LDAP_ERROR_NAME_ALREADY_BOUND_EXCEPTION
public static final int LDAP_ERROR_NAME_ALREADY_BOUND_EXCEPTION
Since:
JDE 4.0.0
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
LDAP_ERROR_NAME_NOT_FOUND_EXCEPTION
public static final int LDAP_ERROR_NAME_NOT_FOUND_EXCEPTION
Since:
JDE 4.0.0
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
LDAP_ERROR_NAMING_SECURITY_EXCEPTION
public static final int LDAP_ERROR_NAMING_SECURITY_EXCEPTION
Since:
JDE 4.0.0
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
LDAP_ERROR_NO_DEFAULT_SERVER
public static final int LDAP_ERROR_NO_DEFAULT_SERVER
Since:
JDE 4.0.0
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
LDAP_ERROR_NO_INITIAL_CONTEXT_EXCEPTION
public static final int LDAP_ERROR_NO_INITIAL_CONTEXT_EXCEPTION
Since:
JDE 4.0.0
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
LDAP_ERROR_NO_PERMISSION_EXCEPTION
public static final int LDAP_ERROR_NO_PERMISSION_EXCEPTION
Since:
JDE 4.0.0
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
LDAP_ERROR_NO_SERVICE_BOOK_EXCEPTION
public static final int LDAP_ERROR_NO_SERVICE_BOOK_EXCEPTION
Since:
JDE 4.0.0
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
LDAP_ERROR_NO_SUCH_ATTRIBUTE_EXCEPTION
public static final int LDAP_ERROR_NO_SUCH_ATTRIBUTE_EXCEPTION
Since:
JDE 4.0.0
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
LDAP_ERROR_NOT_CONTEXT_EXCEPTION
public static final int LDAP_ERROR_NOT_CONTEXT_EXCEPTION
Since:
JDE 4.0.0
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
LDAP_ERROR_OPERATION_NOT_SUPPORTED_EXCEPTION
public static final int LDAP_ERROR_OPERATION_NOT_SUPPORTED_EXCEPTION
Since:
JDE 4.0.0
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
LDAP_ERROR_PARTIAL_RESULT_EXCEPTION
public static final int LDAP_ERROR_PARTIAL_RESULT_EXCEPTION
Since:
JDE 4.0.0
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
LDAP_ERROR_RADIO_IS_OFF
public static final int LDAP_ERROR_RADIO_IS_OFF
Since:
JDE 4.0.0
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
LDAP_ERROR_REFERRAL_EXCEPTION
public static final int LDAP_ERROR_REFERRAL_EXCEPTION
Since:
JDE 4.0.0
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
LDAP_ERROR_SCHEMA_VIOLATION_EXCEPTION
public static final int LDAP_ERROR_SCHEMA_VIOLATION_EXCEPTION
Since:
JDE 4.0.0
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
LDAP_ERROR_SERVICE_UNAVAILABLE_EXCEPTION
public static final int LDAP_ERROR_SERVICE_UNAVAILABLE_EXCEPTION
Since:
JDE 4.0.0
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
LDAP_ERROR_SSL_HANDSHAKE_EXCEPTION
public static final int LDAP_ERROR_SSL_HANDSHAKE_EXCEPTION
Since:
JDE 4.3.0
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
LDAP_ERROR_TIMEOUT
public static final int LDAP_ERROR_TIMEOUT
Since:
JDE 4.0.0
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
LDAP_ERROR_UNKNOWN
public static final int LDAP_ERROR_UNKNOWN
Since:
JDE 4.0.0
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
LDAP_SCOPE_BASE
public static final int LDAP_SCOPE_BASE
Value that represents LDAP search scope of "base".
This search scope only returns the entry at the base DN, yielding at most one returned
result. Zero results will be returned if the single LDAP entry does not match the
search criteria.
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
LDAP_SCOPE_ONE
public static final int LDAP_SCOPE_ONE
Value that represents LDAP search scope of "one".
This search scope searches exactly one level below the base DN. Notably, this does
NOT include the base DN itself nor any entries two or more levels below it.
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
LDAP_SCOPE_SUB
public static final int LDAP_SCOPE_SUB
Value that represents LDAP search scope of "subtree".
This search scope searches the base DN and all levels below it.
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
LDAP_SUCCESS
public static final int LDAP_SUCCESS
Since:
JDE 4.0.0
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Constructor Detail
LDAPQuery
public LDAPQuery()
Creates an LDAPQuery object.
The parameters of the query must be specified by invoking the addXXX() and
setXXX() methods of this object.
Since:
JDE 4.0.0
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
The parameters of the query must be specified by invoking the addXXX() and
setXXX() methods of this object.
Parameters:
listener - An LDAPListener object that will be added to this object's list
of listeners; this can also be done after object creation using addListener(LDAPListener);
may be null in which case no listener will be added.
Since:
JDE 4.0.0
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
listener - An LDAPListener object that will be added to this object's list
of listeners; this can also be done after object creation using addListener(LDAPListener);
may be null in which case no listener will be added.
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Method Detail
abort
public void abort()
Aborts the current query (if a query is currently running).
Since:
JDE 4.0.0
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Adds an attribute to the list of attributes that will be requested to be returned from the server.
If this method is not called to specify the attributes to return, then all attributes will be returned.
Note:: This method may be called multiple times.
Parameters:
oid - The String representation of the oid to request.
Throws:
LDAPInvalidOperationException - Thrown if an LDAP query using the current object is already running
or if a non-null URL was specified to the constructor.
LDAPBadSyntaxException - Thrown if the parameter contains invalid characters;
although there are more invalid characters according to RFC2255, this exception is only thrown
if the parameter contains the "question mark" (?) character.
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Adds a filter to the query.
A filter is used to restrict the output from the query.
A filter is comprised of an OID and value pair with optional wildcard '*'.
More complex filters can be specified using compound statements.
A compound filter is combined with either an '&' (Logical AND) or a '|' (Logical OR).
An example of a compound filter is: '(&(givenname=Bob)(sn=Smith))'
Examples of filters are:
addFilter("(givenname=Bob)") would return all the entries who's first name is 'Bob'
addFilter("(givenname=Bo*)") would return all the entries who's first name starts with 'Bo'
addFilter("(givenname=*o*)") would return all the entries who's first name contains an 'o'
addFilter("(givenname=*)") would return all the entries who have a first name
Examples of compound filters are:
addFilter("(|(givenname=Bob)(givenname=Ted))") would return all the entries who's first name is 'Bob' or 'Ted'
addFilter("(&(givenname=Bob)(sn=Smith))") would return all the entries who's first name is 'Bob' and last name is 'Smith'
Note: all filters added are joined together with an AND.
Note: all filters must be contained by opening and closing round braces. See examples above.
Parameters:
filter - The String represenation of the filter to add.
Throws:
LDAPInvalidOperationException - Thrown if an LDAP query using the current object is already running
or if a non-null URL was specified to the constructor.
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Adds a filter to the query.
A filter is used to restrict the output from the query.
A filter is comprised of an OID and value pair with optional wildcard '*'.
For example:
addFilter("givenname","Bob") would return all the entries who's first name is 'Bob'
addFilter("givenname","Bo*") would return all the entries who's first name starts with 'Bo'
addFilter("givenname","*o*") would return all the entries who's first name contains an 'o'
addFilter("givenname","*") would return all the entries who have a first name
addFilter("givenname","Bob;Alice;Dick") would return all the entries who have a first name of Bob, Alice or Dick
Note: all filters added are joined together with an AND.
Parameters:
oid - The String representation of the new filter's oid. Must not be empty or null.
value - The value of the requested oid. Must not be null. Multiple values may be separated by ';'
Throws:
LDAPInvalidOperationException - Thrown if an LDAP query using the current object is already running
or if a non-null URL was specified to the constructor.
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
This method blocks if the specified entry has not been recieved yet.
Parameters:
index - The entry to retrieve.
Returns:
The requested entry or null if there is no such entry or the query is interrupted.
Since:
JDE 4.0.0
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
getErrorCode
public int getErrorCode()
Returns the error code describing any error that might have occurred during processing of the query.
If no error code ocurred during this query then this method will return LDAPQuery.LDAP_SUCCESS.
Returns:
the error code describing any error that might have occurred during processing of the query
as specified above.
Since:
JDE 4.0.0
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Returns a string describing any error that might have occurred during processing of the query.
This method may return null if no error message was available.
Returns:
a string describing any error that might have occurred during processing of the query
as specified above.
Since:
JDE 4.0.0
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Performs a blocking fetch to retrieve all of the results.
This method will not return until all results have been retrieved.
Note: This method will return an empty Enumeration if the
query has not yet been started or was aborted.
Returns:
an enumeration of LDAPEntry objects as specified above.
Since:
JDE 4.0.0
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
getResultSize
public int getResultSize()
Returns the number of results recieved from the query.
Returns:
the number of results recieved from the query or -1 if the query either
has not been started or was aborted.
Since:
JDE 4.0.0
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
isRunning
public boolean isRunning()
Checks to see if the query has been started.
Returns:
true if the query is currently running; false otherwise.
Since:
JDE 4.0.0
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
listener - LDAP listener to remove from this query; if null or a listener
that is not currently registered with this object then this method does nothing.
Since:
JDE 4.0.0
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Sets the type of authentication that should be used during this query.
The authType parameter must be equal to one of the LDAP_AUTH_
constants defined in this class. Examples include LDAP_AUTH_SIMPLE and
LDAP_AUTH_ANONYMOUS.
Parameters:
authType - the authentication type that is to be used for this connection.
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Sets the type of connection that should be used during this query.
The connectionType parameter must be equal to one of the LDAP_CONN_
constants defined in this class. Examples include LDAP_CONN_DEFAULT and
LDAP_CONN_SSL_OR_TLS.
Parameters:
connectionType - the connection type that is to be used.
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
This method determines which LDAP directory will be queried for the information requested.
Additionally, a specific subtree can be searched by specifing the subtree as the baseQuery parameter.
If this method is not called prior to starting the query then the MDS will substitute the administrator configured default values.
Parameters:
server - The hostname or IP Address of the server to query.
port - The port number that the LDAP server is listening on. (Default LDAP port is normally 389)
baseQuery - The base query for the searchspace.
Throws:
LDAPInvalidOperationException - Thrown if an LDAP query using the current object is already running
or if a non-null URL was specified to the constructor.
LDAPBadSyntaxException - Thrown if any of the parameters is null or contains invalid characters.
Since:
JDE 4.0.0
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
LDAPInvalidOperationException - Thrown if an LDAP query using the current object is already running
or if a non-null URL was specified to the constructor.
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Copyright 1999-2008 Research In Motion Limited. 295 Phillip Street, Waterloo, Ontario, Canada, N2L 3W8. All Rights Reserved. Copyright 1993-2003 Sun Microsystems, Inc. 901 San Antonio Road, Palo Alto, California, 94303, U.S.A. Copyright 2002-2003 Nokia Corporation All Rights Reserved. Java is a trademark or registered trademark of Sun Microsystems, Inc. in the US and other countries.