Package scriptella.driver.ldap

Class LdapConnection

java.lang.Object

scriptella.spi.AbstractConnection

scriptella.driver.ldap.LdapConnection

All Implemented Interfaces:

Connection

public class LdapConnection
extends AbstractConnection

Represents a connection to a directory context.

For configuration details and examples see overview page.

Version:

1.0

Author:

Fyodor Kupolov

Nested Class Summary

Nested classes/interfaces inherited from class scriptella.spi.AbstractConnection

AbstractConnection.StatementCounter

Field Summary

Fields

Modifier and Type	Field	Description
static final String	FILE_MAXLENGTH_KEY	Names of the Max File Length connection property.
static final String	SEARCH_BASEDN_KEY	Name of the Search base DN connection property.
static final String	SEARCH_COUNTLIMIT_KEY	Name of the Count Limit(maximum number of entries to be returned) connection property.
static final String	SEARCH_SCOPE_KEY	Name of the Search scope connection property.
static final String	SEARCH_TIMELIMIT_KEY	Name of the Time Limit connection property.

Fields inherited from class scriptella.spi.AbstractConnection

counter

Constructor Summary

Constructors

Constructor	Description
LdapConnection()
LdapConnection(ConnectionParameters parameters)	Creates a connnection to a directory.

Method Summary

Modifier and Type	Method	Description
void	close()	Closes the connection and releases all related resources.
void	executeQuery(Resource queryContent, ParametersCallback parametersCallback, QueryCallback queryCallback)	Executes a query specified by its content.
void	executeScript(Resource scriptContent, ParametersCallback parametersCallback)	Executes a script specified by its content.
AbstractConnection.StatementCounter	getProgressCounter()	Optional live progress counter.
protected void	initializeContext(Hashtable<String,Object> env)	Creates a directory context.

Methods inherited from class scriptella.spi.AbstractConnection

commit, getDialectIdentifier, getExecutedStatementsCount, isExecutedStatementsCountSupported, isReadonly, rollback, setDialectIdentifier, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface scriptella.spi.Connection

getUpdateCount

Field Details

SEARCH_SCOPE_KEY

public static final String SEARCH_SCOPE_KEY

Name of the Search scope connection property.

The value must be one of the: object, onelevel, subtree

See Also:

• SearchControls.setSearchScope(int)
• Constant Field Values

SEARCH_BASEDN_KEY

public static final String SEARCH_BASEDN_KEY

Name of the Search base DN connection property.

See Also:

• DirContext.search(String,javax.naming.directory.Attributes)
• Constant Field Values

SEARCH_TIMELIMIT_KEY

public static final String SEARCH_TIMELIMIT_KEY

Name of the Time Limit connection property.

The value must be integer.

See Also:

• SearchControls.setTimeLimit(int)
• Constant Field Values

SEARCH_COUNTLIMIT_KEY

public static final String SEARCH_COUNTLIMIT_KEY

Name of the Count Limit(maximum number of entries to be returned) connection property.

The value must be integer.

See Also:

• SearchControls.setCountLimit(long)
• Constant Field Values

FILE_MAXLENGTH_KEY

public static final String FILE_MAXLENGTH_KEY

Names of the Max File Length connection property.

This property specifies the maximum size in Kb of the external files referenced from LDIFs. The default value is 10000 (10MB)

See Also:

• Constant Field Values

Constructor Details

LdapConnection

public LdapConnection()

LdapConnection

public LdapConnection(ConnectionParameters parameters)

Creates a connnection to a directory.

Parameters:

parameters - parameters to establish connection.

Method Details

getProgressCounter

public AbstractConnection.StatementCounter getProgressCounter()

Description copied from interface: Connection

Optional live progress counter. Called on the execution thread only. Return a stable in-memory counter updated with the same semantics as Connection.getExecutedStatementsCount(), or null if unavailable. The reporter reads only its volatile value, never this connection. The counter must remain valid after close. Existing providers need not implement this method.

initializeContext

protected void initializeContext(Hashtable<String,Object> env)

Creates a directory context.

Parameters:

env - environment to create initial context.

executeScript

public void executeScript(Resource scriptContent,
 ParametersCallback parametersCallback)
                   throws ProviderException

Description copied from interface: Connection

Executes a script specified by its content.

scriptContent may be used as a key for caching purposes, i.e. provider may precompile scripts and use compiled versions for subsequent executions. Please note that only inline text resources can be safely cached.

Parameters:

scriptContent - script content. Cannot be null.

parametersCallback - callback to get parameter values. Cannot be null.

Throws:

ProviderException - if script execution failed.

executeQuery

public void executeQuery(Resource queryContent,
 ParametersCallback parametersCallback,
 QueryCallback queryCallback)
                  throws ProviderException

Description copied from interface: Connection

Executes a query specified by its content.

Parameters:

queryContent - query content. Cannot be null.

parametersCallback - callback to get parameter values. Cannot be null.

queryCallback - callback to call for each result set element produced by this query. Cannot be null.

Throws:

ProviderException - if query execution failed.

See Also:

• Connection.executeScript(scriptella.spi.Resource,scriptella.spi.ParametersCallback)

close

public void close()
           throws ProviderException

Description copied from interface: Connection

Closes the connection and releases all related resources.

Throws:

ProviderException - if a critical failure occured.