Package org.gcube.portal.databook.server

Class DBCassandraAstyanaxImpl

java.lang.Object

org.gcube.portal.databook.server.DBCassandraAstyanaxImpl

All Implemented Interfaces:

DatabookStore

public final class DBCassandraAstyanaxImpl
extends Object
implements DatabookStore

Author:

Massimiliano Assante ISTI-CNR, Costantino Perciante ISTI-CNR, Ahmed Ibrahim ISTI-CNR This class is used for querying and adding data to Cassandra via Datastax High Level API

Constructor Summary

Constructors

Modifier	Constructor	Description
	DBCassandraAstyanaxImpl()	public constructor, no dropping schema is allowed
protected	DBCassandraAstyanaxImpl(boolean dropSchema)	use this constructor carefully from test classes
	DBCassandraAstyanaxImpl(String infrastructureName)	public constructor, no dropping schema is allowed, infrastructureName is given.

Method Summary

Modifier and Type	Method	Description
boolean	addComment(Comment comment)	add a comment to a feed
boolean	approveFriendship(String from, String to)	Approves a friendship request from one user to another.
boolean	checkUnreadMessagesNotifications(String userid)
boolean	checkUnreadNotifications(String userid)
void	closeConnection()	close the connection to the underlying database
boolean	deleteComment(String commentid, String feedid)	deletes a comment
boolean	deleteFeed(String feedId)	Deprecated.
boolean	deleteHashTags(String feedid, String vreid, List<String> hashtags)
boolean	deleteHashTagsComment(String commentId, String vreid, List<String> hashtags)
boolean	deletePost(String postid)	delete a Feed from the store
boolean	denyFriendship(String from, String to)	Denies a friendship request from one user to another.
boolean	editComment(Comment comment2Edit)	edit a comment
List<Comment>	getAllCommentByFeed(String feedid)	Deprecated.
List<Comment>	getAllCommentByPost(String postid)
List<Feed>	getAllFeedsByApp(String appid)
List<Feed>	getAllFeedsByUser(String userid)	Deprecated.
List<Feed>	getAllFeedsByVRE(String vreid)	Deprecated.
List<String>	getAllLikedFeedIdsByUser(String userid)	Deprecated.
List<Feed>	getAllLikedFeedsByUser(String userid, int limit)
List<String>	getAllLikedPostIdsByUser(String userid)
List<Post>	getAllLikedPostsByUser(String userid, int limit)
List<Like>	getAllLikesByFeed(String feedid)	Deprecated.
List<Like>	getAllLikesByPost(String postid)
List<Notification>	getAllNotificationByUser(String userid, int limit)
List<Feed>	getAllPortalPrivacyLevelFeeds()	Deprecated.
List<Post>	getAllPortalPrivacyLevelPosts()	return all the feeds whose Level is PORTAL
List<Post>	getAllPostsByApp(String appid)
List<Post>	getAllPostsByUser(String userid)
List<Post>	getAllPostsByVRE(String vreid)	Returns all posts for a specified VRE.
List<String>	getAllVREIds()	Retrieve all the ids of the vre
List<Attachment>	getAttachmentsByFeedId(String feedId)
protected CassandraClusterConnection	getConnection()
List<String>	getFriends(String userid)	Gets the list of friends for a specified user.
List<Invite>	getInvitedEmailsByVRE(String vreid, InviteStatus... status)	Use to get the list of invites per VRE
List<String>	getPendingFriendRequests(String userid)	Gets the list of pending friend requests for a specified user.
List<Notification>	getRangeNotificationsByUser(String userid, int from, int quantity)
List<Feed>	getRecentCommentedFeedsByUserAndDate(String userid, long timeInMillis)	Deprecated.
List<Post>	getRecentCommentedPostsByUserAndDate(String userid, long timeInMillis)
List<Comment>	getRecentCommentsByUserAndDate(String userid, long timeInMillis)
List<Feed>	getRecentFeedsByUser(String userid, int quantity)	Deprecated.
List<Feed>	getRecentFeedsByUserAndDate(String userid, long timeInMillis)	Deprecated.
List<Feed>	getRecentFeedsByVRE(String vreid, int quantity)	Deprecated.
RangeFeeds	getRecentFeedsByVREAndRange(String vreid, int from, int quantity)	Returns the most recent posts for this VRE up to the specified quantity and the last index of the posts in the timeline.
List<Feed>	getRecentLikedFeedsByUserAndDate(String userid, long timeInMillis)
List<Post>	getRecentLikedPostsByUserAndDate(String userid, long timeInMillis)
List<Post>	getRecentPostsByUser(String userid, int quantity)	return the most recent feeds for this user up to quantity param
List<Post>	getRecentPostsByUserAndDate(String userid, long timeInMillis)
List<Post>	getRecentPostsByVRE(String vreid, int quantity)	Returns the most recent posts for a VRE, up to the specified quantity.
RangePosts	getRecentPostsByVREAndRange(String vreid, int from, int quantity)	Returns the most recent posts for a VRE within a specified range, and provides the last index of posts in the timeline for pagination purposes.
List<Notification>	getUnreadNotificationsByUser(String userid)	Returns all unread notifications for a user (excluding message notifications).
List<NotificationChannelType>	getUserNotificationChannels(String userid, NotificationType notificationType)	Returns the notification channels a user has chosen for a given notification type.
Map<NotificationType,NotificationChannelType[]>	getUserNotificationPreferences(String userid)	Gets the notification preferences map (enable or disable the channels to be used for notifying the user).
List<Feed>	getVREFeedsByHashtag(String vreid, String hashtag)
Map<String,Integer>	getVREHashtagsWithOccurrence(String vreid)	get a map of VRE hashtags where the key is the hashtag and the value is the occurrence of the hashtag in the VRE.
Map<String,Integer>	getVREHashtagsWithOccurrenceFilteredByTime(String vreid, long timestamp)	get a map of VRE hashtags where the key is the hashtag and the value is the occurrence of the hashtag in the VRE.
List<Post>	getVREPostsByHashtag(String vreid, String hashtag)	Returns all posts in a VRE that contain a specific hashtag.
String	isExistingInvite(String vreid, String email)
boolean	like(Like like)	add a like to a feed
Comment	readCommentById(String commentId)
Feed	readFeed(String feedid)	Deprecated.
Invite	readInvite(String inviteid)	read an invite from a given id
Notification	readNotification(String notificationid)	Reads a notification from a given ID.
Post	readPost(String postid)	read a feed from a given id
boolean	requestFriendship(String from, String to)	Requests a friendship from one user to another.
boolean	saveAppFeed(Feed post)	Deprecated.
boolean	saveAppFeed(Feed feed, List<Attachment> attachments)	Deprecated.
boolean	saveAppPost(Post post)	save a Post instance in the store
boolean	saveAppPost(Post post, List<Attachment> attachments)	Save a Post instance in the store Use this if your app needs to attach more than one file to the post
boolean	saveAttachmentEntry(String feedId, Attachment toSave)	save an attachment
boolean	saveFeedToVRETimeline(String feedKey, String vreid)	Deprecated.
boolean	saveHashTags(String feedid, String vreid, List<String> hashtags)
boolean	saveHashTagsComment(String commentId, String vreid, List<String> hashtags)
InviteOperationResult	saveInvite(Invite invite)	Save the invite for a given email into a given vre
boolean	saveNotification(Notification n)	save a Notification instance in the store
boolean	savePostToVRETimeline(String postKey, String vreid)	save a post in the VRES TimeLine in the store
boolean	saveUserFeed(Feed post)	Deprecated.
boolean	saveUserFeed(Feed feed, List<Attachment> attachments)	Deprecated.
boolean	saveUserPost(Post post)	save a Post instance in the store
boolean	saveUserPost(Post post, List<Attachment> attachments)	Save a Post instance in the store having more than one attachment Use this if you need to attach more than one file to the post
boolean	setAllNotificationReadByUser(String userid)	This is a fast way to set all notification to read quickly
boolean	setInviteStatus(String vreid, String email, InviteStatus status)	set the status of an invite, see InviteStatus
boolean	setNotificationRead(String notificationidToSet)	set an existing Notification instance in the to read
boolean	setUserNotificationPreferences(String userid, Map<NotificationType,NotificationChannelType[]> enabledChannels)	set the notification preferences map (enable or disable the channels to be used for notifying the user)
boolean	unlike(String userid, String likeid, String feedid)	unlike a feed

