Package org.ametys.cms.tag

Class AbstractGetTagsAction

java.lang.Object

org.apache.avalon.framework.logger.AbstractLogEnabled

org.apache.cocoon.acting.AbstractAction

org.apache.cocoon.acting.ServiceableAction

org.ametys.cms.tag.AbstractGetTagsAction

All Implemented Interfaces:

Component, LogEnabled, Serviceable, Action

Direct Known Subclasses:

GetCategoriesAction, GetCMSTagsAction, GetKeywordsAction, GetProjectTagsAction, GetThemesTagAction

public abstract class AbstractGetTagsAction
extends ServiceableAction

SAX events for tags

Field Summary

Fields

Modifier and Type	Field	Description
protected AmetysObjectResolver	_resolver	The Ametys object resolver
protected AbstractTagProviderExtensionPoint<? extends Tag>	_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	Description
AbstractGetTagsAction()

Method Summary

Modifier and Type	Method	Description
protected Map<String,? extends Tag>	_getFilteredTags(Map<String,? extends Tag> tags, Map<String,Object> jsParameters)	Get filtered tags
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
abstract String	getTagProviderEPRole()	Get the tag provider extension point role
protected boolean	isCreationAllowed(TagProvider<? extends Tag> tagProvider, Tag tag)	Determines if the current user can created tag
protected boolean	isUserAuthorized(Tag tag, List<String> objectTargetIds, Map<String,Object> jsParameters)	Test if a tag is visible to the current user.
protected Map<String,Object>	providerToJSON(TagProvider<? extends Tag> tagProvider, Map<String,Object> contextualParameters, Map<String,Object> jsParameters)	Get tag provider's properties to JSON format
void	service(ServiceManager serviceManager)
protected Map<String,Object>	tagToJSON(Tag tag, TagProvider<? extends Tag> tagProvider, List<String> objectTargetIds, Map<String,Object> jsParameters)	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 AbstractTagProviderExtensionPoint<? extends Tag> _tagProviderExtPt

The tag provider extension point

_resolver

protected AmetysObjectResolver _resolver

The Ametys object resolver

Constructor Detail

AbstractGetTagsAction

public AbstractGetTagsAction()

Method Detail

service

public void service(ServiceManager serviceManager)
             throws ServiceException

Specified by:

service in interface Serviceable

Overrides:

service in class ServiceableAction

Throws:

ServiceException

getTagProviderEPRole

public abstract String getTagProviderEPRole()

Get the tag provider extension point role

Returns:

the tag provider extension point role

act

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

Throws:

IOException

SAXException

ProcessingException

_getFilteredTags

protected Map<String,? extends Tag> _getFilteredTags(Map<String,? extends Tag> tags,
                                                           Map<String,Object> jsParameters)

Get filtered tags

Parameters:

tags - the tags to filter

jsParameters - the js parameters

Returns:

the map of tags

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<? extends Tag> tagProvider,
                                             List<String> objectTargetIds,
                                             Map<String,Object> jsParameters)

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

jsParameters - the js parameters

Returns:

The tag properties

providerToJSON

protected Map<String,Object> providerToJSON(TagProvider<? extends Tag> tagProvider,
                                                  Map<String,Object> contextualParameters,
                                                  Map<String,Object> jsParameters)

Get tag provider's properties to JSON format

Parameters:

tagProvider - the tag provider

contextualParameters - The contextual parameters

jsParameters - The js parameters

Returns:

The tag providers properties

Throws:

AmetysRepositoryException - If an error occurred

isUserAuthorized

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

Test if a tag is visible to the current user.

Parameters:

tag - the Tag object.

objectTargetIds - the ids of current Ametys objects

jsParameters - The js parameters

Returns:

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

isCreationAllowed

protected boolean isCreationAllowed(TagProvider<? extends Tag> 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