Package org.silverpeas.components.forums.service

Class DefaultForumService

java.lang.Object

org.silverpeas.components.forums.service.DefaultForumService

All Implemented Interfaces:

ForumService

@Service
public class DefaultForumService
extends Object
implements ForumService

Forums service layer which manage forums application

Constructor Summary

Constructors

Constructor	Description
DefaultForumService()

Method Summary

Modifier and Type	Method	Description
void	addModerator(ForumPK forumPK, String userId)
String	createCategory(org.silverpeas.core.node.model.NodeDetail category)
int	createForum(ForumPK forumPK, String forumName, String forumDescription, String forumCreator, int forumParent, String categoryId, String keywords)	Cree un nouveau forum dans la datasource
void	createIndex(ForumPK forumPK)
void	createIndex(MessagePK messagePK)	Method declaration
int	createMessage(MessagePK messagePK, String title, String authorId, Date creationDate, int forumId, int parentId, String content, String keywords, String status)	Create new forum message
void	deleteAll(String instanceId)
void	deleteCategory(String categoryId, String instanceId)
void	deleteForum(ForumPK forumPK)	Supprime un forum et tous ses sous-forums a partir de sa primary key
void	deleteMessage(MessagePK messagePK)	Supprime un message et tous ses sous-messages a partir de sa primary key
Collection<org.silverpeas.core.node.model.NodeDetail>	getAllCategories(String instanceId)
Collection<String>	getAllMessageSons(MessagePK messagePK)	Liste tous les sous-messages d'un message récursivement
int	getAuthorNbMessages(String userId, String status)
org.silverpeas.core.node.model.NodeDetail	getCategory(org.silverpeas.core.node.model.NodePK pk)
Forum	getForum(ForumPK forumPK)
String	getForumCreatorId(int forumId)
ForumDetail	getForumDetail(ForumPK forumPK)
String	getForumInstanceId(int forumId)
String	getForumName(int forumId)
int	getForumParentId(int forumId)
ForumPath	getForumPath(ForumPK forumPK)
Collection<Forum>	getForumRootList(String instanceId)	Gets all forums of an instanceId that have not parent forum.
Collection<ForumDetail>	getForums(Collection<ForumPK> forumPKs)
List<Forum>	getForums(ForumPK forumPK)
List<Forum>	getForumsByCategory(ForumPK forumPK, String categoryId)
Collection<Forum>	getForumsList(Collection<ForumPK> forumPKs)
List<String>	getForumSonsIds(ForumPK forumPK)
String	getForumTags(ForumPK forumPK)
Message	getLastMessage(ForumPK forumPK, int messageParentId, String status)
Message	getLastMessage(ForumPK forumPK, String status)	Retourne le dernier message d'un forum
Message	getLastMessage(ForumPK forumPK, List<String> messageParentIds, String status)
Collection	getLastMessageRSS(String instanceId, int nbReturned)
Collection<Message>	getLastThreads(ForumPK forumPK, int count)
Message	getMessage(MessagePK messagePK)
int	getMessageParentId(int messageId)
MessagePath	getMessagePath(MessagePK messagePK)
Collection<Message>	getMessages(ForumPK forumPK)
Collection<String>	getMessageSons(MessagePK messagePK)	Liste tous les sous-messages d'un message
String	getMessageTags(MessagePK messagePK)
String	getMessageTitle(int messageId)
List<Moderator>	getModerators(int forumId)
int	getNbMessages(int forumId, String type, String status)
int	getNbResponses(int forumId, int messageId, String status)
Collection<Message>	getNotAnsweredLastThreads(ForumPK forumPK, int count)
int	getSilverObjectId(ForumPK forumPK)
protected org.silverpeas.core.subscription.SubscriptionService	getSubscribeService()	Gets instance of centralized subscription services.
Collection<Message>	getThreadsList(Collection<MessagePK> messagePKs)
protected String	getWysiwygContent(String componentId, String messageId)
boolean	isForumActive(int forumId)
boolean	isModerator(String userId, ForumPK forumPK)
boolean	isNewMessage(String userId, ForumPK forumPK, int messageParentId, String status)
boolean	isNewMessageByForum(String userId, ForumPK forumPK, String status)	Retourne vrai s'il y a des messages non lus sur ce forum depuis la dernière visite
boolean	isSubscriber(String instanceId, String userId)	Indicates if the given user has subscribed to the given component instance identifier.
boolean	isSubscriber(ForumPK forumPK, String userId)	Indicates if the given user has subscribed to the given forum identifier.
boolean	isSubscriber(MessagePK messagePK, String userId)	Indicates if the given user has subscribed to the given forum message identifier.
boolean	isSubscriberByInheritance(ForumPK forumPK, String userId)	Indicates if the given user is subscribed by inheritance to the given forum identifier.
boolean	isSubscriberByInheritance(MessagePK messagePK, String userId)	Indicates if the given user is subscribed by inheritance to the given forum message identifier.
org.silverpeas.core.subscription.util.SubscriptionSubscriberList	listAllSubscribers(String instanceId)	Gets the list of subscribers to the given component instance identifier.
org.silverpeas.core.subscription.util.SubscriptionSubscriberList	listAllSubscribers(ForumPK forumPK)	Gets the list of subscribers related to the given forum primary key.
org.silverpeas.core.subscription.util.SubscriptionSubscriberList	listAllSubscribers(MessagePK messagePK)	Gets the list of subscribers related to the given forum message primary key.
void	lockForum(ForumPK forumPK, int level)	Verrouille recursivement l'arborescence d'un forum en ecriture a partir de sa primary key
void	moveMessage(MessagePK messagePK, ForumPK forumPK)
protected Connection	openConnection()	Open connection
void	removeAllModerators(ForumPK forumPK)
void	removeModerator(ForumPK forumPK, String userId)
void	setLastVisit(String userId, int messageId)	enregistre la date de la dernière visite d'un utilisateur sur un forum
void	subscribeForum(ForumPK forumPK, String userId)	Subscribe the given user to the given forum.
void	subscribeMessage(MessagePK messagePK, String userId)	Subscribe the given user to the given forum message.
int	unlockForum(ForumPK forumPK, int level)	Deverrouille recursivement un forum en ecriture a partir de sa primary key
void	unsubscribeForum(ForumPK forumPK, String userId)	Unsubscribe the given user to the given forum.
void	unsubscribeMessage(MessagePK messagePK, String userId)	Unsubscribe the given user to the given forum message.
void	updateCategory(org.silverpeas.core.node.model.NodeDetail category)
void	updateForum(ForumPK forumPK, String forumName, String forumDescription, int forumParent, String categoryId, String keywords)	Met a jour les informations sur un forum dans la datasource
void	updateMessage(MessagePK messagePK, String title, String message, String userId, String status)
void	updateMessageKeywords(MessagePK messagePK, String keywords)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DefaultForumService

