org.ametys.cms.tag.jcr

Class JCRTagsDAO

java.lang.Object

org.apache.avalon.framework.logger.AbstractLogEnabled

org.ametys.cms.tag.jcr.JCRTagsDAO

All Implemented Interfaces:

Component, LogEnabled, Serviceable

public class JCRTagsDAO
extends AbstractLogEnabled
implements Serviceable, Component

Component for operations on JCR tags

Field Summary

Fields

Modifier and Type	Field and Description
protected CurrentUserProvider	_currentUserProvider The current user provider
protected ObservationManager	_observationManager Observer manager.
protected AmetysObjectResolver	_resolver The Ametys object resolver
protected RightManager	_rightManager The rights manager
protected TagProviderExtensionPoint	_tagProviderExtPt The tag provider extension point
protected TagsDAO	_tagsDAO Tags DAO
protected TagTargetTypeExtensionPoint	_targetTypeEP Target types
static String	ROLE The Avalon role

Constructor Summary

Constructors

Constructor and Description
JCRTagsDAO()

Method Summary

Modifier and Type	Method and Description
protected void	_checkUserRight(String rightId, String context) Check if the user right to access the feature
protected String	_findUniqueName(String originalName, Map<String,Object> contextualParameters) Find a unique name for the tag
protected Set<TagProvider>	_getTagProviders() Get all tag's providers
protected boolean	_hasTag(Set<TagProvider> providers, String name, Map<String,Object> contextualParameters) Determines if a tag with given name already exists
JCRTag	addTag(String parentId, String originalName, String title, String description, String visibility, String targetType, Map<String,Object> contextualParameters) Create a new tag regardless of user rights.
Map<String,Object>	createTag(String parentId, String originalName, String title, String description, String visibility, String targetType, Map<String,Object> contextualParameters) Create a new tag from client-side.
Map<String,Object>	deleteTag(String tagId, Map<String,Object> contextualParameters) Deletes a JCR tag
Map<String,Object>	getTag(String tagId) Find a JCR tag and return its data
Map<String,Object>	getTagRootNode(String tagProviderId, Map<String,Object> contextualParameters) Get the root node for tags
Map<String,Object>	moveTags(String targetId, List<String> ids) Deletes a JCR tag
void	service(ServiceManager serviceManager)
Map<String,Object>	updateTag(String tagId, String title, String description, String visibility, String targetType) Updates a JCR tag

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

ROLE

public static final String ROLE

The Avalon role

_tagProviderExtPt

protected TagProviderExtensionPoint _tagProviderExtPt

The tag provider extension point

_resolver

protected AmetysObjectResolver _resolver

The Ametys object resolver

_observationManager

protected ObservationManager _observationManager

Observer manager.

_currentUserProvider

protected CurrentUserProvider _currentUserProvider

The current user provider

_rightManager

protected RightManager _rightManager

The rights manager

_targetTypeEP

protected TagTargetTypeExtensionPoint _targetTypeEP

Target types

_tagsDAO

protected TagsDAO _tagsDAO

Tags DAO

Constructor Detail

JCRTagsDAO

public JCRTagsDAO()

Method Detail

service

public void service(ServiceManager serviceManager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

getTagRootNode

public Map<String,Object> getTagRootNode(String tagProviderId,
                                         Map<String,Object> contextualParameters)
                                  throws ProcessingException

Get the root node for tags

Parameters:

tagProviderId - The tag provider id

contextualParameters - Contextual parameters transmitted by the environment.

Returns:

The root node in key "id"

Throws:

ProcessingException - If an error occured in the repository

createTag

public Map<String,Object> createTag(String parentId,
                                    String originalName,
                                    String title,
                                    String description,
                                    String visibility,
                                    String targetType,
                                    Map<String,Object> contextualParameters)

Create a new tag from client-side. User rights are checked.

Parameters:

parentId - The id of parent tag

originalName - The original name

title - The tag's title

description - The tag's description

visibility - The tag's visibility

targetType - The tag's target type

contextualParameters - Contextual parameters transmitted by the environment.

Returns:

The result map

addTag

public JCRTag addTag(String parentId,
                     String originalName,
                     String title,
                     String description,
                     String visibility,
                     String targetType,
                     Map<String,Object> contextualParameters)
              throws UnknownAmetysObjectException,
                     RepositoryException

Create a new tag regardless of user rights.

Parameters:

parentId - The id of parent tag

originalName - The original name

title - The tag's title

description - The tag's description

visibility - The tag's visibility

targetType - The tag's target type

contextualParameters - Contextual parameters transmitted by the environment.

Returns:

The created JCR tag

Throws:

UnknownAmetysObjectException - if the parent does not exist

RepositoryException - if failed to create tag

getTag

public Map<String,Object> getTag(String tagId)

Find a JCR tag and return its data

Parameters:

tagId - The tag's id

Returns:

The result map

updateTag

public Map<String,Object> updateTag(String tagId,
                                    String title,
                                    String description,
                                    String visibility,
                                    String targetType)

Updates a JCR tag

Parameters:

tagId - The tag's id

title - The tag's title

description - The tag's description

visibility - The tag's visibility

targetType - The tag's target type

Returns:

The result map

deleteTag

public Map<String,Object> deleteTag(String tagId,
                                    Map<String,Object> contextualParameters)

Deletes a JCR tag

Parameters:

tagId - The tag's id

contextualParameters - Contextual parameters transmitted by the environment.

Returns:

the result map

_checkUserRight

protected void _checkUserRight(String rightId,
                               String context)
                        throws IllegalStateException

Check if the user right to access the feature

Parameters:

rightId - The right ide

context - The right context

Throws:

IllegalStateException - if the user has no right

_findUniqueName

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

Find a unique name for the tag

Parameters:

originalName - The requested name

contextualParameters - Contextual parameters transmitted by the environment.

Returns:

A unique name

_hasTag

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

Determines if a tag with given name already exists

Parameters:

providers - The tag providers

name - The name of the tag

contextualParameters - Contextual parameters transmitted by the environment.

Returns:

true if the tag exists

_getTagProviders

protected Set<TagProvider> _getTagProviders()

Get all tag's providers

Returns:

the providers

moveTags

public Map<String,Object> moveTags(String targetId,
                                   List<String> ids)
                            throws ProcessingException

Deletes a JCR tag

Parameters:

targetId - The tag where to move to

ids - The ids of tag to move

Returns:

the result map

Throws:

ProcessingException - If an error occurred