org.ametys.cms.tag

Class GetTagsAction

java.lang.Object

org.apache.avalon.framework.logger.AbstractLogEnabled

org.apache.cocoon.acting.AbstractAction

org.apache.cocoon.acting.ServiceableAction

org.ametys.cms.tag.GetTagsAction

All Implemented Interfaces:

Component, LogEnabled, Serviceable, Action

Direct Known Subclasses:

GetTagsAction

public class GetTagsAction
extends ServiceableAction

SAX events for tags

Field Summary

Fields

Modifier and Type	Field and Description
protected CurrentUserProvider	_currentUserProvider The current user provider.
protected AmetysObjectResolver	_resolver The Ametys object resolver
protected RightManager	_rightManager The rights manager.
protected TagProviderExtensionPoint	_tagProviderExtPt The tag provider extension point

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
GetTagsAction()

Method Summary

Modifier and Type	Method and Description
protected UserIdentity	_getCurrentUser() Provides the current user.
Map	act(Redirector redirector, SourceResolver resolver, Map objectModel, String source, Parameters parameters)
protected Set<String>	getProvidersId() Returns the tag providers' id
protected Set<String>	getProvidersIds(boolean onlyCustomTags) Get all providers IDs
protected boolean	isCreationAllowed(TagProvider tagProvider, Tag tag) Determines if the current user can created tag
protected boolean	isPrivate(Tag tag) Determines if a tag is private
protected boolean	isUserAuthorized(Tag tag, Content content) Test if a tag is visible to the current user.
protected boolean	isUserAuthorized(Tag tag, List<String> objectTargetIds) Test if a tag is visible to the current user.
protected Map<String,Object>	providerToJSON(TagProvider tagProvider, Map<String,Object> contextualParameters, String targetType) Get tag provider's properties to JSON format
void	service(ServiceManager serviceManager)
protected Map<String,Object>	tagToJSON(Tag tag, TagProvider tagProvider, List<String> objectTargetIds) Get tag's properties to JSON format

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

_tagProviderExtPt

protected TagProviderExtensionPoint _tagProviderExtPt

The tag provider extension point

_resolver

protected AmetysObjectResolver _resolver

The Ametys object resolver

_rightManager

protected RightManager _rightManager

The rights manager.

_currentUserProvider

protected CurrentUserProvider _currentUserProvider

The current user provider.

Constructor Detail

GetTagsAction

public GetTagsAction()

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 IOException,
               SAXException,
               ProcessingException

Throws:

IOException

SAXException

ProcessingException

getProvidersIds

protected Set<String> getProvidersIds(boolean onlyCustomTags)

Get all providers IDs

Parameters:

onlyCustomTags - If true, return only JCR providers IDs.

Returns:

a set of providers IDs

getProvidersId

protected Set<String> getProvidersId()

Returns the tag providers' id

Returns:

The id of tag providers

tagToJSON

protected Map<String,Object> tagToJSON(Tag tag,
                                       TagProvider tagProvider,
                                       List<String> objectTargetIds)

Get tag's properties to JSON format

Parameters:

tag - The tag

tagProvider - the tag provider

objectTargetIds - the list of Ametys object ids. Can be empty

Returns:

The tag properties

providerToJSON

protected Map<String,Object> providerToJSON(TagProvider tagProvider,
                                            Map<String,Object> contextualParameters,
                                            String targetType)

Get tag provider's properties to JSON format

Parameters:

tagProvider - the tag provider

contextualParameters - The contextual parameters

targetType - The type of target (such as 'content')

Returns:

The tag providers properties

Throws:

AmetysRepositoryException - If an error occurred

isUserAuthorized

protected boolean isUserAuthorized(Tag tag,
                                   Content content)

Test if a tag is visible to the current user.

Parameters:

tag - the Tag object.

content - the current content (can be null).

Returns:

true if the user has access to the tag, false otherwise.

isUserAuthorized

protected boolean isUserAuthorized(Tag tag,
                                   List<String> objectTargetIds)

Test if a tag is visible to the current user.

Parameters:

tag - the Tag object.

objectTargetIds - the ids of current Ametys objects

Returns:

true if the user has access to the tag, false otherwise.

isCreationAllowed

protected boolean isCreationAllowed(TagProvider tagProvider,
                                    Tag tag)

Determines if the current user can created tag

Parameters:

tagProvider - The tag provider

tag - The tag. Can be null.

Returns:

true if creation is allowed

isPrivate

protected boolean isPrivate(Tag tag)

Determines if a tag is private

Parameters:

tag - the tag to test

Returns:

true if a tag is private

_getCurrentUser

protected UserIdentity _getCurrentUser()

Provides the current user.

Returns:

the current user which cannot be null.