com.communote.plugin.ldap

Class LdapUserGroupAccessor

java.lang.Object

com.communote.plugin.ldap.LdapUserGroupAccessor

All Implemented Interfaces:

PropertyKeys, ExternalUserGroupAccessor

public class LdapUserGroupAccessor
extends Object
implements ExternalUserGroupAccessor, PropertyKeys

ExternalUserGroupAccessor for LDAP.

Author:

Communote GmbH - http://www.communote.com/

Field Summary

Fields inherited from interface com.communote.plugin.ldap.PropertyKeys

PROPERTY_KEY_ACTIVE_DIRECTORY_TRACKING_ALLOW_PAGING, PROPERTY_KEY_ACTIVE_DIRECTORY_TRACKING_ENABLED_GROUP, PROPERTY_KEY_ACTIVE_DIRECTORY_TRACKING_ENABLED_USER, PROPERTY_KEY_ACTIVE_DIRECTORY_TRACKING_PAGING_SIZE, PROPERTY_KEY_ACTIVE_DIRECTORY_TRACKING_TIME_OUT, PROPERTY_KEY_ACTIVE_DIRECTORY_TRACKING_USER_SEQUENCE_NUMBER

Constructor Summary

Constructors

Constructor and Description
LdapUserGroupAccessor(PluginPropertyService pluginProperties) Constructor.

Method Summary

Modifier and Type	Method and Description
void	acceptGroupsOfUser(User user, ExternalEntityVisitor<ExternalGroupVO> visitor) This method can be used to visit all groups of a given user.
void	acceptMembersOfGroup(ExternalUserGroup group, ExternalEntityVisitor<Long> visitor) This method can be used to visit all members of the given group.
void	acceptParentGroups(ExternalUserGroup group, ExternalEntityVisitor<ExternalGroupVO> visitor) This method can be used to visit all parent groups of the given groups.
boolean	canConnect() Checks if the system is available.
ExternalGroupVO	getGroup(ExternalUserGroup group) Retrieves the current data of a group in the external system.
ExternalGroupVO	getGroup(String externalGroupId) Retrieves the current data of a group in the external system by the external group identifier.
boolean	hasGroup(ExternalUserGroup group)
boolean	needsSynchronization(Date date)
void	start() This method will be called when the accessor starts.
void	stop() This method will be called when the accessor should be stopped.
boolean	supports(ExternalSystemConfiguration externalConfiguration)

Methods inherited from class java.lang.Object

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

Constructor Detail

LdapUserGroupAccessor

public LdapUserGroupAccessor(PluginPropertyService pluginProperties)

Constructor.

Parameters:

pluginProperties - The properties to use.

Method Detail

acceptGroupsOfUser

public void acceptGroupsOfUser(User user,
                               ExternalEntityVisitor<ExternalGroupVO> visitor)
                        throws ExternalUserGroupAccessorException

This method can be used to visit all groups of a given user.

Specified by:

acceptGroupsOfUser in interface ExternalUserGroupAccessor

Parameters:

user - The user.

visitor - A visitor for visiting the found entities.

Throws:

ExternalUserGroupAccessorException - Exception.

acceptMembersOfGroup

public void acceptMembersOfGroup(ExternalUserGroup group,
                                 ExternalEntityVisitor<Long> visitor)
                          throws ExternalUserGroupAccessorException

This method can be used to visit all members of the given group. The visitor visits only users which are already a member within Communote, though it only works on their id.

Specified by:

acceptMembersOfGroup in interface ExternalUserGroupAccessor

Parameters:

group - The child group.

visitor - A visitor for visiting the found entities.

Throws:

ExternalUserGroupAccessorException - Exception.

acceptParentGroups

public void acceptParentGroups(ExternalUserGroup group,
                               ExternalEntityVisitor<ExternalGroupVO> visitor)
                        throws ExternalUserGroupAccessorException

This method can be used to visit all parent groups of the given groups.

Specified by:

acceptParentGroups in interface ExternalUserGroupAccessor

Parameters:

group - The child group.

visitor - A visitor for visiting the found entities.

Throws:

ExternalUserGroupAccessorException - Exception.

canConnect

public boolean canConnect()

Description copied from interface: ExternalUserGroupAccessor

Checks if the system is available.

Specified by:

canConnect in interface ExternalUserGroupAccessor

Returns:

True, if a context could be created and closed, else false.

getGroup

public ExternalGroupVO getGroup(ExternalUserGroup group)
                         throws PluginException

Retrieves the current data of a group in the external system.

Specified by:

getGroup in interface ExternalUserGroupAccessor

Parameters:

group - The group to retrieve.

Returns:

The external group if the group exists in the external system, null otherwise.

Throws:

PluginException - Exception.

getGroup

public ExternalGroupVO getGroup(String externalGroupId)

Retrieves the current data of a group in the external system by the external group identifier.

Specified by:

getGroup in interface ExternalUserGroupAccessor

Parameters:

externalGroupId - The identifier of the external group.

Returns:

The external group if the group exists in the external system, null otherwise.

hasGroup

public boolean hasGroup(ExternalUserGroup group)
                 throws PluginException

Specified by:

hasGroup in interface ExternalUserGroupAccessor

Parameters:

group - The group to check against.

Returns:

True, if the given group exists in the foreign system.

Throws:

PluginException - Exception.

needsSynchronization

public boolean needsSynchronization(Date date)

Specified by:

needsSynchronization in interface ExternalUserGroupAccessor

Parameters:

date - Date.

Returns:

true True, if a synchronization is needed.

start

public void start()

Description copied from interface: ExternalUserGroupAccessor

This method will be called when the accessor starts.

Specified by:

start in interface ExternalUserGroupAccessor

stop

public void stop()

Description copied from interface: ExternalUserGroupAccessor

This method will be called when the accessor should be stopped.

Specified by:

stop in interface ExternalUserGroupAccessor

supports

public boolean supports(ExternalSystemConfiguration externalConfiguration)

Specified by:

supports in interface ExternalUserGroupAccessor

Parameters:

externalConfiguration - The external configuration.

Returns:

True if the concrete configuration is supported, else false.