public DefaultForumService()

Method Detail

getForums

public Collection<ForumDetail> getForums(Collection<ForumPK> forumPKs)

Specified by:

getForums in interface ForumService

getForum

public Forum getForum(ForumPK forumPK)

Specified by:

getForum in interface ForumService

getForumPath

public ForumPath getForumPath(ForumPK forumPK)

Specified by:

getForumPath in interface ForumService

getForumRootList

public Collection<Forum> getForumRootList(String instanceId)

Gets all forums of an instanceId that have not parent forum.

Specified by:

getForumRootList in interface ForumService

Parameters:

instanceId -

Returns:

getForumsList

public Collection<Forum> getForumsList(Collection<ForumPK> forumPKs)

Specified by:

getForumsList in interface ForumService

getThreadsList

public Collection<Message> getThreadsList(Collection<MessagePK> messagePKs)

Specified by:

getThreadsList in interface ForumService

getForumName

public String getForumName(int forumId)

Specified by:

getForumName in interface ForumService

deleteAll

public void deleteAll(String instanceId)

Specified by:

deleteAll in interface ForumService

isForumActive

public boolean isForumActive(int forumId)

Specified by:

isForumActive in interface ForumService

getForumParentId

public int getForumParentId(int forumId)

Specified by:

getForumParentId in interface ForumService

getForumInstanceId

public String getForumInstanceId(int forumId)

Specified by:

getForumInstanceId in interface ForumService

getForumCreatorId

public String getForumCreatorId(int forumId)

getForums

public List<Forum> getForums(ForumPK forumPK)

Specified by:

getForums in interface ForumService

Parameters:

forumPK -

Returns:

getForumDetail

