Package org.silverpeas.core.security.authorization

Interface ComponentInstanceAccessControlExtension

All Known Implementing Classes:

DefaultInstanceAccessControlExtension, UserCalendarInstanceAccessControlExtension

public interface ComponentInstanceAccessControlExtension

This interface extends access controller extension for a component instance resource.

This interface defines an extension for ComponentAccessControl which is specific to a SilverpeasComponentInstance.

If a component has specific rules about ComponentAccessControl mechanism, it should implement this interface in order to apply them.

Any application that requires to implement this interface MUST qualify with the Named annotation by a name satisfying the following convention [COMPONENT NAME]InstanceAccessControlExtension. For example, for an application Kmelia, the implementation must be qualified with @Named ("kmeliaInstanceAccessControlExtension")

Author:

silveryocha

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	ComponentInstanceAccessControlExtension.Constants	Constants are predefined value used by a contribution manager to work with and that carries a semantic that has to be shared by all the implementations of this interface.

Method Summary

Modifier and Type	Method	Description
boolean	fillUserRolesFromComponentInstance(ComponentAccessController.DataManager dataManager, User user, String componentId, AccessControlContext context, Set<SilverpeasRole> userRoles)
static ComponentInstanceAccessControlExtension	getByInstanceId(String instanceId)	Gets the ComponentInstanceAccessControlExtension according to the given identifier of component instance.

Method Detail

getByInstanceId

static ComponentInstanceAccessControlExtension getByInstanceId(String instanceId)

Gets the ComponentInstanceAccessControlExtension according to the given identifier of component instance.

Instances of ComponentInstanceAccessControlExtension are request scoped (or thread scoped on backend treatments).

Parameters:

instanceId - the identifier of a component instance from which the qualified name of the implementation will be extracted.

Returns:

a ComponentInstanceAccessControlExtension implementation.

fillUserRolesFromComponentInstance

boolean fillUserRolesFromComponentInstance(ComponentAccessController.DataManager dataManager,
                                           User user,
                                           String componentId,
                                           AccessControlContext context,
                                           Set<SilverpeasRole> userRoles)