com.eibus.directory.soap

Class LDAPDirectory

java.lang.Object

com.eibus.directory.soap.LDAPDirectory

public class LDAPDirectory
extends java.lang.Object

An LDAPDirectory object holds a connection to an LDAP Server. Internally, the com.novell.ldap package is used. The LDAPDirectory class provides some helper functions that allow you to easily connect to the LDAP server. When a Cordys WCP is installed, the adminstrator has to provide the name of the LDAP server that can be used to connect. This LDAPDirectory class uses that setting to connect. This means, that by default, an anonymous connection to the LDAP server is made. This may not be sufficient in cases where there is tight LDAP access control. If a programmer wants to use this, he is himself responsible for connecting to the LDAP server.

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_PORT
static java.lang.String	ENTRY_UUID
static java.lang.String	LDAP_MAX_RESULT_KEY
static java.lang.String	LDAPCONTROL_CLASS
static int	SCOPE_BASE
static int	SCOPE_ONE
static int	SCOPE_SUB

Constructor Summary

Constructors

Constructor and Description
LDAPDirectory() Deprecated. use getDefaultInstance() API
LDAPDirectory(LDAPConnection connection) Create an LDAP proxy that can use the connection object.
LDAPDirectory(java.lang.String host, int port, java.lang.String user, java.lang.String password) Create an LDAP proxy to the specified host, on the specified port, and authenticate to it using the username and password
LDAPDirectory(java.lang.String host, int port, java.lang.String user, java.lang.String password, Cache cache) Deprecated. use LDAPDirectory(String host, int port, String user, String password).

Method Summary

Modifier and Type	Method and Description
void	add(LDAPEntry entry) Deprecated. this method does not allow passing a active user identity. Use LDAPManipulator instead.
void	clearCache()
void	delete(java.lang.String dn) Deprecated. this method does not allow passing a active user identity. Use LDAPManipulator instead.
protected void	finalize()
java.lang.String	findSOAPNode(java.lang.String namespace, java.lang.String method) Searches for a SOAP node within the default organizational context that can execute the method of the namespace.
java.lang.String	findSOAPNode(java.lang.String organizationalContext, java.lang.String namespace, java.lang.String method) Searches for a SOAP node within the specified organizational context that can execute the method of the namespace.
java.util.Map<java.lang.String,java.lang.String>	getAllRolesOfUser(java.lang.String organizationalUserDN)
java.util.Map<java.lang.String,java.lang.String>	getAssignedRolesOfUser(java.lang.String organizationalUserDN) Get AssignedRoles (including inherited) of a user.
LDAPEntry	getAuthenticationUser() Returns the aunthenticated user entry from the LDAP of the currently logged in user
LDAPEntry	getAuthenticationUser(java.lang.String osId)
Cache	getCache() Returns the internal Cache object used by this directory.
java.lang.String	getCacheStatistics()
LDAPConnection	getConnection() Returns the actual connection to ldap.
static LDAPDirectory	getDefaultInstance() Returns the default LDAP proxy to the host that is specified in the environment settings.
static int	getDefaultMaximumSearchResults() Get the default maximum search results from LDAP.
java.lang.String	getDirectorySearchRoot() Returns the default search root.
LDAPEntry	getEntry(java.lang.String name) If name is a Distinguished Name, a LDAPConnection.read() on this name is done.
java.lang.String	getOrganization() Returns the current organizational context.
java.lang.String	getOrganizationalUser() Returns the organizational user entry for the currently logged on user
java.lang.String	getOrganizationalUser(java.lang.String osId)
java.util.Map<java.lang.String,java.lang.String>	getRolesOfUser(java.lang.String organizationalUserDN) Deprecated.
java.lang.String[]	getURIs(java.lang.String name) Retrieves all URIs on which the SOAP Node that is registered for this name may be listening
java.lang.String	getUUID(LDAPEntry entry) Get the UUID of this LDAPEntry.
static void	initializeBootstrapFileTrigger()
boolean	isSOAPConnection() Check if the directory is connected directly to the LDAP server or uses the LDAP SOAP Processor
void	modify(LDAPEntry newEntry) Deprecated. this method does not allow passing a active user identity. Use LDAPManipulator instead.
LDAPEntry	read(java.lang.String dn) Method internally calls the LDAPConnection.read, but uses an internal cache
LDAPEntry	readWithUUID(java.lang.String searchRoot, java.lang.String uuid) Search LDAP for an entry with this uuid.
void	report() Deprecated. this method doesn't do anything anymore.
void	returnCookieConnection(java.lang.String cookie) Release LDAP Connection with cookie argument in LDAP Connection pool
LDAPEntry[]	search(java.lang.String dn, int scope, java.lang.String filter, java.lang.String[] attributes, boolean returnValues) It sends request to LDAP SOAP processor or LDAP Server based on LDAPDirectory instance to get the results.
LDAPEntry[]	search(java.lang.String dn, int scope, java.lang.String filter, java.lang.String[] attributes, boolean returnValues, LDAPSearchConstraints cons) It sends request to LDAP SOAP processor or LDAP Server based on LDAPDirectory instance to get the results.
java.lang.String	search(java.lang.String dn, int scope, java.lang.String filter, java.lang.String[] attributes, boolean returnValues, java.lang.String cookie, java.util.ArrayList<LDAPEntry> list) Serach LDAP Entries with the help of Cursor
DirectorySearchResults	searchResults(java.lang.String dn, int scope, java.lang.String filter, java.lang.String[] attributes, boolean returnValues) It sends request to LDAP SOAP processor or LDAP Server based on LDAPDirectory instance to get the results.
void	setDirectorySearchRoot(java.lang.String root) Set the default search root to search objects in.
void	setOrganization(java.lang.String organization) Set the current organizational context.
void	switchToDirectConnection(LDAPConnection connection)
void	switchToSOAP()
boolean	userHasProperty(java.lang.String organizationalUser, java.lang.String propertyName, java.lang.String value) Check whether the organizational user assigned roles contains property name value pair
boolean	userHasRole(java.lang.String organizationalUser, java.lang.String role) Deprecated.