public ForumDetail getForumDetail(ForumPK forumPK)

Specified by:

getForumDetail in interface ForumService

Parameters:

forumPK - forum primary key

Returns:

a ForumDetail from the forum primary key identifier

getForumsByCategory

public List<Forum> getForumsByCategory(ForumPK forumPK,
                                       String categoryId)

Specified by:

getForumsByCategory in interface ForumService

getForumSonsIds

public List<String> getForumSonsIds(ForumPK forumPK)

Specified by:

getForumSonsIds in interface ForumService

Parameters:

forumPK -

Returns:

lockForum

public void lockForum(ForumPK forumPK,
                      int level)

Verrouille recursivement l'arborescence d'un forum en ecriture a partir de sa primary key

Specified by:

lockForum in interface ForumService

Parameters:

forumPK - la primary key du forum

level - le niveau de verrouillage

unlockForum

public int unlockForum(ForumPK forumPK,
                       int level)

Deverrouille recursivement un forum en ecriture a partir de sa primary key

Specified by:

unlockForum in interface ForumService

Parameters:

forumPK - la primary key du forum

level - le niveau de verrouillage

Returns:

int le code d'erreur

deleteForum

public void deleteForum(ForumPK forumPK)

Supprime un forum et tous ses sous-forums a partir de sa primary key

Specified by:

deleteForum in interface ForumService

Parameters:

forumPK - la primary key du forum

createForum

public int createForum(ForumPK forumPK,
                       String forumName,
                       String forumDescription,
                       String forumCreator,
                       int forumParent,
                       String categoryId,
                       String keywords)

Cree un nouveau forum dans la datasource

Specified by:

createForum in interface ForumService

Parameters:

forumPK - la primary key

forumName - nom du forum

forumDescription - description du forum

forumCreator - l'id du createur du forum

forumParent - l'id du forum parent

categoryId - l'id de la categorie

keywords -

Returns:

String l'id du nouveau forum

updateForum

public void updateForum(ForumPK forumPK,
                        String forumName,
                        String forumDescription,
                        int forumParent,
                        String categoryId,
                        String keywords)

Met a jour les informations sur un forum dans la datasource

Specified by:

updateForum in interface ForumService

Parameters:

forumPK - la primary key du forum

forumName - nom du forum

forumDescription - description du forum

forumParent - l'id du forum parent

categoryId - l'id de la catégorie

keywords - the keywords associated to this forum.

getMessages

public Collection<Message> getMessages(ForumPK forumPK)

Specified by:

getMessages in interface ForumService

getNbMessages

public int getNbMessages(int forumId,
                         String type,
                         String status)

Specified by:

getNbMessages in interface ForumService

getAuthorNbMessages

public int getAuthorNbMessages(String userId,
                               String status)

Specified by:

getAuthorNbMessages in interface ForumService

getNbResponses

public int getNbResponses(int forumId,
                          int messageId,
                          String status)

Specified by:

getNbResponses in interface ForumService

getLastMessage

public Message getLastMessage(ForumPK forumPK,
                              String status)

Retourne le dernier message d'un forum

Specified by:

getLastMessage in interface ForumService

Parameters:

forumPK - la primary key du forum

status -

Returns:

the last message in a forum with the specified status.

getLastMessageRSS

public Collection getLastMessageRSS(String instanceId,
                                    int nbReturned)

Specified by:

getLastMessageRSS in interface ForumService

getLastMessage

public Message getLastMessage(ForumPK forumPK,
                              int messageParentId,
                              String status)

Specified by:

getLastMessage in interface ForumService

getLastMessage

public Message getLastMessage(ForumPK forumPK,
                              List<String> messageParentIds,
                              String status)

Specified by:

getLastMessage in interface ForumService

isNewMessageByForum

public boolean isNewMessageByForum(String userId,
                                   ForumPK forumPK,
                                   String status)

Retourne vrai s'il y a des messages non lus sur ce forum depuis la dernière visite

Specified by:

isNewMessageByForum in interface ForumService

Parameters:

userId - l'id de l'utilisateur

forumPK - l'id du forum

status - le status (validé, en attente, ...)

Returns:

isNewMessage

public boolean isNewMessage(String userId,
                            ForumPK forumPK,
                            int messageParentId,
                            String status)

Specified by:

isNewMessage in interface ForumService

