com.opencloud.slee.resources.ldap

Interface LDAPSearchActivity

public interface LDAPSearchActivity

This activity represents an LDAP Connection.

See Also:

Connection

Field Summary

Fields

Modifier and Type	Field and Description
static int	SCOPE_BASE search only the base DN
static int	SCOPE_ONE search only entries under the base DN
static int	SCOPE_SUB search the base DN and all entries within its subtree

Method Summary

Methods

Modifier and Type	Method and Description
boolean	isBound() Reports whether the connection is bound with the LDAP Server
boolean	isConnected() Reports whether this connection is connected to an LDAP server
boolean	isConnectionAlive() Reports whether the connection with the LDAP Server is still open
boolean	isTLS() Reports whether it is a secure connection
void	search(java.lang.String base, int scope, java.lang.String filter, java.lang.String[] attrs, boolean typesOnly, SearchConstraints searchConstraints) Performs the search specified by the criteria that you enter.

Field Detail

SCOPE_BASE

static final int SCOPE_BASE

search only the base DN

See Also:

Constant Field Values

SCOPE_ONE

static final int SCOPE_ONE

search only entries under the base DN

See Also:

Constant Field Values

SCOPE_SUB

static final int SCOPE_SUB

search the base DN and all entries within its subtree

See Also:

Constant Field Values

Method Detail

isBound

boolean isBound()

Reports whether the connection is bound with the LDAP Server

Returns:

true if it is bound

isConnected

boolean isConnected()

Reports whether this connection is connected to an LDAP server

Returns:

true if it is connected

isConnectionAlive

boolean isConnectionAlive()

Reports whether the connection with the LDAP Server is still open

Returns:

true if the connection is open

isTLS

boolean isTLS()

Reports whether it is a secure connection

Returns:

true if it is secure

search

void search(java.lang.String base,
          int scope,
          java.lang.String filter,
          java.lang.String[] attrs,
          boolean typesOnly,
          SearchConstraints searchConstraints)
            throws SearchException

Performs the search specified by the criteria that you enter. This method also allows you to specify constraints for the search (such as the maximum time to wait for search results).

Parameters:

base - the base distinguished name from which to search

scope - the scope of the entries to search. You can specify one of the following:

1. LDAPv2.SCOPE_BASE (search only the base DN)
2. LDAPv2.SCOPE_ONE (search only entries under the base DN)
3. LDAPv2.SCOPE_SUB (search the base DN and all entries within its subtree)

filter - search filter specifying the search criteria

attrs - list of attributes to return in the search results

typesOnly - if true, returns the names but not the values of the attributes found. If false, returns the names and values for attributes found

searchConstraints - constraints specific to this search

Throws:

SearchException - Failed to complete the specified search.

See Also:

SearchConstraints, SearchResults