Methods inherited from class java.lang.Object

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

Field Detail

LDAPCONTROL_CLASS

public static final java.lang.String LDAPCONTROL_CLASS

See Also:

Constant Field Values

SCOPE_BASE

public static final int SCOPE_BASE

SCOPE_ONE

public static final int SCOPE_ONE

SCOPE_SUB

public static final int SCOPE_SUB

DEFAULT_PORT

public static final int DEFAULT_PORT

See Also:

Constant Field Values

ENTRY_UUID

public static final java.lang.String ENTRY_UUID

See Also:

Constant Field Values

LDAP_MAX_RESULT_KEY

public static final java.lang.String LDAP_MAX_RESULT_KEY

See Also:

Constant Field Values

Constructor Detail

LDAPDirectory

@Deprecated
public LDAPDirectory()
                           throws DirectoryException

Deprecated. use getDefaultInstance() API

Create the default LDAP proxy to the host that is specified in the environment settings. These settings can be done in either a properties file or in the Windows Registry.

Throws:

LDAPException - if the connection could not be established.

DirectoryException

LDAPDirectory

public LDAPDirectory(LDAPConnection connection)

Create an LDAP proxy that can use the connection object. In this case, the user of this class is responsible for opening the connection.

Parameters:

connection - The connection that can be used by this LDAP proxy.

LDAPDirectory

public LDAPDirectory(java.lang.String host,
                     int port,
                     java.lang.String user,
                     java.lang.String password)
              throws DirectoryException

Create an LDAP proxy to the specified host, on the specified port, and authenticate to it using the username and password

Parameters:

host - The host to connect to (may contain an optional port)

port - The port to connect to on the host

user - The username to bind for

password - The password for the user

Throws:

LDAPException - if the connection could not be established.

DirectoryException

LDAPDirectory

@Deprecated
public LDAPDirectory(java.lang.String host,
                                  int port,
                                  java.lang.String user,
                                  java.lang.String password,
                                  Cache cache)
                           throws DirectoryException

Deprecated. use LDAPDirectory(String host, int port, String user, String password).