setLastVisit

public void setLastVisit(String userId,
                         int messageId)

enregistre la date de la dernière visite d'un utilisateur sur un forum

Specified by:

setLastVisit in interface ForumService

Parameters:

messageId - l'id du message

userId - l'id de l'utilisateur

getMessage

public Message getMessage(MessagePK messagePK)

Specified by:

getMessage in interface ForumService

getMessagePath

public MessagePath getMessagePath(MessagePK messagePK)

Specified by:

getMessagePath in interface ForumService

getMessageTitle

public String getMessageTitle(int messageId)

Specified by:

getMessageTitle in interface ForumService

getMessageParentId

public int getMessageParentId(int messageId)

Specified by:

getMessageParentId in interface ForumService

createMessage

public int createMessage(MessagePK messagePK,
                         String title,
                         String authorId,
                         Date creationDate,
                         int forumId,
                         int parentId,
                         String content,
                         String keywords,
                         String status)

Create new forum message

Specified by:

createMessage in interface ForumService

Parameters:

messagePK - message primary key identifier

title - message title

authorId - message author identifier

creationDate - creation date

forumId - forum identifier

parentId - parent message identifier

content - message content

keywords - the message keywords

status - the message status

Returns:

new message identifier

updateMessage

public void updateMessage(MessagePK messagePK,
                          String title,
                          String message,
                          String userId,
                          String status)

Specified by:

updateMessage in interface ForumService

updateMessageKeywords

public void updateMessageKeywords(MessagePK messagePK,
                                  String keywords)

Specified by:

updateMessageKeywords in interface ForumService

deleteMessage

public void deleteMessage(MessagePK messagePK)

Supprime un message et tous ses sous-messages a partir de sa primary key

Specified by:

deleteMessage in interface ForumService

Parameters:

messagePK - la primary key du message

Since:

04 Octobre 2000

isModerator

public boolean isModerator(String userId,
                           ForumPK forumPK)

Specified by:

isModerator in interface ForumService

Parameters:

userId -

forumPK -

Returns:

addModerator

public void addModerator(ForumPK forumPK,
                         String userId)

Specified by:

addModerator in interface ForumService

Parameters:

forumPK -

userId -

removeModerator

public void removeModerator(ForumPK forumPK,
                            String userId)

Specified by:

removeModerator in interface ForumService

Parameters:

forumPK -

userId -

removeAllModerators

public void removeAllModerators(ForumPK forumPK)

Specified by:

removeAllModerators in interface ForumService

Parameters:

forumPK -

getModerators

public List<Moderator> getModerators(int forumId)

Specified by:

getModerators in interface ForumService

moveMessage

public void moveMessage(MessagePK messagePK,
                        ForumPK forumPK)

Specified by:

moveMessage in interface ForumService

Parameters:

messagePK -

forumPK -

getMessageSons

public Collection<String> getMessageSons(MessagePK messagePK)

Liste tous les sous-messages d'un message

Parameters:

messagePK - la primary key du message pere

Returns:

Vector liste des ids fils

getAllMessageSons

public Collection<String> getAllMessageSons(MessagePK messagePK)

Liste tous les sous-messages d'un message récursivement

Parameters:

messagePK - la primary key du message pere

Returns:

Vector liste des ids fils

subscribeMessage

public void subscribeMessage(MessagePK messagePK,
                             String userId)

Subscribe the given user to the given forum message.

Specified by:

subscribeMessage in interface ForumService

Parameters:

messagePK -

userId -

unsubscribeMessage

public void unsubscribeMessage(MessagePK messagePK,
                               String userId)

Unsubscribe the given user to the given forum message.

Specified by:

unsubscribeMessage in interface ForumService

Parameters:

messagePK -

userId -

subscribeForum

public void subscribeForum(ForumPK forumPK,
                           String userId)

Subscribe the given user to the given forum.

Specified by:

subscribeForum in interface ForumService

Parameters:

forumPK -

userId -

unsubscribeForum

public void unsubscribeForum(ForumPK forumPK,
                             String userId)

Unsubscribe the given user to the given forum.

Specified by:

unsubscribeForum in interface ForumService

Parameters:

forumPK -

userId -

listAllSubscribers

public org.silverpeas.core.subscription.util.SubscriptionSubscriberList listAllSubscribers(MessagePK messagePK)

