com.knowgate.ldap

Interface LDAPManager

All Superinterfaces:

AutoCloseable

public interface LDAPManager
extends AutoCloseable

LDAP Manager Interface

Version:

2.0

Author:

Sergio Montoro Ten

Method Summary

Modifier and Type	Method and Description
void	add(String sDN, Map<String,Object> mAttributes) Add an LDAP entry
void	bind(String sUser, String sPass) Synchronously authenticates to the LDAP server using LDAP_V3.
void	close() Synchronously disconnects from the LDAP server
void	connect(String sConnStr) Connect to LDAP Service
void	connectAndBind(Map<String,String> oProps) Connect to LDAP Server using a Properties object
void	delete(String sDN) Delete an LDAP entry
String	exists(String sSearchString) Check whether or not an LDAP entry exists
String	getPartitionName()
void	modify(String sDN, Map<String,Object> mAttributes) Modify an LDAP entry
LDAPEntry	read(String sDN, String[] aAttrs)
List<String>	search(String sSearchString, int iLimit)
void	setPartitionName(String sName)

Method Detail

connect

void connect(String sConnStr)
      throws LDAPException

Connect to LDAP Service

At this point, there is no authentication, and any operations are conducted as an anonymous client.

Parameters:

sConnStr - ldap://host:port/distinguished_name
Example "ldap://fobos.kg.int:389/dc=knowgate,dc=org"

Throws:

LDAPException

connectAndBind

void connectAndBind(Map<String,String> oProps)
             throws LDAPException

Connect to LDAP Server using a Properties object

Parameters:

oProps - Map<String,String> for connecting to LDAP server.
For example :
ldapconnect=ldap://fobos.kg.int:389/dc=knowgate,dc=org
ldapuser=cn=Manager,dc=knowgate,dc=org
ldappassword=manager

Throws:

LDAPException

bind

void bind(String sUser,
          String sPass)
   throws LDAPException

Synchronously authenticates to the LDAP server using LDAP_V3.

If the object has been disconnected from an LDAP server, this method attempts to reconnect to the server. If the object has already authenticated, the old authentication is discarded.

Parameters:

sUser - If non-null and non-empty, specifies that the connection and all operations through it should be authenticated with dn as the distinguished name.

sPass - If non-null and non-empty, specifies that the connection and all operations through it should be authenticated with dn as the distinguished name and passwd as password.

Throws:

LDAPException

IllegalStateException - If not connected to LDAP

close

void close()
    throws LDAPException

Synchronously disconnects from the LDAP server

The disconnect method abandons any outstanding requests, issues an unbind request to the server, and then closes the socket.

Specified by:

close in interface AutoCloseable

Throws:

LDAPException

add

void add(String sDN,
         Map<String,Object> mAttributes)
  throws LDAPException

Add an LDAP entry

Parameters:

sDN - String

mAttributes - Map“String,Object”

Throws:

LDAPException

modify

void modify(String sDN,
            Map<String,Object> mAttributes)
     throws LDAPException

Modify an LDAP entry

Parameters:

sDN - String

mAttributes - Map“String,Object”

Throws:

LDAPException

read

LDAPEntry read(String sDN,
               String[] aAttrs)
        throws LDAPException

Throws:

LDAPException

search

List<String> search(String sSearchString,
                    int iLimit)
             throws LDAPException

Throws:

LDAPException

exists

String exists(String sSearchString)
       throws LDAPException

Check whether or not an LDAP entry exists

The directory is searched from the connection string key.
For example if ldapconnect connection property is ldap://192.168.1.1:389/dc=auth,dc=com then only entries under "dc=auth,dc=com" will be searched

Parameters:

sSearchString - String LDAP search string, for example "(&(ou=Users)(cn=johnp))"

Returns:

String DN of firt entry found match the search criteria or null if no entry was found matching the criteria

Throws:

LDAPException

delete

void delete(String sDN)
     throws LDAPException

Delete an LDAP entry

Parameters:

sDN - String

Throws:

LDAPException

getPartitionName

String getPartitionName()

setPartitionName

void setPartitionName(String sName)