Throws:

DirectoryException

Method Detail

getDefaultMaximumSearchResults

public static int getDefaultMaximumSearchResults()

Get the default maximum search results from LDAP. By default it returns 2000. we can override this value using the property 'bus.ldap.processor.maximumnoofsearchresult'

Returns:

number of maximum search results

getDefaultInstance

public static LDAPDirectory getDefaultInstance()
                                        throws DirectoryException

Returns the default LDAP proxy to the host that is specified in the environment settings. These settings can be done in either a properties file or in the Windows registry.

Returns:

the default Directory instance

Throws:

DirectoryException

initializeBootstrapFileTrigger

public static void initializeBootstrapFileTrigger()

switchToDirectConnection

public void switchToDirectConnection(LDAPConnection connection)

switchToSOAP

public void switchToSOAP()
                  throws java.net.SocketTimeoutException,
                         java.net.UnknownHostException,
                         java.io.IOException

Throws:

java.net.SocketTimeoutException

java.net.UnknownHostException

java.io.IOException

isSOAPConnection

public boolean isSOAPConnection()

Check if the directory is connected directly to the LDAP server or uses the LDAP SOAP Processor

Returns:

true if the connection is using the LDAP SOAP Processor (false when you have a direct connection)

setOrganization

public void setOrganization(java.lang.String organization)

Set the current organizational context.

Parameters:

organization - DN of the organization

getOrganization

public java.lang.String getOrganization()

Returns the current organizational context.

Returns:

current organizational context

getConnection

public LDAPConnection getConnection()

Returns the actual connection to ldap.

setDirectorySearchRoot

public void setDirectorySearchRoot(java.lang.String root)

Set the default search root to search objects in.

Parameters:

root - search root for the LDAP

getDirectorySearchRoot

public java.lang.String getDirectorySearchRoot()

Returns the default search root.

Returns:

The default search root.

clearCache

public void clearCache()

getCacheStatistics

public java.lang.String getCacheStatistics()

report

@Deprecated
public void report()

Deprecated. this method doesn't do anything anymore.

Prints a report of the Cache statistics in the Spy.

getAuthenticationUser

public LDAPEntry getAuthenticationUser()
                                throws DirectoryException

Returns the aunthenticated user entry from the LDAP of the currently logged in user

Returns:

LDAPEntry of the authenticated user of the currently logged on user

Throws:

DirectoryException

getAuthenticationUser

public LDAPEntry getAuthenticationUser(java.lang.String osId)
                                throws DirectoryException

Throws:

DirectoryException

getOrganizationalUser

public java.lang.String getOrganizationalUser()

Returns the organizational user entry for the currently logged on user

Returns:

OrganizationalUser LDAPEntry of the currently logged on user

getOrganizationalUser

public java.lang.String getOrganizationalUser(java.lang.String osId)

findSOAPNode

public java.lang.String findSOAPNode(java.lang.String namespace,
                                     java.lang.String method)
                              throws DirectoryException

Searches for a SOAP node within the default organizational context that can execute the method of the namespace. If no such SOAP node is found, then, search is done in organization 'system'. If the specified method is not available, but the namespace is implemented by some SOAP node(s) then the first SOAP node implementing the namespace is returned. If, for a given namespace and method, multiple SOAP Nodes are available within the same organization, then, the first SOAP Node as appearing in the repository is returned.

 String soapNodeDN = directory.findSOAPNode("<i>namespace of method set</i>",
         "<i>name of the method</i>");
 

Parameters:

namespace - The namespace of the method

method - The method to be executed by the SOAP node to be found

Throws:

DirectoryException - if no soap node could be found, or an exception while performing the look-up.

findSOAPNode

public java.lang.String findSOAPNode(java.lang.String organizationalContext,
                                     java.lang.String namespace,
                                     java.lang.String method)
                              throws DirectoryException