Methods inherited from class java.lang.Object

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

Constructor Details

DBCassandraAstyanaxImpl

protected DBCassandraAstyanaxImpl(boolean dropSchema)

use this constructor carefully from test classes

Parameters:

dropSchema - set true if you want do drop the current and set up new one

DBCassandraAstyanaxImpl

public DBCassandraAstyanaxImpl()

public constructor, no dropping schema is allowed

DBCassandraAstyanaxImpl

public DBCassandraAstyanaxImpl(String infrastructureName)

public constructor, no dropping schema is allowed, infrastructureName is given.

Method Details

getConnection

protected CassandraClusterConnection getConnection()

requestFriendship

public boolean requestFriendship(String from,
 String to)

Requests a friendship from one user to another.

Specified by:

requestFriendship in interface DatabookStore

Parameters:

from - The user ID requesting the friendship.

to - The user ID receiving the friendship request.

Returns:

true if the operation was successful.

approveFriendship

public boolean approveFriendship(String from,
 String to)

Approves a friendship request from one user to another.

Specified by:

approveFriendship in interface DatabookStore

Parameters:

from - The user ID approving the friendship.

to - The user ID being approved.

Returns:

true if the operation was successful.

denyFriendship

public boolean denyFriendship(String from,
 String to)

Denies a friendship request from one user to another.

Specified by:

denyFriendship in interface DatabookStore

Parameters:

from - The user ID denying the friendship.

to - The user ID being denied.

Returns:

true if the operation was successful.

getFriends

public List<String> getFriends(String userid)

Gets the list of friends for a specified user.

Specified by:

getFriends in interface DatabookStore

Parameters:

userid - The user ID to get friends for.

Returns:

A List of user IDs representing the friends of the given user.

getPendingFriendRequests

public List<String> getPendingFriendRequests(String userid)

Gets the list of pending friend requests for a specified user.

Specified by:

getPendingFriendRequests in interface DatabookStore

Parameters:

userid - The user ID to get pending friend requests for.

Returns:

A List of user IDs representing pending friend requests for the given user.

saveUserFeed

@Deprecated
public boolean saveUserFeed(Feed post)

Deprecated.

Specified by:

saveUserFeed in interface DatabookStore

Returns:

true if everything went fine

saveUserPost

public boolean saveUserPost(Post post)

save a Post instance in the store

Specified by:

saveUserPost in interface DatabookStore

Returns:

true if everything went fine

saveUserFeed

@Deprecated
public boolean saveUserFeed(Feed feed,
 List<Attachment> attachments)

Deprecated.

Save a Feed instance in the store having more than one attachment Use this if you need to attach more than one file to the post

Specified by:

saveUserFeed in interface DatabookStore

attachments - a list of attachments starting from the second

Returns:

true if everything went fine

saveUserPost

public boolean saveUserPost(Post post,
 List<Attachment> attachments)

Save a Post instance in the store having more than one attachment Use this if you need to attach more than one file to the post

Specified by:

saveUserPost in interface DatabookStore

attachments - a list of attachments starting from the second

Returns:

true if everything went fine

saveAppFeed

