Package com.basis.api.admin

Interface BBjAdminLDAPSearch

All Superinterfaces:

BBjAdminCommitPropertyWriter, BBjAdminCommitWriter, BBjAdminPropertyReader, BBjAdminPropertyWriter, Remote, Serializable

public interface BBjAdminLDAPSearch
extends BBjAdminCommitPropertyWriter, Serializable

Contains the definition for an LDAP search query that is compatible with the information needed by the UnboundID LDAP SDK.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	BASE_DN
static final String	DEREFERENCE_POLICY
static final String	FILTER
static final String	NAME
static final String	SCOPE
static final String	SIZE_LIMIT
static final String	TIME_LIMIT

Method Summary

Modifier and Type	Method	Description
BBjAdminList<String[]>	execute(String p_host, int p_port, int p_timeout, String p_prependOrBindDN, String p_append, String p_user, String p_password)	Executes the search and returns the results as a list of string arrays.
BBjAdminList<String[]>	execute(String p_host, int p_port, String p_prependOrBindDN, String p_append, String p_user, String p_password)	Executes the search and returns the results as a list of string arrays.

Methods inherited from interface com.basis.api.admin.BBjAdminCommitPropertyWriter

getChangedProperties, getClearedProperties, getOriginalProperties

Methods inherited from interface com.basis.api.admin.BBjAdminCommitWriter

commit, rollback

Methods inherited from interface com.basis.api.admin.BBjAdminPropertyReader

checkValueEqual, contains, contains, getBoolean, getDouble, getInt, getList, getLong, getProperties, getString, getType, getTypes, getValue

Methods inherited from interface com.basis.api.admin.BBjAdminPropertyWriter

addType, canAddNewProperties, canClear, clear, clearProperties, clearProperty, getReadOnly, hasChanged, isReadOnly, setBoolean, setDouble, setInt, setList, setLong, setProperties, setString, setValue

Field Details

NAME

static final String NAME

See Also:

• Constant Field Values

BASE_DN

static final String BASE_DN

See Also:

• Constant Field Values

FILTER

static final String FILTER

See Also:

• Constant Field Values

DEREFERENCE_POLICY

static final String DEREFERENCE_POLICY

See Also:

• Constant Field Values

SIZE_LIMIT

static final String SIZE_LIMIT

See Also:

• Constant Field Values

TIME_LIMIT

static final String TIME_LIMIT

See Also:

• Constant Field Values

SCOPE

static final String SCOPE

See Also:

• Constant Field Values

Method Details

execute

BBjAdminList<String[]> execute(String p_host,
 int p_port,
 String p_prependOrBindDN,
 String p_append,
 String p_user,
 String p_password)
                        throws BBjAdminException

Executes the search and returns the results as a list of string arrays. To execute the query on a secure server using LDAPS, the host should include ldaps:// in front of it. For example:
ldaps://myldap.myserver.com

Parameters:

p_host - Host name for the LDAP server. Use ldaps:// in front of the host name for a secure, LDAPS connection.

p_port -

p_prependOrBindDN -

p_append -

p_user -

p_password -

Throws:

BBjAdminException

execute

BBjAdminList<String[]> execute(String p_host,
 int p_port,
 int p_timeout,
 String p_prependOrBindDN,
 String p_append,
 String p_user,
 String p_password)
                        throws BBjAdminException

Executes the search and returns the results as a list of string arrays. To execute the query on a secure server using LDAPS, the host should include ldaps:// in front of it. For example:
ldaps://myldap.myserver.com

Parameters:

p_host - Host name for the LDAP server. Use ldaps:// in front of the host name for a secure, LDAPS connection.

p_port -

p_timeout -

p_prependOrBindDN -

p_append -

p_user -

p_password -

Throws:

BBjAdminException