Searches for a SOAP node within the specified organizational context that can execute the method of the namespace. If no such SOAP node is found, then, search is done in organization 'system'. If the specified method is not available, but the namespace is implemented by some SOAP node(s) then the first SOAP node implementing the namespace is returned. If, for a given namespace and method, multiple SOAP Nodes are available within the same organization, then, the first SOAP Node as appearing in the repository is returned.

 String soapNodeDN = directory.findSOAPNode("<i>dn of organization</i>", "<i>namespace of method set</i>",
         "<i>name of the method</i>");
 

Parameters:

organizationalContext - The search context for the ldap query, this is expected to be an organization or organizational unit.

namespace - The namespace of the method

method - The method to be executed by the SOAP node to be found

Throws:

DirectoryException - if no soap node could be found, or an exception while performing the look-up.

getEntry

public LDAPEntry getEntry(java.lang.String name)
                   throws DirectoryException

If name is a Distinguished Name, a LDAPConnection.read() on this name is done. Else a search on entries that have the value name for the cn attribute is done, and the first entry of this search is returned.

Parameters:

name - A description (either name or subname) of the entry to find

Returns:

The resulting entry.

Throws:

LDAPException - if the name is a dn the exception of the LDAPConnection.read() is thrown, else if the search resulted in an exception this is thrown. If there where no matching results for the search, also an LDAPException is thrown.

DirectoryException

getURIs

public java.lang.String[] getURIs(java.lang.String name)
                           throws DirectoryException

Retrieves all URIs on which the SOAP Node that is registered for this name may be listening

Throws:

LDAPException - if a failure in the ldap connection happened or if the name is not an object in the directory

DirectoryException

search

public LDAPEntry[] search(java.lang.String dn,
                          int scope,
                          java.lang.String filter,
                          java.lang.String[] attributes,
                          boolean returnValues)
                   throws DirectoryException

It sends request to LDAP SOAP processor or LDAP Server based on LDAPDirectory instance to get the results. These results will be stored into internal cache.

Parameters:

dn - DN of the LDAP to search in

scope - Depth of the search. specify 0 for searching only that entry, 1 for searching one level under, 2 for searching all under that entry

filter - filter of the search for example "(objectclass=busmethod)"

attributes - attributes to be searched for

returnvalues - this attribute is not used

Throws:

throws - LDAPException if search fails

DirectoryException

search

public LDAPEntry[] search(java.lang.String dn,
                          int scope,
                          java.lang.String filter,
                          java.lang.String[] attributes,
                          boolean returnValues,
                          LDAPSearchConstraints cons)
                   throws DirectoryException

It sends request to LDAP SOAP processor or LDAP Server based on LDAPDirectory instance to get the results. These results will be stored into internal cache.

Parameters:

dn - DN of the LDAP to search in

scope - Depth of the search. specify 0 for searching only that entry, 1 for searching one level under, 2 for searching all under that entry

filter - filter of the search for example "(objectclass=busmethod)"

attributes - attributes to be searched for

returnvalues - this attribute is not used

cons - - The constraints specific to the search.

Throws:

throws - LDAPException if search fails

DirectoryException

search

public java.lang.String search(java.lang.String dn,
                               int scope,
                               java.lang.String filter,
                               java.lang.String[] attributes,
                               boolean returnValues,
                               java.lang.String cookie,
                               java.util.ArrayList<LDAPEntry> list)
                        throws DirectoryException

Serach LDAP Entries with the help of Cursor

Parameters:

dn -

scope -

filter -

attributes -

returnValues - This attribute is not used

cookie -

list -

Returns:

Cursor cookie for next search argiment

Throws:

DirectoryException

returnCookieConnection

public void returnCookieConnection(java.lang.String cookie)

Release LDAP Connection with cookie argument in LDAP Connection pool

Parameters:

cookie -

searchResults

public DirectorySearchResults searchResults(java.lang.String dn,
                                            int scope,
                                            java.lang.String filter,
                                            java.lang.String[] attributes,
                                            boolean returnValues)
                                     throws DirectoryException

It sends request to LDAP SOAP processor or LDAP Server based on LDAPDirectory instance to get the results. These results will be stored into internal cache.

Parameters:

dn - DN of the LDAP to search in

scope - Depth of the search. specify 0 for searching only that entry, 1 for searching one level under, 2 for searching all under that entry

