scriptella.driver.ldap

Class SearchFilterQuery

java.lang.Object

scriptella.driver.ldap.SearchFilterQuery

All Implemented Interfaces:

ParametersCallback

public class SearchFilterQuery
extends java.lang.Object
implements ParametersCallback

Represents an executor for LDAP search filter query(RFC 2254).

When execute(String) is called a virtual row set based on search results is produced.

The SearchResult.getAttributes() produces columns for a virtual row. The virtual row also contains dn and rdn columns representing a found entry DN and a relative DN respectively.

Version:

1.0

Author:

Fyodor Kupolov

Constructor Summary

Constructors

Constructor and Description
SearchFilterQuery(LdapConnection connection, ParametersCallback parameters, QueryCallback queryCallback) Instantiates an LDAP query.

Method Summary

Modifier and Type	Method and Description
void	execute(java.lang.String filter) Runs a search specified by filter on a connection.
java.lang.Object	getParameter(java.lang.String name) Returns the value of parameter specified by name.
protected javax.naming.NamingEnumeration<javax.naming.directory.SearchResult>	query(LdapConnection connection, java.lang.String filter)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SearchFilterQuery

public SearchFilterQuery(LdapConnection connection,
                         ParametersCallback parameters,
                         QueryCallback queryCallback)

Instantiates an LDAP query.

Parameters:

connection - ldap connection.

parameters - parent parameters callback to get unresolved variables from.

queryCallback - query callback to notify for search results.

Method Detail

getParameter

public java.lang.Object getParameter(java.lang.String name)

Description copied from interface: ParametersCallback

Returns the value of parameter specified by name.

The callback internally delegates a call to parent callbacks if the parameter cannot be found.

Specified by:

getParameter in interface ParametersCallback

Parameters:

name - parameter name. Providers are allowed (but not required) to ignore a case of the name parameter to comply with their internal model. For example JDBC drivers are case-insensitive to column names.

Returns:

parameter value or null if parameter doesn't exist.

execute

public void execute(java.lang.String filter)

Runs a search specified by filter on a connection.

For each search result QueryCallback.processRow(scriptella.spi.ParametersCallback) is called.

Parameters:

filter - search filter according to RFC 2254

See Also:

DirContext.search(javax.naming.Name, String, javax.naming.directory.SearchControls)

query

protected javax.naming.NamingEnumeration<javax.naming.directory.SearchResult> query(LdapConnection connection,
                                                                                    java.lang.String filter)
                                                                             throws javax.naming.NamingException

Throws:

javax.naming.NamingException