org.ametys.cms.tag.jcr

Class ImportTagsAction

java.lang.Object

org.apache.avalon.framework.logger.AbstractLogEnabled

org.apache.cocoon.acting.AbstractAction

org.apache.cocoon.acting.ServiceableAction

org.ametys.core.util.cocoon.AbstractCurrentUserProviderServiceableAction

org.ametys.core.observation.AbstractNotifierAction

org.ametys.cms.tag.jcr.ImportTagsAction

All Implemented Interfaces:

Component, LogEnabled, Serviceable, ThreadSafe, Action

public class ImportTagsAction
extends AbstractNotifierAction

Import subscribers from a CSV or text file.

Field Summary

Fields

Modifier and Type	Field and Description
private static String[]	_ALLOWED_EXTENSIONS
private int	_createdTagsCount The count of new tags
private int	_errorCount The count of error
protected JSONUtils	_jsonUtils The JSon Utils Component
protected AmetysObjectResolver	_resolver The Ametys object resolver
protected TagProviderExtensionPoint	_tagProviderExtPt The tag provider extension point
protected TagTargetTypeExtensionPoint	_targetTypeEP Target types
private int	_updatedTagsCount The count of updated tags

Fields inherited from class org.ametys.core.observation.AbstractNotifierAction

_observationManager

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

Method Summary

Modifier and Type	Method and Description
private String	_findUniqueName(String originalName, Map<String,Object> contextualParameters)
private Set<TagProvider>	_getTagProviders()
private boolean	_hasTag(Set<TagProvider> providers, String name, Map<String,Object> contextualParameters)
Map	act(Redirector redirector, SourceResolver resolver, Map objectModel, String source, Parameters parameters)
protected I18nizableText	configureDescription(Configuration configuration, String defaultCatalogue) Configure description from the passed configuration
protected I18nizableText	configureLabel(Configuration configuration, String defaultCatalogue) Configure label from the passed configuration
protected Map<String,Tag>	configureTags(Configuration configuration, Tag parent, String defaultCatalogue) Configure tag from the passed configuration
protected void	createOrUpdateTags(DefaultTraversableAmetysObject<?> parent, Map<String,Tag> tags, Map<String,Object> contextualParameters) Save or update a tag
protected Configuration	initializeTags(String path) Initialize a configuration tags from the tags file.
void	service(ServiceManager smanager)

Methods inherited from class org.ametys.core.util.cocoon.AbstractCurrentUserProviderServiceableAction

_getCurrentUser

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

_ALLOWED_EXTENSIONS

private static final String[] _ALLOWED_EXTENSIONS

_tagProviderExtPt

protected TagProviderExtensionPoint _tagProviderExtPt

The tag provider extension point

_resolver

protected AmetysObjectResolver _resolver

The Ametys object resolver

_targetTypeEP

protected TagTargetTypeExtensionPoint _targetTypeEP

Target types

_jsonUtils

protected JSONUtils _jsonUtils

The JSon Utils Component

_createdTagsCount

private int _createdTagsCount

The count of new tags

_updatedTagsCount

private int _updatedTagsCount

The count of updated tags

_errorCount

private int _errorCount

The count of error

Constructor Detail

ImportTagsAction

public ImportTagsAction()

Method Detail

service

public void service(ServiceManager smanager)
             throws ServiceException

Specified by:

service in interface Serviceable

Overrides:

service in class AbstractNotifierAction

Throws:

ServiceException

act

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

Throws:

Exception

createOrUpdateTags

protected void createOrUpdateTags(DefaultTraversableAmetysObject<?> parent,
                                  Map<String,Tag> tags,
                                  Map<String,Object> contextualParameters)

Save or update a tag

Parameters:

parent - the JCR parent tag or provider

tags - the list of tags to add or update

contextualParameters - Contextual parameters transmitted by the environment.

initializeTags

protected Configuration initializeTags(String path)
                                throws Exception

Initialize a configuration tags from the tags file.

Parameters:

path - the path of the file to initialize tags.

Returns:

The configuration

Throws:

Exception - if an error occurs.

configureTags

protected Map<String,Tag> configureTags(Configuration configuration,
                                        Tag parent,
                                        String defaultCatalogue)
                                 throws ConfigurationException

Configure tag from the passed configuration

Parameters:

configuration - The configuration

parent - The parent tag if any

defaultCatalogue - The default catalogue for i18n

Returns:

a Set of Tag

Throws:

ConfigurationException - If an error occurred

configureLabel

protected I18nizableText configureLabel(Configuration configuration,
                                        String defaultCatalogue)
                                 throws ConfigurationException

Configure label from the passed configuration

Parameters:

configuration - The configuration

defaultCatalogue - The default catalogue

Returns:

The label

Throws:

ConfigurationException - If an error occurred

configureDescription

protected I18nizableText configureDescription(Configuration configuration,
                                              String defaultCatalogue)
                                       throws ConfigurationException

Configure description from the passed configuration

Parameters:

configuration - The configuration

defaultCatalogue - The default catalogue

Returns:

The description

Throws:

ConfigurationException - If an error occurred

_findUniqueName

private String _findUniqueName(String originalName,
                               Map<String,Object> contextualParameters)

_hasTag

private boolean _hasTag(Set<TagProvider> providers,
                        String name,
                        Map<String,Object> contextualParameters)

_getTagProviders

private Set<TagProvider> _getTagProviders()