filter - filter of the search for example "(objectclass=busmethod)"

attributes - attributes to be searched for

returnvalues - This attribute is not used

Throws:

throws - LDAPException if search fails

DirectoryException

add

@Deprecated
public void add(LDAPEntry entry)
                      throws DirectoryException

Deprecated. this method does not allow passing a active user identity. Use LDAPManipulator instead.

Synchronously modify an entry to the LDAP directory through SOAP Message.

Throws:

DirectoryException

delete

@Deprecated
public void delete(java.lang.String dn)
                         throws DirectoryException

Deprecated. this method does not allow passing a active user identity. Use LDAPManipulator instead.

Synchronously modify an entry to the LDAP directory through SOAP Message.

Throws:

DirectoryException

modify

@Deprecated
public void modify(LDAPEntry newEntry)
                         throws DirectoryException

Deprecated. this method does not allow passing a active user identity. Use LDAPManipulator instead.

Synchronously modify an entry to the LDAP directory through SOAP Message.

Throws:

DirectoryException

read

public LDAPEntry read(java.lang.String dn)
               throws DirectoryException

Method internally calls the LDAPConnection.read, but uses an internal cache

Throws:

DirectoryException

readWithUUID

public LDAPEntry readWithUUID(java.lang.String searchRoot,
                              java.lang.String uuid)
                       throws DirectoryException

Search LDAP for an entry with this uuid. Try to minimize the scope of the search by giving the most appropriate searchRoot. If you don't know where the entry will be, give the actual LDAP root. If you know the uuid you are looking for is of a user in your current organization, you can give 'cn=organizational users,o=,'. Otherwise an intensive full LDAP search will happen.

Parameters:

searchRoot - The base DN to search from. Required.

uuid -

Returns:

Throws:

DirectoryException

getUUID

public java.lang.String getUUID(LDAPEntry entry)

Get the UUID of this LDAPEntry. Returns the value of this entry's entryUUID attribute.

Parameters:

entry - LDAP entry

Returns:

value of entryUUID attribute if available, else null

Since:

2010

userHasRole

@Deprecated
public boolean userHasRole(java.lang.String organizationalUser,
                                        java.lang.String role)
                                 throws DirectoryException

Deprecated.

Check whether the organizational user has a role.

Parameters:

organizationalUser - (should never be null)

role -

Returns:

Throws:

DirectoryException

userHasProperty

public boolean userHasProperty(java.lang.String organizationalUser,
                               java.lang.String propertyName,
                               java.lang.String value)
                        throws DirectoryException

Check whether the organizational user assigned roles contains property name value pair

Parameters:

organizationalUser -

propertyName -

value -

Returns:

Throws:

DirectoryException

getRolesOfUser

@Deprecated
public java.util.Map<java.lang.String,java.lang.String> getRolesOfUser(java.lang.String organizationalUserDN)
                                                                             throws DirectoryException

Deprecated.

Get all roles (including inherited) of a user.

Parameters:

organizationalUser - (should never be null)

Returns:

a map containing the role DN as key and value also as role DN

Throws:

DirectoryException - Use com.cordys.esbclient.util.LDAPUtil.getAllRoles(String organizationalUser) instead of this method

getAssignedRolesOfUser

public java.util.Map<java.lang.String,java.lang.String> getAssignedRolesOfUser(java.lang.String organizationalUserDN)
                                                                        throws DirectoryException

Get AssignedRoles (including inherited) of a user.

Parameters:

organizationalUserDN -

Returns:

Throws:

DirectoryException

getAllRolesOfUser

public java.util.Map<java.lang.String,java.lang.String> getAllRolesOfUser(java.lang.String organizationalUserDN)
                                                                   throws DirectoryException

Parameters:

organizationalUserDN - the DN of the organizational user.

Returns:

a map containing the role DN as key and value is type of the role.

Throws:

DirectoryException

getCache

public Cache getCache()

Returns the internal Cache object used by this directory.

finalize

protected void finalize()
                 throws java.lang.Throwable

Overrides:

finalize in class java.lang.Object

Throws:

java.lang.Throwable