@Deprecated
public boolean saveAppFeed(Feed post)

Deprecated.

Specified by:

saveAppFeed in interface DatabookStore

Returns:

true if everything went fine

saveAppPost

public boolean saveAppPost(Post post)

save a Post instance in the store

Specified by:

saveAppPost in interface DatabookStore

Returns:

true if everything went fine

saveAppFeed

@Deprecated
public boolean saveAppFeed(Feed feed,
 List<Attachment> attachments)

Deprecated.

Specified by:

saveAppFeed in interface DatabookStore

attachments - a list of attachments starting from the second

Returns:

true if everything went fine

saveAppPost

public boolean saveAppPost(Post post,
 List<Attachment> attachments)

Save a Post instance in the store Use this if your app needs to attach more than one file to the post

Specified by:

saveAppPost in interface DatabookStore

attachments - a list of attachments starting from the second

Returns:

true if everything went fine

saveFeedToVRETimeline

@Deprecated
public boolean saveFeedToVRETimeline(String feedKey,
 String vreid)
                              throws FeedIDNotFoundException

Deprecated.

Save a post in the VRES TimeLine in the store

Specified by:

saveFeedToVRETimeline in interface DatabookStore

Parameters:

feedKey - feedKey

vreid - vre identifier

Throws:

FeedIDNotFoundException

savePostToVRETimeline

public boolean savePostToVRETimeline(String postKey,
 String vreid)
                              throws FeedIDNotFoundException

save a post in the VRES TimeLine in the store

Specified by:

savePostToVRETimeline in interface DatabookStore

Parameters:

postKey - the post id

vreid - vre identifier

Throws:

FeedIDNotFoundException

readFeed

@Deprecated
public Feed readFeed(String feedid)
              throws PrivacyLevelTypeNotFoundException,
FeedTypeNotFoundException,
FeedIDNotFoundException,
ColumnNameNotFoundException

Deprecated.

Specified by:

readFeed in interface DatabookStore

Throws:

PrivacyLevelTypeNotFoundException

FeedTypeNotFoundException

ColumnNameNotFoundException

FeedIDNotFoundException

readPost

public Post readPost(String postid)
              throws PrivacyLevelTypeNotFoundException,
FeedTypeNotFoundException,
FeedIDNotFoundException,
ColumnNameNotFoundException

read a feed from a given id

Specified by:

readPost in interface DatabookStore

Throws:

PrivacyLevelTypeNotFoundException

FeedTypeNotFoundException

ColumnNameNotFoundException

FeedIDNotFoundException

getRecentFeedsByUserAndDate

@Deprecated
public List<Feed> getRecentFeedsByUserAndDate(String userid,
 long timeInMillis)
                                       throws IllegalArgumentException

Deprecated.

Specified by:

getRecentFeedsByUserAndDate in interface DatabookStore

Parameters:

userid - user identifier

timeInMillis - time in milliseconds from which you want to start retrieve the feeds

Returns:

the number of feeds in the range from: today to: timeInMillis

Throws:

IllegalArgumentException

getRecentPostsByUserAndDate

public List<Post> getRecentPostsByUserAndDate(String userid,
 long timeInMillis)
                                       throws IllegalArgumentException

Specified by:

getRecentPostsByUserAndDate in interface DatabookStore

Parameters:

userid - user identifier

timeInMillis - time in milliseconds from which you want to start retrieve the feeds

Returns:

the number of feeds in the range from: today to: timeInMillis

Throws:

IllegalArgumentException

deleteFeed

@Deprecated
public boolean deleteFeed(String feedId)
                   throws FeedIDNotFoundException,
PrivacyLevelTypeNotFoundException,
FeedTypeNotFoundException,
ColumnNameNotFoundException

Deprecated.

Delete a Feed from the store

Specified by:

deleteFeed in interface DatabookStore

Returns:

true if everything went fine

Throws:

FeedIDNotFoundException

PrivacyLevelTypeNotFoundException

FeedTypeNotFoundException

ColumnNameNotFoundException

deletePost

public boolean deletePost(String postid)
                   throws FeedIDNotFoundException,
PrivacyLevelTypeNotFoundException,
FeedTypeNotFoundException,
ColumnNameNotFoundException

delete a Feed from the store

Specified by:

deletePost in interface DatabookStore

Returns:

true if everything went fine

Throws:

FeedIDNotFoundException

PrivacyLevelTypeNotFoundException

FeedTypeNotFoundException

ColumnNameNotFoundException

getAllFeedsByUser

@Deprecated
public List<Feed> getAllFeedsByUser(String userid)
                             throws PrivacyLevelTypeNotFoundException,
FeedTypeNotFoundException,
ColumnNameNotFoundException,
FeedIDNotFoundException

Deprecated.

Specified by:

getAllFeedsByUser in interface DatabookStore

Parameters:

userid - user identifier return all the feeds belonging to the userid

Throws:

PrivacyLevelTypeNotFoundException

FeedTypeNotFoundException

ColumnNameNotFoundException

FeedIDNotFoundException

getAllPostsByUser

public List<Post> getAllPostsByUser(String userid)
                             throws PrivacyLevelTypeNotFoundException,
FeedTypeNotFoundException,
ColumnNameNotFoundException,
FeedIDNotFoundException

Specified by:

getAllPostsByUser in interface DatabookStore

Parameters:

userid - user identifier return all the feeds belonging to the userid

Throws:

PrivacyLevelTypeNotFoundException

FeedTypeNotFoundException

ColumnNameNotFoundException

FeedIDNotFoundException

getAllFeedsByApp

public List<Feed> getAllFeedsByApp(String appid)
                            throws PrivacyLevelTypeNotFoundException,
FeedTypeNotFoundException,
ColumnNameNotFoundException,
FeedIDNotFoundException

Specified by:

getAllFeedsByApp in interface DatabookStore

