org.pentaho.di.trans.steps.ldapinput

Class LdapProtocol

java.lang.Object

org.pentaho.di.trans.steps.ldapinput.LdapProtocol

Direct Known Subclasses:

LdapSslProtocol

public class LdapProtocol
extends Object

Class encapsulating Ldap protocol configuration

Constructor Summary

Constructors

Constructor and Description
LdapProtocol(LogChannelInterface log, VariableSpace variableSpace, LdapMeta meta, Collection<String> binaryAttributes)

Method Summary

Modifier and Type	Method and Description
void	close()
void	connect(String username, String password)
protected InitialLdapContext	createLdapContext(Hashtable<String,String> env)
protected void	doConnect(String username, String password)
protected String	getConnectionPrefix()
InitialLdapContext	getCtx()
static String	getName() Method signature used by factory to get display name, method should exist in every ldap protocol
protected void	setupEnvironment(Map<String,String> env, String username, String password)

Methods inherited from class java.lang.Object

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

Constructor Detail

LdapProtocol

public LdapProtocol(LogChannelInterface log,
                    VariableSpace variableSpace,
                    LdapMeta meta,
                    Collection<String> binaryAttributes)

Method Detail

getCtx

public InitialLdapContext getCtx()

getConnectionPrefix

protected String getConnectionPrefix()

getName

public static String getName()

Method signature used by factory to get display name, method should exist in every ldap protocol

Returns:

the display name

setupEnvironment

protected void setupEnvironment(Map<String,String> env,
                                String username,
                                String password)
                         throws KettleException

Throws:

KettleException

createLdapContext

protected InitialLdapContext createLdapContext(Hashtable<String,String> env)
                                        throws NamingException

Throws:

NamingException

doConnect

protected void doConnect(String username,
                         String password)
                  throws KettleException

Throws:

KettleException

connect

public final void connect(String username,
                          String password)
                   throws KettleException

Throws:

KettleException

close

public void close()
           throws KettleException

Throws:

KettleException