scriptella.driver.ldap
Class SearchFilterQuery

java.lang.Object
  scriptella.driver.ldap.SearchFilterQuery

All Implemented Interfaces:

scriptella.spi.ParametersCallback

public class SearchFilterQuery
extends java.lang.Object
implements scriptella.spi.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

SearchFilterQuery(LdapConnection connection, scriptella.spi.ParametersCallback parameters, scriptella.spi.QueryCallback queryCallback)
Instantiates an LDAP query.

Method Summary

void	execute(java.lang.String filter) Runs a search specified by filter on a connection.
java.lang.Object	getParameter(java.lang.String 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,
                         scriptella.spi.ParametersCallback parameters,
                         scriptella.spi.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)

Specified by:

getParameter in interface scriptella.spi.ParametersCallback

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