com.communote.server.plugins.api.externals

Interface ExternalUserGroupAccessor

All Known Implementing Classes:

LdapUserGroupAccessor

public interface ExternalUserGroupAccessor

Author:

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

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)

Method Detail

acceptGroupsOfUser

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

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

Parameters:

user - The user.

visitor - A visitor for visiting the found entities.

Throws:

ExternalUserGroupAccessorException - Exception.

acceptMembersOfGroup

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.

Parameters:

group - The child group.

visitor - A visitor for visiting the found entities.

Throws:

ExternalUserGroupAccessorException - Exception.

acceptParentGroups

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

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

Parameters:

group - The child group.

visitor - A visitor for visiting the found entities.

Throws:

ExternalUserGroupAccessorException - Exception.

canConnect

boolean canConnect()

Checks if the system is available.

Returns:

True if the system is available.

getGroup

ExternalGroupVO getGroup(ExternalUserGroup group)
                  throws PluginException

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

Parameters:

group - The group to retrieve.

Returns:

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

Throws:

PluginException - Exception.

getGroup

ExternalGroupVO getGroup(String externalGroupId)
                  throws PluginException

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

Parameters:

externalGroupId - The identifier of the external group.

Returns:

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

Throws:

PluginException - Exception.

hasGroup

boolean hasGroup(ExternalUserGroup group)
          throws PluginException

Parameters:

group - The group to check against.

Returns:

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

Throws:

PluginException - Exception.

needsSynchronization

boolean needsSynchronization(Date date)

Parameters:

date - Date.

Returns:

True, if a synchronization is needed.

start

void start()

This method will be called when the accessor starts.

stop

void stop()

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

supports

boolean supports(ExternalSystemConfiguration externalConfiguration)

Parameters:

externalConfiguration - The external configuration.

Returns:

True if the concrete configuration is supported, else false.