JBStrap LDAP connection

The LDAPConnection class creates the connection between the application and the LDAP server. First, you have to instantiate the LDAPConnection class, then specify the connection parameters. Once you're done with this, call the connect() method to create the connection in the init() method of application startup class.

  Creating an LDAP connection using the LDAPConnection class  
         
try {
	// Instantiate the LDAPConnection class.
    new LDAPConnection()
			// Use the setter methods to set the connection details.
            .setProviderUrl("ldapProtocol://ldapHost:ldapPort")
            .setSecurityPrincipal("username@domain")
            .setSecurityCredentials("Password")
            .setDebugLevel("fine")
            .setTimeout(3000)
            .setInitialContextFactory("com.sun.jndi.ldap.LdapCtxFactory")
            .setDefaultSearchScope(LDAPSearchScope.SUBTREE_SCOPE)
            .setDefaultSearchDn(""OU=ExampleOrgUnit,DC=company,DC=com"")
			// Finally, call the connect() method to create the server connection.
            .connect();
}  catch (final NamingException e) {
    LOG.error("Cannot connect to LDAP server!");
}

You can set the following parameters:

  Setting the LDAP URL  
         
setProviderUrl(ldapProtocol://ldapHost:ldapPort)

  Setting whether an authentication is needed  
         
setSecurityAuthentication("true" or "false")

  Setting the authentication protocol  
         
setSecurityProtocol("ssl" or "plain")

  Setting a user name for the authentication  
         
setSecurityPrincipal("username@domain")

  Setting a password for the authentication  
         
setSecurityCredentials(password for username@domain)

  Setting the class for the authentication  
         
setInitialContextFactory("com.sun.jndi.ldap.LdapCtxFactory")

  An LDAP Referral provides a reference to an alternate location in which an LDAP Request may be processed  
         
setReferral("follow" or "throw" or "ignore")

  Setting the debug level  
         
setDebugLevel("fine" or "all")

  The string representation of an integer that represents the number of milliseconds that an idle connection may remain in the pool without being closed and removed from the pool  
         
setTimeout(3000)

  Setting the default search depth  
         
setDefaultSearchScope(LDAPSearchScope.SUBTREE_SCOPE or LDAPSearchScope.OBJECT_SCOPE or LDAPSearchScope.ONELEVEL_SCOPE)

  Setting the default search path  
         
setDefaultSearchDn("OU=ExampleOrgUnit,DC=company,DC=com")

  Setting the connection parameter (any LDAP parameters are accepted)  
         
setEnvironment("com.sun.jndi.ldap.connect.pool.maxsize", "1")