org.imixs.workflow.ldap

Class LDAPLookupService

java.lang.Object

org.imixs.workflow.ldap.LDAPLookupService

public class LDAPLookupService
extends Object

This EJB provides a ldap lookup service for user informations The bean reads its configuration from the configuration property file located in the glassfish domains config folder (GLASSFISH_DOMAIN/config/imixs-office-ldap.properties). IMPORTANT! The LDAPLookupService can not use the EJB PropertyService because of the PropertyInterceptor Class which will lead into a endless loop between LDAPGroupInterceptor and PropertyInterceptor !!! For that reason the proertyService is used manually here!!

Version:

1.0

Author:

rsoika

Field Summary

Fields

Modifier and Type	Field and Description
static String	LDAP_SEARCH_CONTEXT
static String	LDAP_SEARCH_FILTER_DN
static String	LDAP_SEARCH_FILTER_GROUP
static String	LDAP_SEARCH_FILTER_PHRASE
static String	LDAP_USER_ATTRIBUTES
protected javax.enterprise.event.Event<LDAPProfileEvent>	ldapProfileEvents
static int	MAX_RESULT
static int	TIME_LIMIT

Constructor Summary

Constructors

Constructor and Description
LDAPLookupService()

Method Summary

Modifier and Type	Method and Description
void	cacheUser(String aUID, org.imixs.workflow.ItemCollection user) This method is used to put a user object into the cache.
String[]	findGroups(String aUID) Returns a string array containing all group names for a given UID.
org.imixs.workflow.ItemCollection	findUser(String aUID) Returns the ldap attributes for a given user.
org.imixs.workflow.ItemCollection	findUser(String aUID, boolean refresh) Returns the ldap attributes for a given user.
String	getDnSearchFilter()
String	getGroupSearchFilter()
String	getSearchContext()
String	getSearchFilterPhrase()
boolean	isEnabled()
org.imixs.workflow.ItemCollection	lookupLdapAttributes(String aUID) Returns all attributes for a given user in an ItemCollection.
List<org.imixs.workflow.ItemCollection>	searchUserList(String searchPhrase) Returns a list of user entries form the ldap based on a search phrase
void	setDnSearchFilter(String dnSearchFilter)
void	setGroupSearchFilter(String groupSearchFilter)
void	setSearchContext(String searchContext)
void	setSearchFilterPhrase(String searchFilterPhrase)

Methods inherited from class java.lang.Object

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

Field Detail

MAX_RESULT

public static final int MAX_RESULT

See Also:

Constant Field Values

TIME_LIMIT

public static final int TIME_LIMIT

See Also:

Constant Field Values

LDAP_SEARCH_CONTEXT

public static final String LDAP_SEARCH_CONTEXT

See Also:

Constant Field Values

LDAP_SEARCH_FILTER_DN

public static final String LDAP_SEARCH_FILTER_DN

See Also:

Constant Field Values

LDAP_SEARCH_FILTER_GROUP

public static final String LDAP_SEARCH_FILTER_GROUP

See Also:

Constant Field Values

LDAP_SEARCH_FILTER_PHRASE

public static final String LDAP_SEARCH_FILTER_PHRASE

See Also:

Constant Field Values

LDAP_USER_ATTRIBUTES

public static final String LDAP_USER_ATTRIBUTES

See Also:

Constant Field Values

ldapProfileEvents

@Inject
protected javax.enterprise.event.Event<LDAPProfileEvent> ldapProfileEvents

Constructor Detail

LDAPLookupService

public LDAPLookupService()

Method Detail

getDnSearchFilter

public String getDnSearchFilter()

setDnSearchFilter

public void setDnSearchFilter(String dnSearchFilter)

getSearchFilterPhrase

public String getSearchFilterPhrase()

setSearchFilterPhrase

public void setSearchFilterPhrase(String searchFilterPhrase)

getGroupSearchFilter

public String getGroupSearchFilter()

setGroupSearchFilter

public void setGroupSearchFilter(String groupSearchFilter)

getSearchContext

public String getSearchContext()

setSearchContext

public void setSearchContext(String searchContext)

isEnabled

public boolean isEnabled()

findUser

public org.imixs.workflow.ItemCollection findUser(String aUID)

Returns the ldap attributes for a given user. If no user was found in LDAP the method returns null. The method uses an internal cache.

Parameters:

aUID - - user id

Returns:

ItemCollection containing the user attributes or null if no attributes where found.

findUser

public org.imixs.workflow.ItemCollection findUser(String aUID,
                                                  boolean refresh)

Returns the ldap attributes for a given user. If no user was found in LDAP the method returns null.

If the boolean 'refresh' is true the method lookup the user in any case with a search query and updates the cache.

Parameters:

aUID - - user id

refresh - - if true, cache will be refreshed.

Returns:

ItemCollection containing the user attributes or null if no attributes where found.

cacheUser

public void cacheUser(String aUID,
                      org.imixs.workflow.ItemCollection user)

This method is used to put a user object into the cache. The method can be called form a external service interface.

Parameters:

aUID - - userid

user - - user profile

searchUserList

public List<org.imixs.workflow.ItemCollection> searchUserList(String searchPhrase)

Returns a list of user entries form the ldap based on a search phrase

Parameters:

searchPhrase - - search Phrase

Returns:

ItemCollection containing the user attributes or null if no attributes where found.

findGroups

public String[] findGroups(String aUID)

Returns a string array containing all group names for a given UID. If no groups exist or the uid was not found the method returns an empty string array!.

Parameters:

aUID - - user unique id

Returns:

string array of group names

lookupLdapAttributes

public org.imixs.workflow.ItemCollection lookupLdapAttributes(String aUID)

Returns all attributes for a given user in an ItemCollection. If ldap service is disabled or the user was not found then the method returns null.

The method makes a direct ldap lookup. No cache is used.

It is recommended to use the method findUser instead of the method lookupLdapAttributes to use the internal caching mechanism.

Parameters:

aUID - - user id

Returns:

ItemCollection - containing the user attributes or null if no entry was found