org.ametys.web.pageaccess

Class IsContentRestrictedAction

java.lang.Object

org.apache.avalon.framework.logger.AbstractLogEnabled

org.apache.cocoon.acting.AbstractAction

org.apache.cocoon.acting.ServiceableAction

org.ametys.web.pageaccess.IsContentRestrictedAction

All Implemented Interfaces:

Component, LogEnabled, Serviceable, ThreadSafe, Action

public class IsContentRestrictedAction
extends ServiceableAction
implements ThreadSafe

Test if a content is restricted or not, depending on the pages it's in.

• If at least one page is not restricted, returns EMPTY_MAP. The content or resource can be cached.
• If all its pages are restricted and the current user is allowed to access at least one, return null. The content or resource can be served but can't be cached.
• If all its pages are restricted but the current user is not allowed, an AccessDeniedException is thrown.
• If all its pages are restricted but no one is logged in, an AuthorizationRequiredException is thrown.

Field Summary

Fields

Modifier and Type	Field and Description
protected ContentAccessManager	_contentAccessManager The content access manager.
protected CurrentUserProvider	_currentUserProvider The current user provider
protected RenderingContextHandler	_renderingContextHandler The rendering context handler.
protected AmetysObjectResolver	_resolver The Ametys object resolver.

Fields inherited from class org.apache.cocoon.acting.ServiceableAction

manager

Fields inherited from class org.apache.cocoon.acting.AbstractAction

EMPTY_MAP

Fields inherited from interface org.apache.cocoon.acting.Action

ROLE

Constructor Summary

Constructors

Constructor and Description
IsContentRestrictedAction()

Method Summary

Modifier and Type	Method and Description
Map	act(Redirector redirector, SourceResolver resolver, Map objectModel, String source, Parameters parameters)
protected AmetysObject	getAmetysObject(Parameters parameters, Request request) Get the Ametys object from either the parameters or the request attributes.
void	service(ServiceManager serviceManager)

Methods inherited from class org.apache.avalon.framework.logger.AbstractLogEnabled

enableLogging, getLogger, setupLogger, setupLogger, setupLogger

Methods inherited from class java.lang.Object

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

Field Detail

_contentAccessManager

protected ContentAccessManager _contentAccessManager

The content access manager.

_renderingContextHandler

protected RenderingContextHandler _renderingContextHandler

The rendering context handler.

_resolver

protected AmetysObjectResolver _resolver

The Ametys object resolver.

_currentUserProvider

protected CurrentUserProvider _currentUserProvider

The current user provider

Constructor Detail

IsContentRestrictedAction

public IsContentRestrictedAction()

Method Detail

service

public void service(ServiceManager serviceManager)
             throws ServiceException

Specified by:

service in interface Serviceable

Overrides:

service in class ServiceableAction

Throws:

ServiceException

act

public Map act(Redirector redirector,
               SourceResolver resolver,
               Map objectModel,
               String source,
               Parameters parameters)
        throws Exception

Specified by:

act in interface Action

Throws:

Exception

getAmetysObject

protected AmetysObject getAmetysObject(Parameters parameters,
                                       Request request)

Get the Ametys object from either the parameters or the request attributes.

Parameters:

parameters - the action parameters.

request - the request.

Returns:

the Ametys object or null if not found.