Gets the list of subscribers related to the given forum message primary key.

Specified by:

listAllSubscribers in interface ForumService

Parameters:

messagePK -

Returns:

listAllSubscribers

public org.silverpeas.core.subscription.util.SubscriptionSubscriberList listAllSubscribers(ForumPK forumPK)

Gets the list of subscribers related to the given forum primary key.

Specified by:

listAllSubscribers in interface ForumService

Parameters:

forumPK -

Returns:

listAllSubscribers

public org.silverpeas.core.subscription.util.SubscriptionSubscriberList listAllSubscribers(String instanceId)

Gets the list of subscribers to the given component instance identifier. This kind of subscribers come from WEB-Service subscriptions (/services/subscribe/{instanceId})

Specified by:

listAllSubscribers in interface ForumService

Parameters:

instanceId -

Returns:

isSubscriber

public boolean isSubscriber(MessagePK messagePK,
                            String userId)

Indicates if the given user has subscribed to the given forum message identifier.

Specified by:

isSubscriber in interface ForumService

Parameters:

messagePK -

userId -

Returns:

isSubscriberByInheritance

public boolean isSubscriberByInheritance(MessagePK messagePK,
                                         String userId)

Indicates if the given user is subscribed by inheritance to the given forum message identifier.

Specified by:

isSubscriberByInheritance in interface ForumService

Parameters:

messagePK -

userId -

Returns:

isSubscriber

public boolean isSubscriber(ForumPK forumPK,
                            String userId)

Indicates if the given user has subscribed to the given forum identifier.

Specified by:

isSubscriber in interface ForumService

Parameters:

forumPK -

userId -

Returns:

isSubscriberByInheritance

public boolean isSubscriberByInheritance(ForumPK forumPK,
                                         String userId)

Indicates if the given user is subscribed by inheritance to the given forum identifier.

Specified by:

isSubscriberByInheritance in interface ForumService

Parameters:

forumPK -

userId -

Returns:

isSubscriber

public boolean isSubscriber(String instanceId,
                            String userId)

Indicates if the given user has subscribed to the given component instance identifier.

Specified by:

isSubscriber in interface ForumService

Parameters:

instanceId -

userId -

Returns:

createIndex

public void createIndex(MessagePK messagePK)

Method declaration

Specified by:

createIndex in interface ForumService

Parameters:

messagePK -

createIndex

public void createIndex(ForumPK forumPK)

Specified by:

createIndex in interface ForumService

Parameters:

forumPK -

openConnection

protected Connection openConnection()

Open connection

Returns:

the connection

getSilverObjectId

public int getSilverObjectId(ForumPK forumPK)

Specified by:

getSilverObjectId in interface ForumService

createCategory

public String createCategory(org.silverpeas.core.node.model.NodeDetail category)

Specified by:

createCategory in interface ForumService

updateCategory

public void updateCategory(org.silverpeas.core.node.model.NodeDetail category)

Specified by:

updateCategory in interface ForumService

deleteCategory

public void deleteCategory(String categoryId,
                           String instanceId)

Specified by:

deleteCategory in interface ForumService

getCategory

public org.silverpeas.core.node.model.NodeDetail getCategory(org.silverpeas.core.node.model.NodePK pk)

Specified by:

getCategory in interface ForumService

getAllCategories

public Collection<org.silverpeas.core.node.model.NodeDetail> getAllCategories(String instanceId)

Specified by:

getAllCategories in interface ForumService

getLastThreads

public Collection<Message> getLastThreads(ForumPK forumPK,
                                          int count)

Specified by:

getLastThreads in interface ForumService

getNotAnsweredLastThreads

public Collection<Message> getNotAnsweredLastThreads(ForumPK forumPK,
                                                     int count)

Specified by:

getNotAnsweredLastThreads in interface ForumService

getForumTags

public String getForumTags(ForumPK forumPK)

Specified by:

getForumTags in interface ForumService

getMessageTags

public String getMessageTags(MessagePK messagePK)

Specified by:

getMessageTags in interface ForumService

getWysiwygContent

protected String getWysiwygContent(String componentId,
                                   String messageId)

getSubscribeService

protected org.silverpeas.core.subscription.SubscriptionService getSubscribeService()

Gets instance of centralized subscription services.

Returns: