Package org.ametys.plugins.workspaces.threads

Class WorkspaceThreadDAO

java.lang.Object

org.apache.avalon.framework.logger.AbstractLogEnabled

org.ametys.plugins.explorer.threads.actions.ThreadDAO

org.ametys.plugins.workspaces.threads.WorkspaceThreadDAO

All Implemented Interfaces:

PluginAware, Component, Contextualizable, LogEnabled, Serviceable

public class WorkspaceThreadDAO
extends ThreadDAO
implements PluginAware, Contextualizable

DAO for manipulating thread of a project

Field Summary

Fields

Modifier and Type	Field	Description
private Context	_context
private HTMLTransformer	_htmlTransformer
private WorkspaceModuleExtensionPoint	_moduleEP
private String	_pluginName
private ProjectManager	_projectManager
private SourceResolver	_sourceResolver
static String	ROLE	Avalon Role

Fields inherited from class org.ametys.plugins.explorer.threads.actions.ThreadDAO

__RIGHTS_POST_ADD, __RIGHTS_POST_DELETE, __RIGHTS_POST_EDIT, __RIGHTS_THREAD_ADD, __RIGHTS_THREAD_DELETE, __RIGHTS_THREAD_EDIT, _currentUserProvider, _explorerResourcesDAO, _manager, _observationManager, _resolver, _rightManager, _userHelper, _userManager

Constructor Summary

Constructors

Constructor	Description
WorkspaceThreadDAO()

Method Summary

Modifier and Type	Method	Description
Map<String,Object>	addThread(String name, String description)	Add a thread
void	contextualize(Context context)
protected String	getPostContent(JCRPost post)	Get the content of a post as a String
protected String	getPostContentForEditing(JCRPost post)	Get the content of a post to edit as a String
Long	getThreadsCount(Project project)	Get the number of threads in the project
Map<String,Object>	getThreadsList(boolean includeChildren)	Get the list of threads of a project
void	service(ServiceManager manager)
void	setPluginInfo(String pluginName, String featureName, String id)	Sets the plugin info relative to the current component. Note : The feature name may be null if the targeted component in declared at plugin level.
protected void	setPostContent(JCRPost post, String content)	Update the content of a post

Methods inherited from class org.ametys.plugins.explorer.threads.actions.ThreadDAO

_formatAuthor, _getPostDataFullInfo, _getUserRights, addPost, addThread, canDelete, canEdit, convertPostToString, deletePost, deleteThread, editPost, editThread, getPostData, getPostDataById, getPostsData, getPostsDataByIds, getThreadData, getThreadData, markAsRead, renameThread

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

Avalon Role

_htmlTransformer

private HTMLTransformer _htmlTransformer

_sourceResolver

private SourceResolver _sourceResolver

_pluginName

private String _pluginName

_projectManager

private ProjectManager _projectManager

_context

private Context _context

_moduleEP

private WorkspaceModuleExtensionPoint _moduleEP

Constructor Detail

WorkspaceThreadDAO

public WorkspaceThreadDAO()

Method Detail

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Overrides:

service in class ThreadDAO

Throws:

ServiceException

setPluginInfo

public void setPluginInfo(String pluginName,
                          String featureName,
                          String id)

Description copied from interface: PluginAware

Sets the plugin info relative to the current component.
Note : The feature name may be null if the targeted component in declared at plugin level.

Specified by:

setPluginInfo in interface PluginAware

Parameters:

pluginName - Unique identifier for the plugin hosting the extension

featureName - Unique feature identifier (unique for a given pluginName)

id - Unique identifier of this component

contextualize

public void contextualize(Context context)
                   throws ContextException

Specified by:

contextualize in interface Contextualizable

Throws:

ContextException

getThreadsList

public Map<String,Object> getThreadsList(boolean includeChildren)

Get the list of threads of a project

Parameters:

includeChildren - True to also include threads messages

Returns:

The list of threads

addThread

public Map<String,Object> addThread(String name,
                                          String description)
                                   throws IllegalAccessException,
                                          AmetysRepositoryException

Add a thread

Parameters:

name - The desired name for the thread

description - The thread description

Returns:

The result map with id, parentId and name keys

Throws:

IllegalAccessException - If the user has no sufficient rights

AmetysRepositoryException - If a repository error occurred

setPostContent

protected void setPostContent(JCRPost post,
                              String content)

Description copied from class: ThreadDAO

Update the content of a post

Overrides:

setPostContent in class ThreadDAO

Parameters:

post - The post to update

content - The content as string

getPostContent

protected String getPostContent(JCRPost post)
                         throws AmetysRepositoryException

Description copied from class: ThreadDAO

Get the content of a post as a String

Overrides:

getPostContent in class ThreadDAO

Parameters:

post - the post

Returns:

The content as String

Throws:

AmetysRepositoryException - if failed to parse content

getPostContentForEditing

protected String getPostContentForEditing(JCRPost post)
                                   throws AmetysRepositoryException

Description copied from class: ThreadDAO

Get the content of a post to edit as a String

Overrides:

getPostContentForEditing in class ThreadDAO

Parameters:

post - the post

Returns:

The content as String

Throws:

AmetysRepositoryException - if failed to parse content

getThreadsCount

public Long getThreadsCount(Project project)

Get the number of threads in the project

Parameters:

project - The project

Returns:

The number of threads, or null if the module is not activated