ReadAccessHelper (Ametys 4.4.x - API)

java.lang.Object
- org.ametys.cms.rights.solrchecking.ReadAccessHelper

All Implemented Interfaces:: Component, Contextualizable, Serviceable

public class ReadAccessHelper
extends Object
implements Component, Serviceable, Contextualizable

Helper for Read ACL

Field Summary

Fields
Modifier and Type	Field	Description
`protected AllowedUsersActionAdditionalOperationsExtensionPoint`	`_allowedUsersActionAdditionalOperationsEP`	The Extension Point for doing additonal operations before and after calling `RightManager.getReadAccessAllowedUsers(Object)`
`private Context`	`_context`
`protected RightManager`	`_rightManager`	The right manager
`static String`	`ROLE`	Avalon role.

Constructor Summary

Constructors
Constructor Description

ReadAccessHelper()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`AllowedUsers`	`allowedUsers(AmetysObject ametysObject)`	Gets the allowed users for read-access to the given object
`void`	`contextualize(Context context)`
`void`	`service(ServiceManager manager)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - ROLE
```
public static final String ROLE
```
    Avalon role.
  - _rightManager
```
protected RightManager _rightManager
```
    The right manager
  - _allowedUsersActionAdditionalOperationsEP
```
protected AllowedUsersActionAdditionalOperationsExtensionPoint _allowedUsersActionAdditionalOperationsEP
```
    The Extension Point for doing additonal operations before and after calling RightManager.getReadAccessAllowedUsers(Object)
  - _context
```
private Context _context
```
- Constructor Detail
  - ReadAccessHelper
```
public ReadAccessHelper()
```
- Method Detail
  - service
```
public void service(ServiceManager manager)
             throws ServiceException
```
    Specified by:
    
    service in interface Serviceable
    
    Throws:
    
    ServiceException
  - contextualize
```
public void contextualize(Context context)
                   throws ContextException
```
    Specified by:
    
    contextualize in interface Contextualizable
    
    Throws:
    
    ContextException
  - allowedUsers
```
public AllowedUsers allowedUsers(AmetysObject ametysObject)
```
    Gets the allowed users for read-access to the given object
    
    Parameters:
    
    ametysObject - The object to test
    
    Returns:
    
    the allowed users for read-access to the given object