Parameters:

appid - application identifier return all the feeds belonging to the appid

Throws:

PrivacyLevelTypeNotFoundException

FeedTypeNotFoundException

ColumnNameNotFoundException

FeedIDNotFoundException

getAllPostsByApp

public List<Post> getAllPostsByApp(String appid)
                            throws PrivacyLevelTypeNotFoundException,
FeedTypeNotFoundException,
ColumnNameNotFoundException,
FeedIDNotFoundException

Specified by:

getAllPostsByApp in interface DatabookStore

Parameters:

appid - application identifier return all the feeds belonging to the appid

Throws:

PrivacyLevelTypeNotFoundException

FeedTypeNotFoundException

ColumnNameNotFoundException

FeedIDNotFoundException

getRecentCommentedFeedsByUserAndDate

@Deprecated
public List<Feed> getRecentCommentedFeedsByUserAndDate(String userid,
 long timeInMillis)
                                                throws Exception

Deprecated.

Specified by:

getRecentCommentedFeedsByUserAndDate in interface DatabookStore

Parameters:

userid - the user identifier like andrea.rossi

timeInMillis - the initial time in millis to be considered

Returns:

a list of feeds commented by userid starting from timeInMillis

Throws:

Exception

getRecentCommentedPostsByUserAndDate

public List<Post> getRecentCommentedPostsByUserAndDate(String userid,
 long timeInMillis)
                                                throws Exception

Specified by:

getRecentCommentedPostsByUserAndDate in interface DatabookStore

Parameters:

userid - the user identifier like andrea.rossi

timeInMillis - the initial time in millis to be considered

Returns:

a list of feeds commented by userid starting from timeInMillis

Throws:

Exception

getAllPortalPrivacyLevelFeeds

@Deprecated
public List<Feed> getAllPortalPrivacyLevelFeeds()
                                         throws FeedTypeNotFoundException,
ColumnNameNotFoundException,
PrivacyLevelTypeNotFoundException

Deprecated.

Specified by:

getAllPortalPrivacyLevelFeeds in interface DatabookStore

Throws:

ColumnNameNotFoundException

PrivacyLevelTypeNotFoundException

FeedTypeNotFoundException

getAllPortalPrivacyLevelPosts

public List<Post> getAllPortalPrivacyLevelPosts()
                                         throws FeedTypeNotFoundException,
ColumnNameNotFoundException,
PrivacyLevelTypeNotFoundException

Description copied from interface: DatabookStore

return all the feeds whose Level is PORTAL

Specified by:

getAllPortalPrivacyLevelPosts in interface DatabookStore

Throws:

ColumnNameNotFoundException

PrivacyLevelTypeNotFoundException

FeedTypeNotFoundException

getRecentFeedsByUser

@Deprecated
public List<Feed> getRecentFeedsByUser(String userid,
 int quantity)
                                throws PrivacyLevelTypeNotFoundException,
FeedTypeNotFoundException,
ColumnNameNotFoundException,
FeedIDNotFoundException

Deprecated.

return the most recent feeds for this user up to quantity param

Specified by:

getRecentFeedsByUser in interface DatabookStore

Parameters:

userid - user identifier

quantity - the number of most recent feeds for this user

Returns:

a List of most recent feeds for this user

Throws:

PrivacyLevelTypeNotFoundException

FeedTypeNotFoundException

ColumnNameNotFoundException

FeedIDNotFoundException

getRecentPostsByUser

public List<Post> getRecentPostsByUser(String userid,
 int quantity)
                                throws PrivacyLevelTypeNotFoundException,
FeedTypeNotFoundException,
ColumnNameNotFoundException,
FeedIDNotFoundException

Description copied from interface: DatabookStore

return the most recent feeds for this user up to quantity param

Specified by:

getRecentPostsByUser in interface DatabookStore

Parameters:

userid - user identifier

quantity - the number of most recent feeds for this user

Returns:

a List of most recent feeds for this user

Throws:

PrivacyLevelTypeNotFoundException

FeedTypeNotFoundException

ColumnNameNotFoundException

FeedIDNotFoundException

getAllFeedsByVRE

@Deprecated
public List<Feed> getAllFeedsByVRE(String vreid)
                            throws PrivacyLevelTypeNotFoundException,
FeedTypeNotFoundException,
ColumnNameNotFoundException,
FeedIDNotFoundException

Deprecated.

Specified by:

getAllFeedsByVRE in interface DatabookStore

Parameters:

vreid - vre identifier return all the feeds belonging to the userid

Throws:

PrivacyLevelTypeNotFoundException

FeedTypeNotFoundException

ColumnNameNotFoundException

FeedIDNotFoundException

getAllPostsByVRE

public List<Post> getAllPostsByVRE(String vreid)
                            throws PrivacyLevelTypeNotFoundException,
FeedTypeNotFoundException,
ColumnNameNotFoundException,
FeedIDNotFoundException

Returns all posts for a specified VRE.

Specified by:

getAllPostsByVRE in interface DatabookStore

Parameters:

vreid - The VRE identifier.

Returns:

A List of all posts belonging to the specified VRE.

Throws:

PrivacyLevelTypeNotFoundException - If a privacy level is not recognized.

FeedTypeNotFoundException - If a feed type is not recognized.

ColumnNameNotFoundException - If a column name is not found.

FeedIDNotFoundException - If a feed ID is not found.

getRecentFeedsByVRE

@Deprecated
public List<Feed> getRecentFeedsByVRE(String vreid,
 int quantity)
                               throws PrivacyLevelTypeNotFoundException,
FeedTypeNotFoundException,
ColumnNameNotFoundException,
FeedIDNotFoundException

Deprecated.

Specified by:

getRecentFeedsByVRE in interface DatabookStore

Parameters:

vreid - VRES identifier

quantity - the number of most recent feeds for this vre

Returns:

a List of most recent feeds for this vre

Throws:

PrivacyLevelTypeNotFoundException

FeedTypeNotFoundException

ColumnNameNotFoundException

FeedIDNotFoundException

getRecentPostsByVRE

public List<Post> getRecentPostsByVRE(String vreid,
 int quantity)
                               throws PrivacyLevelTypeNotFoundException,
FeedTypeNotFoundException,
ColumnNameNotFoundException,
FeedIDNotFoundException

Description copied from interface: DatabookStore

Returns the most recent posts for a VRE, up to the specified quantity.

Specified by:

getRecentPostsByVRE in interface DatabookStore

Parameters:

vreid - The VRE identifier.

quantity - The maximum number of most recent posts to return.

Returns:

A List of most recent posts for this VRE.

Throws:

PrivacyLevelTypeNotFoundException - If a privacy level is not recognized.

FeedTypeNotFoundException - If a feed type is not recognized.

ColumnNameNotFoundException - If a column name is not found.

FeedIDNotFoundException - If a feed ID is not found.

getRecentFeedsByVREAndRange

public RangeFeeds getRecentFeedsByVREAndRange(String vreid,
 int from,
 int quantity)
                                       throws IllegalArgumentException,
PrivacyLevelTypeNotFoundException,
FeedTypeNotFoundException,
ColumnNameNotFoundException,
FeedIDNotFoundException

Returns the most recent posts for this VRE up to the specified quantity and the last index of the posts in the timeline. The lastReturnedFeedTimelineIndex is useful to know from where to start the range the next time you query, as there may be deletions.

Specified by:

getRecentFeedsByVREAndRange in interface DatabookStore

Parameters:

vreid - The VRE identifier.

from - The range start (most recent posts for this VRE). Must be greater than 0.

quantity - The number of most recent posts for this VRE starting from the "from" parameter.

Returns:

A RangeFeeds containing the most recent posts for this VRE and the last index in the timeline.

Throws:

PrivacyLevelTypeNotFoundException - If a privacy level is not recognized.

FeedTypeNotFoundException - If a feed type is not recognized.

ColumnNameNotFoundException - If a column name is not found.

FeedIDNotFoundException - If a feed ID is not found.

IllegalArgumentException

getRecentPostsByVREAndRange

public RangePosts getRecentPostsByVREAndRange(String vreid,
 int from,
 int quantity)
                                       throws IllegalArgumentException,
PrivacyLevelTypeNotFoundException,
FeedTypeNotFoundException,
ColumnNameNotFoundException,
FeedIDNotFoundException

Returns the most recent posts for a VRE within a specified range, and provides the last index of posts in the timeline for pagination purposes.

Specified by:

getRecentPostsByVREAndRange in interface DatabookStore

Parameters:

vreid - The VRE identifier.

from - The starting index (0-based) for retrieving posts. Must be greater than 0.

quantity - The maximum number of posts to retrieve starting from the "from" index.

Returns:

A RangePosts containing the most recent posts for this VRE and pagination metadata.

Throws:

PrivacyLevelTypeNotFoundException - If a privacy level is not recognized.

FeedTypeNotFoundException - If a feed type is not recognized.

ColumnNameNotFoundException - If a column name is not found.

FeedIDNotFoundException - If a feed ID is not found.

IllegalArgumentException

saveNotification

public boolean saveNotification(Notification n)

save a Notification instance in the store

Specified by:

saveNotification in interface DatabookStore

Returns:

true if everything went fine

readNotification

public Notification readNotification(String notificationid)
                              throws NotificationIDNotFoundException,
NotificationTypeNotFoundException,
ColumnNameNotFoundException

Reads a notification from a given ID.

Specified by:

readNotification in interface DatabookStore

Parameters:

notificationid - The notification ID to read.

Returns:

The Notification corresponding to the given ID.

Throws:

NotificationIDNotFoundException - If a notification ID is not found.

NotificationTypeNotFoundException - If a notification type is not recognized.

ColumnNameNotFoundException - If a column name is not found.

setNotificationRead

public boolean setNotificationRead(String notificationidToSet)
                            throws NotificationIDNotFoundException,
NotificationTypeNotFoundException,
ColumnNameNotFoundException

set an existing Notification instance in the to read

Specified by:

setNotificationRead in interface DatabookStore

Returns:

true if everything went fine

Throws:

NotificationIDNotFoundException

NotificationTypeNotFoundException

ColumnNameNotFoundException

getAllNotificationByUser

public List<Notification> getAllNotificationByUser(String userid,
 int limit)
                                            throws NotificationTypeNotFoundException,
ColumnNameNotFoundException

Specified by:

getAllNotificationByUser in interface DatabookStore

Parameters:

userid - user identifier

limit - set 0 to get everything, an int to get the most recent -limit- notifications return all the notifications belonging to the userid up to limit, set 0 to get everything

Throws:

NotificationTypeNotFoundException

ColumnNameNotFoundException

getUnreadNotificationsByUser

public List<Notification> getUnreadNotificationsByUser(String userid)
                                                throws NotificationTypeNotFoundException,
ColumnNameNotFoundException,
NotificationIDNotFoundException

Returns all unread notifications for a user (excluding message notifications).

Specified by:

getUnreadNotificationsByUser in interface DatabookStore

Parameters:

userid - The user identifier.

Returns:

A List of unread notifications for this user.

Throws:

NotificationTypeNotFoundException - If a notification type is not recognized.

ColumnNameNotFoundException - If a column name is not found.

NotificationIDNotFoundException - If a notification ID is not found.

getRangeNotificationsByUser

public List<Notification> getRangeNotificationsByUser(String userid,
 int from,
 int quantity)
                                               throws NotificationTypeNotFoundException,
ColumnNameNotFoundException,
NotificationIDNotFoundException

Specified by:

getRangeNotificationsByUser in interface DatabookStore

Parameters:

userid - user identifier

from - the range start has to be greater than 0

quantity - the number of most recent notifications for this user starting from "from" param

Returns:

all the notifications for the userid in the range requested

Throws:

NotificationTypeNotFoundException

ColumnNameNotFoundException

NotificationIDNotFoundException

setAllNotificationReadByUser

public boolean setAllNotificationReadByUser(String userid)
                                     throws NotificationTypeNotFoundException,
ColumnNameNotFoundException

This is a fast way to set all notification to read quickly

Specified by:

setAllNotificationReadByUser in interface DatabookStore

Returns:

true if everything went fine

Throws:

NotificationTypeNotFoundException - If a notification type is not recognized.

ColumnNameNotFoundException - If a column name is not found.

checkUnreadNotifications

public boolean checkUnreadNotifications(String userid)
                                 throws NotificationTypeNotFoundException,
ColumnNameNotFoundException

Specified by:

checkUnreadNotifications in interface DatabookStore

Parameters:

userid - user identifier

Returns:

true if there are unread notifications (not including messages), false if they are all read

Throws:

NotificationTypeNotFoundException

ColumnNameNotFoundException

checkUnreadMessagesNotifications

public boolean checkUnreadMessagesNotifications(String userid)
                                         throws NotificationIDNotFoundException,
NotificationTypeNotFoundException,
ColumnNameNotFoundException

Specified by:

checkUnreadMessagesNotifications in interface DatabookStore

Parameters:

userid - user identifier

Returns:

true if there are unread messages notifications (including messages), false if they are all read

Throws:

NotificationIDNotFoundException - If a notification ID is not found.

NotificationTypeNotFoundException - If a notification type is not recognized.

ColumnNameNotFoundException - If a column name is not found.

getUserNotificationChannels

public List<NotificationChannelType> getUserNotificationChannels(String userid,
 NotificationType notificationType)
                                                          throws NotificationChannelTypeNotFoundException,
NotificationTypeNotFoundException

Returns the notification channels a user has chosen for a given notification type.

Specified by:

getUserNotificationChannels in interface DatabookStore

Parameters:

userid - The user identifier.

notificationType - The type of notification.

Returns:

A list of NotificationChannelType representing the channels this user wants to be notified on.

Throws:

NotificationChannelTypeNotFoundException - If a notification channel type is not recognized.

NotificationTypeNotFoundException - If a notification type is not recognized.

setUserNotificationPreferences

public boolean setUserNotificationPreferences(String userid,
 Map<NotificationType,NotificationChannelType[]> enabledChannels)

set the notification preferences map (enable or disable the channels to be used for notifying the user)

Specified by:

setUserNotificationPreferences in interface DatabookStore

Parameters:

userid - user identifier

enabledChannels - a map of the channels to which reach the user per notification, empty array or null values to set the key notification type off

Returns:

true if everything was fine

getUserNotificationPreferences

public Map<NotificationType,NotificationChannelType[]> getUserNotificationPreferences(String userid)
                                                                               throws NotificationTypeNotFoundException,
NotificationChannelTypeNotFoundException

Gets the notification preferences map (enable or disable the channels to be used for notifying the user). by default Workspace and Calendar Notifications are set to Portal check if the number of preferences found is the same of NotificationType.values().length, if different creates the missing entries

Specified by:

getUserNotificationPreferences in interface DatabookStore

Parameters:

userid - The user identifier.

Returns:

The map of NotificationType to NotificationChannelType.

Throws:

NotificationTypeNotFoundException - If a notification type is not recognized.

NotificationChannelTypeNotFoundException - If a notification channel type is not recognized.

addComment

public boolean addComment(Comment comment)
                   throws FeedIDNotFoundException

add a comment to a feed

Specified by:

addComment in interface DatabookStore

Parameters:

comment - the Comment instance to add

Throws:

FeedIDNotFoundException

readCommentById

public Comment readCommentById(String commentId)
                        throws CommentIDNotFoundException

Specified by:

readCommentById in interface DatabookStore

Parameters:

commentId - comment unique identifier

Returns:

the comment belonging to the commentId

Throws:

CommentIDNotFoundException

getAllCommentByFeed

@Deprecated
public List<Comment> getAllCommentByFeed(String feedid)

Deprecated.

Specified by:

getAllCommentByFeed in interface DatabookStore

Parameters:

feedid - feed identifier return all the comments belonging to the feedid

getAllCommentByPost

public List<Comment> getAllCommentByPost(String postid)

Specified by:

getAllCommentByPost in interface DatabookStore

Parameters:

postid - the post identifier return all the comments belonging to the postid

getRecentCommentsByUserAndDate

public List<Comment> getRecentCommentsByUserAndDate(String userid,
 long timeInMillis)
                                             throws Exception

Specified by:

getRecentCommentsByUserAndDate in interface DatabookStore

Parameters:

userid - user identifier

timeInMillis - time in milliseconds from which you want to start retrieve the feeds

Returns:

a list of comments (sorted starting from the most recent one) made by the user since timeInMillis up to now

Throws:

Exception

editComment

public boolean editComment(Comment comment2Edit)
                    throws PrivacyLevelTypeNotFoundException,
FeedTypeNotFoundException,
ColumnNameNotFoundException,
CommentIDNotFoundException,
FeedIDNotFoundException

edit a comment

Specified by:

editComment in interface DatabookStore

Parameters:

comment2Edit - the comment to edit

Returns:

true if success, false otherwise

Throws:

PrivacyLevelTypeNotFoundException

FeedTypeNotFoundException

ColumnNameNotFoundException

CommentIDNotFoundException

FeedIDNotFoundException

deleteComment

public boolean deleteComment(String commentid,
 String feedid)
                      throws PrivacyLevelTypeNotFoundException,
FeedTypeNotFoundException,
ColumnNameNotFoundException,
CommentIDNotFoundException,
FeedIDNotFoundException

deletes a comment

Specified by:

deleteComment in interface DatabookStore

Parameters:

commentid - the comment identifier to delete

feedid - the feedid to which the comment is associated

Returns:

true if success, false otherwise

Throws:

PrivacyLevelTypeNotFoundException

FeedTypeNotFoundException

ColumnNameNotFoundException

CommentIDNotFoundException

FeedIDNotFoundException

like

public boolean like(Like like)
             throws FeedIDNotFoundException

add a like to a feed

Specified by:

like in interface DatabookStore

Parameters:

like - instance

Throws:

FeedIDNotFoundException

unlike

public boolean unlike(String userid,
 String likeid,
 String feedid)
               throws PrivacyLevelTypeNotFoundException,
FeedTypeNotFoundException,
ColumnNameNotFoundException,
LikeIDNotFoundException,
FeedIDNotFoundException

unlike a feed

Specified by:

unlike in interface DatabookStore

Parameters:

userid - user identifier

likeid - the like identifier to delete

feedid - the feedid to which the comment is associated

Returns:

true if success, false otherwise

Throws:

PrivacyLevelTypeNotFoundException

FeedTypeNotFoundException

ColumnNameNotFoundException

LikeIDNotFoundException

FeedIDNotFoundException

getAllLikedFeedIdsByUser

@Deprecated
public List<String> getAllLikedFeedIdsByUser(String userid)

Deprecated.

Specified by:

getAllLikedFeedIdsByUser in interface DatabookStore

Parameters:

userid - user identifier return all the feedids a user has liked

getAllLikedPostIdsByUser

public List<String> getAllLikedPostIdsByUser(String userid)

Specified by:

getAllLikedPostIdsByUser in interface DatabookStore

Parameters:

userid - user identifier return all the feedids a user has liked

getAllLikedFeedsByUser

public List<Feed> getAllLikedFeedsByUser(String userid,
 int limit)
                                  throws PrivacyLevelTypeNotFoundException,
FeedTypeNotFoundException,
ColumnNameNotFoundException,
FeedIDNotFoundException

Specified by:

getAllLikedFeedsByUser in interface DatabookStore

Parameters:

userid - user identifier

limit - set 0 to get everything, an int to get the most recent -limit- liked feeds

Throws:

PrivacyLevelTypeNotFoundException

FeedTypeNotFoundException - .

ColumnNameNotFoundException - .

FeedIDNotFoundException - .

getAllLikedPostsByUser

public List<Post> getAllLikedPostsByUser(String userid,
 int limit)
                                  throws PrivacyLevelTypeNotFoundException,
FeedTypeNotFoundException,
ColumnNameNotFoundException,
FeedIDNotFoundException

Specified by:

getAllLikedPostsByUser in interface DatabookStore

Parameters:

userid - user identifier

limit - set 0 to get everything, an int to get the most recent -limit- liked posts

Throws:

PrivacyLevelTypeNotFoundException

FeedTypeNotFoundException - .

ColumnNameNotFoundException - .

FeedIDNotFoundException - .

getRecentLikedFeedsByUserAndDate

public List<Feed> getRecentLikedFeedsByUserAndDate(String userid,
 long timeInMillis)
                                            throws IllegalArgumentException

Specified by:

getRecentLikedFeedsByUserAndDate in interface DatabookStore

Parameters:

userid - user identifier

timeInMillis - time in milliseconds from which you want to start retrieve the feeds

Returns:

the likes made to feeds in the range from: today to: timeInMillis

Throws:

IllegalArgumentException

getRecentLikedPostsByUserAndDate

public List<Post> getRecentLikedPostsByUserAndDate(String userid,
 long timeInMillis)
                                            throws IllegalArgumentException

Specified by:

getRecentLikedPostsByUserAndDate in interface DatabookStore

Parameters:

userid - user identifier

timeInMillis - time in milliseconds from which you want to start retrieve the feeds

Returns:

the likes made to feeds in the range from: today to: timeInMillis

Throws:

IllegalArgumentException

getAllLikesByFeed

@Deprecated
public List<Like> getAllLikesByFeed(String feedid)

Deprecated.

Specified by:

getAllLikesByFeed in interface DatabookStore

Parameters:

feedid - postid identifier return all the likes belonging to the postid

getAllLikesByPost

public List<Like> getAllLikesByPost(String postid)

Specified by:

getAllLikesByPost in interface DatabookStore

Parameters:

postid - postid identifier return all the likes belonging to the postid

saveHashTags

public boolean saveHashTags(String feedid,
 String vreid,
 List<String> hashtags)
                     throws FeedIDNotFoundException

Specified by:

saveHashTags in interface DatabookStore

Parameters:

feedid - the postid to which the hashtag is associated

vreid - VRE identifier

hashtags - the hashtag including the '#'

Returns:

true if success, false otherwise

Throws:

FeedIDNotFoundException

deleteHashTags

public boolean deleteHashTags(String feedid,
 String vreid,
 List<String> hashtags)
                       throws FeedIDNotFoundException

Specified by:

deleteHashTags in interface DatabookStore

Parameters:

feedid - the postid to which the hashtag is associated

vreid - VRE identifier

hashtags - the hashtag including the '#'

Returns:

true if success, false otherwise

Throws:

FeedIDNotFoundException

saveHashTagsComment

public boolean saveHashTagsComment(String commentId,
 String vreid,
 List<String> hashtags)
                            throws CommentIDNotFoundException

Specified by:

saveHashTagsComment in interface DatabookStore

Parameters:

commentId - the commentId to which the hashtag is associated

vreid - VRE identifier

hashtags - the hashtag including the '#'

Returns:

true if success, false otherwise

Throws:

CommentIDNotFoundException

deleteHashTagsComment

public boolean deleteHashTagsComment(String commentId,
 String vreid,
 List<String> hashtags)
                              throws CommentIDNotFoundException

Specified by:

deleteHashTagsComment in interface DatabookStore

Parameters:

commentId - the commentId to which the hashtag is associated

vreid - VRE identifier

hashtags - the hashtag including the '#'

Returns:

true if success, false otherwise

Throws:

CommentIDNotFoundException

getVREHashtagsWithOccurrence

public Map<String,Integer> getVREHashtagsWithOccurrence(String vreid)

get a map of VRE hashtags where the key is the hashtag and the value is the occurrence of the hashtag in the VRE.

Specified by:

getVREHashtagsWithOccurrence in interface DatabookStore

Parameters:

vreid - VRE identifier (scope).

Returns:

a Map of hashtags associated with their occurrence.

getVREHashtagsWithOccurrenceFilteredByTime

public Map<String,Integer> getVREHashtagsWithOccurrenceFilteredByTime(String vreid,
 long timestamp)

get a map of VRE hashtags where the key is the hashtag and the value is the occurrence of the hashtag in the VRE.

Specified by:

getVREHashtagsWithOccurrenceFilteredByTime in interface DatabookStore

Parameters:

vreid - VRE identifier (scope).

timestamp - Do not consider hashtags used before this timestamp.

Returns:

a Map of hashtags associated with their occurrence.

getVREFeedsByHashtag

public List<Feed> getVREFeedsByHashtag(String vreid,
 String hashtag)
                                throws PrivacyLevelTypeNotFoundException,
FeedTypeNotFoundException,
FeedIDNotFoundException,
ColumnNameNotFoundException

Specified by:

getVREFeedsByHashtag in interface DatabookStore

Parameters:

vreid - VRE identifier

hashtag - the hashtag to look for including the '#', it is case sensitive

Returns:

all the feeds having the hashtag passed as parameter

Throws:

PrivacyLevelTypeNotFoundException

FeedTypeNotFoundException - .

FeedIDNotFoundException - .

ColumnNameNotFoundException - .

getVREPostsByHashtag

public List<Post> getVREPostsByHashtag(String vreid,
 String hashtag)
                                throws PrivacyLevelTypeNotFoundException,
FeedTypeNotFoundException,
FeedIDNotFoundException,
ColumnNameNotFoundException

Returns all posts in a VRE that contain a specific hashtag.

Specified by:

getVREPostsByHashtag in interface DatabookStore

Parameters:

vreid - The VRE identifier.

hashtag - The hashtag to search for (including the '#'). Case-sensitive.

Returns:

A List of posts containing the specified hashtag.

Throws:

PrivacyLevelTypeNotFoundException - If a privacy level is not recognized.

FeedTypeNotFoundException - If a feed type is not recognized.

FeedIDNotFoundException - If a feed ID is not found.

ColumnNameNotFoundException - If a column name is not found.

isExistingInvite

public String isExistingInvite(String vreid,
 String email)

Specified by:

isExistingInvite in interface DatabookStore

Parameters:

vreid - the environment where you want to check the invite

email - the email of the invite to check in the environmnet

Returns:

the InviteId if present, null otherwise

saveInvite

public InviteOperationResult saveInvite(Invite invite)
                                 throws jakarta.mail.internet.AddressException

Save the invite for a given email into a given vre

Specified by:

saveInvite in interface DatabookStore

Parameters:

invite - the invite object instanc to save

Returns:

InviteOperationResult SUCCESS, FAILED or ALREADY_INVITED (if an invite is sent to en existing email in the same environment more than once)

Throws:

jakarta.mail.internet.AddressException

readInvite

public Invite readInvite(String inviteid)
                  throws InviteIDNotFoundException,
InviteStatusNotFoundException

read an invite from a given id

Specified by:

readInvite in interface DatabookStore

Throws:

InviteIDNotFoundException

InviteStatusNotFoundException

setInviteStatus

public boolean setInviteStatus(String vreid,
 String email,
 InviteStatus status)
                        throws InviteIDNotFoundException,
InviteStatusNotFoundException

set the status of an invite, see InviteStatus

Specified by:

setInviteStatus in interface DatabookStore

Throws:

InviteStatusNotFoundException

InviteIDNotFoundException

getInvitedEmailsByVRE

public List<Invite> getInvitedEmailsByVRE(String vreid,
 InviteStatus... status)
                                   throws InviteIDNotFoundException,
InviteStatusNotFoundException

Use to get the list of invites per VRE

Specified by:

getInvitedEmailsByVRE in interface DatabookStore

Parameters:

vreid - the vre id

status - optional, if you want to restict on the status, e.g. all pending invites

Returns:

return the list of invites

Throws:

InviteIDNotFoundException

InviteStatusNotFoundException

getAttachmentsByFeedId

public List<Attachment> getAttachmentsByFeedId(String feedId)
                                        throws FeedIDNotFoundException

Specified by:

getAttachmentsByFeedId in interface DatabookStore

Returns:

the list of attachments of the feed feedId, starting from the second one (first attachment is included in Feed instance already)

Throws:

FeedIDNotFoundException

closeConnection

public void closeConnection()

close the connection to the underlying database

Specified by:

closeConnection in interface DatabookStore

saveAttachmentEntry

public boolean saveAttachmentEntry(String feedId,
 Attachment toSave)

save an attachment

Specified by:

saveAttachmentEntry in interface DatabookStore

getAllVREIds

public List<String> getAllVREIds()

Description copied from interface: DatabookStore

Retrieve all the ids of the vre

Specified by:

getAllVREIds in interface DatabookStore

Returns:

the set of ids of the vre available or empty list in case of errors.