org.eclipse.stardust.engine.core.spi.security
Class DynamicParticipantSynchronizationProvider

java.lang.Object
  org.eclipse.stardust.engine.core.spi.security.DynamicParticipantSynchronizationProvider

public abstract class DynamicParticipantSynchronizationProvider
extends Object

Contract for providing access to external user repositories.

Version:

$Revision$

Author:

rsauer

Field Summary

static org.eclipse.stardust.common.log.Logger

trace

Constructor Summary

DynamicParticipantSynchronizationProvider()

Method Summary

ExternalDepartmentConfiguration	provideDepartmentConfiguration(String participantId, List<String> departmentKey) Resolves a department in the external registry for given partition and provides its attributes.
ExternalDepartmentConfiguration	provideDepartmentConfiguration(String participantId, List<String> departmentKey, Map<String,?> properties) Resolves a department in the external registry for given partition and provides its attributes.
abstract ExternalUserConfiguration	provideUserConfiguration(String account) Resolves a user in the external registry and provides its attributes.
ExternalUserConfiguration	provideUserConfiguration(String realm, String account, Map properties) Resolves a user in the external registry and provides its attributes.
ExternalUserConfiguration	provideUserConfigurationLogAware(String account) wrapper to catch and log possible exceptions.
ExternalUserGroupConfiguration	provideUserGroupConfiguration(String groupId) Resolves a user group in the external registry for current partition and provides its attributes.
ExternalUserGroupConfiguration	provideUserGroupConfiguration(String groupId, Map properties) Resolves a user group in the external registry for given partition and provides its attributes.
ExternalDepartmentConfiguration	provideValidDepartmentConfiguration(String participantId, List<String> departmentKey, Map<String,?> properties) Resolves a department in the external registry for given partition and provides its attributes.
ExternalUserConfiguration	provideValidUserConfiguration(String realm, String account, Map properties) Resolves a user in the external registry and provides its attributes.
ExternalUserGroupConfiguration	provideValidUserGroupConfiguration(String groupId, Map properties) Resolves a user group in the external registry for given partition and provides its attributes.

Methods inherited from class java.lang.Object

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

Field Detail

trace

public static final org.eclipse.stardust.common.log.Logger trace

Constructor Detail

DynamicParticipantSynchronizationProvider

public DynamicParticipantSynchronizationProvider()

Method Detail

provideUserConfiguration

public abstract ExternalUserConfiguration provideUserConfiguration(String account)

Resolves a user in the external registry and provides its attributes.

Parameters:

account - The identity of the external user.

Returns:

A (probably snapshot) of the users attributes.

See Also:

#provideUserConfiguration(String realm, String account)

provideUserConfigurationLogAware

public final ExternalUserConfiguration provideUserConfigurationLogAware(String account)

wrapper to catch and log possible exceptions. provideUserConfiguration(String account)

provideUserConfiguration

public ExternalUserConfiguration provideUserConfiguration(String realm,
                                                          String account,
                                                          Map properties)

Resolves a user in the external registry and provides its attributes.
The default implementation just calls provideUserConfiguration(String account), effectively ignoring the realm.

Parameters:

realm - The security realm of the external user.

account - The identity of the external user.

properties - The login properties like partition, domain, ...

Returns:

A (probably snapshot) of the users attributes.

See Also:

provideUserConfiguration(String account)

provideValidUserConfiguration

public ExternalUserConfiguration provideValidUserConfiguration(String realm,
                                                               String account,
                                                               Map properties)

Resolves a user in the external registry and provides its attributes. A validity check is performed before the user configuration is returned.

Parameters:

realm - The security realm of the external user.

account - The identity of the external user.

properties - The login properties like partition, domain, ...

Returns:

A (probably snapshot) of the users attributes.

See Also:

provideUserConfiguration(String account)

provideUserGroupConfiguration

public ExternalUserGroupConfiguration provideUserGroupConfiguration(String groupId)

Resolves a user group in the external registry for current partition and provides its attributes.

Parameters:

groupId - The identity of the external user group.

Returns:

A (probably snapshot) of the user groups attributes.

provideUserGroupConfiguration

public ExternalUserGroupConfiguration provideUserGroupConfiguration(String groupId,
                                                                    Map properties)

Resolves a user group in the external registry for given partition and provides its attributes.

Parameters:

groupId - The identity of the external user group.

properties - The login properties like partition, domain, ...

Returns:

A (probably snapshot) of the user groups attributes.

provideValidUserGroupConfiguration

public final ExternalUserGroupConfiguration provideValidUserGroupConfiguration(String groupId,
                                                                               Map properties)

Resolves a user group in the external registry for given partition and provides its attributes. A validity check is performed before the user group configuration is returned.

Parameters:

groupId - The identity of the external user group.

properties - The login properties like partition, domain, ...

Returns:

A (probably snapshot) of the user groups attributes.

provideDepartmentConfiguration

public ExternalDepartmentConfiguration provideDepartmentConfiguration(String participantId,
                                                                      List<String> departmentKey)

Resolves a department in the external registry for given partition and provides its attributes.

Parameters:

departmentKey - The identity of the external department.

Returns:

A (probably) snapshot of the department attributes.

provideDepartmentConfiguration

public ExternalDepartmentConfiguration provideDepartmentConfiguration(String participantId,
                                                                      List<String> departmentKey,
                                                                      Map<String,?> properties)

Resolves a department in the external registry for given partition and provides its attributes.

Parameters:

departmentKey - The identity of the external department.

properties - The login properties like partition, domain, ...

Returns:

A (probably) snapshot of the department attributes.

provideValidDepartmentConfiguration

public final ExternalDepartmentConfiguration provideValidDepartmentConfiguration(String participantId,
                                                                                 List<String> departmentKey,
                                                                                 Map<String,?> properties)

Resolves a department in the external registry for given partition and provides its attributes. A validity check is performed before the department configuration is returned.

Parameters:

departmentKey - The identity of the external department.

properties - The login properties like partition, domain, ...

Returns:

A (probably) snapshot of the department attributes.