430 lines
18 KiB
Java
430 lines
18 KiB
Java
package org.gcube.portal.databook.server;
|
|
|
|
import java.util.List;
|
|
import java.util.Map;
|
|
|
|
import javax.mail.internet.AddressException;
|
|
|
|
import org.gcube.portal.databook.shared.Attachment;
|
|
import org.gcube.portal.databook.shared.Comment;
|
|
import org.gcube.portal.databook.shared.Invite;
|
|
import org.gcube.portal.databook.shared.InviteOperationResult;
|
|
import org.gcube.portal.databook.shared.InviteStatus;
|
|
import org.gcube.portal.databook.shared.Like;
|
|
import org.gcube.portal.databook.shared.Notification;
|
|
import org.gcube.portal.databook.shared.NotificationChannelType;
|
|
import org.gcube.portal.databook.shared.NotificationType;
|
|
import org.gcube.portal.databook.shared.Post;
|
|
import org.gcube.portal.databook.shared.RangePosts;
|
|
import org.gcube.portal.databook.shared.ex.*;
|
|
|
|
|
|
/**
|
|
* @author Massimiliano Assante ISTI-CNR
|
|
* @author Costantino Perciante ISTI-CNR
|
|
* <class>DatabookStore</class> is the high level interface for querying and adding data to DatabookStore
|
|
*/
|
|
public interface DatabookStore {
|
|
/**
|
|
* save a Post instance in the store
|
|
* @return true if everything went fine
|
|
*/
|
|
boolean saveUserPost(Post feed);
|
|
/**
|
|
* 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
|
|
*
|
|
* @param attachments a list of attachments starting from the second
|
|
* @return true if everything went fine
|
|
*/
|
|
boolean saveUserPost(Post post, List<Attachment> attachments);
|
|
/**
|
|
* delete a Feed from the store
|
|
* @return true if everything went fine
|
|
*/
|
|
boolean deletePost(String postid) throws PrivacyLevelTypeNotFoundException, ColumnNameNotFoundException;
|
|
/**
|
|
* save a post in the VRES TimeLine in the store
|
|
* @param postKey the post id
|
|
* @param vreid vre identifier
|
|
*/
|
|
boolean savePostToVRETimeline(String postKey, String vreid) throws PostIDNotFoundException;
|
|
|
|
/**
|
|
* save a Post instance in the store
|
|
* @return true if everything went fine
|
|
*/
|
|
boolean saveAppPost(Post feed);
|
|
|
|
/**
|
|
* Save a Post instance in the store
|
|
* Use this if your app needs to attach more than one file to the post
|
|
*
|
|
* @param attachments a list of attachments starting from the second
|
|
* @return true if everything went fine
|
|
*/
|
|
boolean saveAppPost(Post feed, List<Attachment> attachments);
|
|
|
|
/**
|
|
* read a feed from a given id
|
|
* @throws PrivacyLevelTypeNotFoundException
|
|
* @throws ColumnNameNotFoundException
|
|
*/
|
|
Post readPost(String postid) throws PrivacyLevelTypeNotFoundException, ColumnNameNotFoundException, PostTypeNotFoundException, PostIDNotFoundException;
|
|
/**
|
|
* @param userid user identifier
|
|
* return all the feeds belonging to the userid
|
|
* @throws PrivacyLevelTypeNotFoundException
|
|
* @throws ColumnNameNotFoundException
|
|
*/
|
|
List<Post> getAllPostsByUser(String userid) throws PrivacyLevelTypeNotFoundException, ColumnNameNotFoundException;
|
|
/**
|
|
* @param appid application identifier
|
|
* return all the feeds belonging to the appid
|
|
* @throws PrivacyLevelTypeNotFoundException
|
|
* @throws ColumnNameNotFoundException
|
|
*/
|
|
List<Post> getAllPostsByApp(String appid) throws PrivacyLevelTypeNotFoundException, ColumnNameNotFoundException;
|
|
/**
|
|
* @param userid the user identifier like andrea.rossi
|
|
* @param timeInMillis the initial time in millis to be considered
|
|
* @return a list of feeds commented by userid starting from timeInMillis
|
|
* @throws Exception
|
|
*/
|
|
List<Post> getRecentCommentedPostsByUserAndDate(String userid, long timeInMillis) throws Exception;
|
|
/**
|
|
* return all the feeds whose Level is PORTAL
|
|
* @throws PrivacyLevelTypeNotFoundException
|
|
* @throws ColumnNameNotFoundException
|
|
* @throws PrivacyLevelTypeNotFoundException
|
|
*/
|
|
List<Post> getAllPortalPrivacyLevelPosts() throws ColumnNameNotFoundException, PrivacyLevelTypeNotFoundException, PostTypeNotFoundException;
|
|
|
|
/**
|
|
* return the most recent feeds for this user up to quantity param
|
|
* @param userid user identifier
|
|
* @param quantity the number of most recent feeds for this user
|
|
* @return a <class>List</class> of most recent feeds for this user
|
|
* @throws PrivacyLevelTypeNotFoundException
|
|
* @throws ColumnNameNotFoundException
|
|
*/
|
|
List<Post> getRecentPostsByUser(String userid, int quantity) throws PrivacyLevelTypeNotFoundException, ColumnNameNotFoundException;
|
|
|
|
/**
|
|
* @param vreid vre identifier
|
|
* return all the feeds belonging to the userid
|
|
* @throws PrivacyLevelTypeNotFoundException
|
|
* @throws ColumnNameNotFoundException
|
|
*/
|
|
List<Post> getAllPostsByVRE(String vreid) throws PrivacyLevelTypeNotFoundException, ColumnNameNotFoundException;
|
|
|
|
/**
|
|
* return the most recent posts for this vre up to quantity param
|
|
* @param vreid VRES identifier
|
|
* @param quantity the number of most recent posts for this vre
|
|
* @return a <class>List</class> of most recent posts for this vre
|
|
* @throws PrivacyLevelTypeNotFoundException
|
|
* @throws ColumnNameNotFoundException
|
|
*/
|
|
List<Post> getRecentPostsByVRE(String vreid, int quantity) throws IllegalArgumentException, PrivacyLevelTypeNotFoundException, ColumnNameNotFoundException;
|
|
|
|
/**
|
|
* return the most recent posts for this vre up to quantity param and the last index of the posts in the timeline
|
|
* lastReturnedPostTimelineIndex is useful to know from where to start the range the next time you ask, because there are deletions
|
|
*
|
|
* @param vreid VRES identifier
|
|
* @param from the range start (most recent feeds for this vre) has to be greater than 0
|
|
* @param quantity the number of most recent feeds for this vre starting from "from" param
|
|
* @return a <class>RangePosts</class> containing of most recent feeds for this vre
|
|
* @throws PrivacyLevelTypeNotFoundException
|
|
* @throws ColumnNameNotFoundException
|
|
*/
|
|
RangePosts getRecentPostsByVREAndRange(String vreid, int from, int quantity) throws PrivacyLevelTypeNotFoundException, ColumnNameNotFoundException;
|
|
|
|
/**
|
|
* @param userid user identifier
|
|
* @param timeInMillis time in milliseconds from which you want to start retrieve the feeds
|
|
* @return the number of feeds in the range from: today to: timeInMillis
|
|
*/
|
|
List<Post> getRecentPostsByUserAndDate(String userid, long timeInMillis) throws IllegalArgumentException;
|
|
/**
|
|
* save a Notification instance in the store
|
|
* @return true if everything went fine
|
|
*/
|
|
boolean saveNotification(Notification notification);
|
|
/**
|
|
* set an existing Notification instance in the to read
|
|
* @return true if everything went fine
|
|
*/
|
|
boolean setNotificationRead(String notificationidToSet) throws NotificationIDNotFoundException, NotificationTypeNotFoundException, ColumnNameNotFoundException;
|
|
/**
|
|
* read a notification from a given id
|
|
* @throws {@link ColumnNameNotFoundException}
|
|
* @throws {@link NotificationIDNotFoundException}
|
|
* @throws {@link NotificationTypeNotFoundException}
|
|
*/
|
|
Notification readNotification(String notificationid) throws NotificationIDNotFoundException, NotificationTypeNotFoundException, ColumnNameNotFoundException;
|
|
|
|
/**
|
|
* @param userid user identifier
|
|
* @param 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
|
|
* @throws ColumnNameNotFoundException
|
|
*/
|
|
List<Notification> getAllNotificationByUser(String userid, int limit) throws NotificationTypeNotFoundException, ColumnNameNotFoundException, NotificationIDNotFoundException;
|
|
/**
|
|
*
|
|
* @param userid user identifier
|
|
* @param from the range start has to be greater than 0
|
|
* @param quantity the number of most recent notifications for this user starting from "from" param
|
|
* @return all the notifications for the userid in the range requested
|
|
* @throws NotificationTypeNotFoundException
|
|
* @throws ColumnNameNotFoundException
|
|
* @throws NotificationIDNotFoundException
|
|
*/
|
|
List<Notification> getRangeNotificationsByUser(String userid, int from, int quantity) throws NotificationTypeNotFoundException, ColumnNameNotFoundException, NotificationIDNotFoundException;
|
|
/**
|
|
* This is a fast way to set all notification to read quickly
|
|
* @param userid
|
|
* @return true if everything went fine
|
|
* @throws {@link ColumnNameNotFoundException}
|
|
* @throws {@link NotificationIDNotFoundException}
|
|
* @throws {@link NotificationTypeNotFoundException}
|
|
*/
|
|
boolean setAllNotificationReadByUser(String userid) throws NotificationIDNotFoundException, NotificationTypeNotFoundException, ColumnNameNotFoundException;
|
|
/**
|
|
* return the not yet read notifications (not including messages)
|
|
* @param userid user identifier
|
|
* @return a <class>List</class> of not yet read notifications for this user
|
|
* @throws NotificationTypeNotFoundException
|
|
* @throws ColumnNameNotFoundException
|
|
*/
|
|
List<Notification> getUnreadNotificationsByUser(String userid) throws NotificationTypeNotFoundException, ColumnNameNotFoundException, NotificationIDNotFoundException;
|
|
/**
|
|
*
|
|
* @param userid user identifier
|
|
* @throws ColumnNameNotFoundException
|
|
* @throws NotificationTypeNotFoundException
|
|
* @throws NotificationIDNotFoundException
|
|
* @return true if there are unread notifications (not including messages), false if they are all read
|
|
*/
|
|
boolean checkUnreadNotifications(String userid) throws NotificationIDNotFoundException, NotificationTypeNotFoundException, ColumnNameNotFoundException;
|
|
/**
|
|
*
|
|
* @param userid user identifier
|
|
* @throws ColumnNameNotFoundException
|
|
* @throws NotificationTypeNotFoundException self explaining
|
|
* @throws NotificationChannelTypeNotFoundException self explaining
|
|
* @throws NotificationIDNotFoundException
|
|
* @return true if there are unread messages notifications (including messages), false if they are all read
|
|
*/
|
|
boolean checkUnreadMessagesNotifications(String userid) throws NotificationIDNotFoundException, NotificationTypeNotFoundException, ColumnNameNotFoundException;
|
|
|
|
/**
|
|
* return the channels a user chose for being notified for a given notification type
|
|
* @param userid user identifier
|
|
* @param notificationType the type of the notification
|
|
* @return a list of <class>NotificationChannelType</class> that represents the channels this user wants to be notified
|
|
*/
|
|
List<NotificationChannelType> getUserNotificationChannels(String userid, NotificationType notificationType) throws NotificationChannelTypeNotFoundException, NotificationTypeNotFoundException;
|
|
/**
|
|
* set the notification preferences map (enable or disable the channels to be used for notifying the user)
|
|
* @param userid user identifier
|
|
* @param 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
|
|
* @return true if everything was fine
|
|
*/
|
|
boolean setUserNotificationPreferences(String userid, Map<NotificationType, NotificationChannelType[]> enabledChannels);
|
|
/**
|
|
* get the notification preferences map (enableor disable the channels to be used for notifying the user)
|
|
* @param userid user identifier
|
|
* @return the map
|
|
* @throws NotificationTypeNotFoundException self explaining
|
|
* @throws NotificationChannelTypeNotFoundException self explaining
|
|
*/
|
|
Map<NotificationType, NotificationChannelType[]> getUserNotificationPreferences(String userid) throws NotificationTypeNotFoundException, NotificationChannelTypeNotFoundException;
|
|
|
|
/**
|
|
* @param commentId comment unique identifier
|
|
* @return the comment belonging to the commentId
|
|
* @throws CommentIDNotFoundException
|
|
*/
|
|
Comment readCommentById(String commentId) throws CommentIDNotFoundException;
|
|
/**
|
|
* add a comment to a feed
|
|
* @param comment the Comment instance to add
|
|
*/
|
|
boolean addComment(Comment comment);
|
|
/**
|
|
* @param postid the post identifier
|
|
* return all the comments belonging to the postid
|
|
*/
|
|
List<Comment> getAllCommentByPost(String postid);
|
|
/**
|
|
* @param userid user identifier
|
|
* @param timeInMillis time in milliseconds from which you want to start retrieve the feeds
|
|
* @return a list of comments (sorted starting from the most recent one) made by the user since timeInMillis up to now
|
|
*/
|
|
List<Comment> getRecentCommentsByUserAndDate(String userid, long timeInMillis) throws Exception;
|
|
/**
|
|
* edit a comment
|
|
* @param comment the comment to edit
|
|
* @return true if success, false otherwise
|
|
*/
|
|
boolean editComment(Comment comment) throws PrivacyLevelTypeNotFoundException, ColumnNameNotFoundException, CommentIDNotFoundException;
|
|
/**
|
|
* deletes a comment
|
|
* @param commentid the comment identifier to delete
|
|
* @param feedid the feedid to which the comment is associated
|
|
* @return true if success, false otherwise
|
|
*/
|
|
boolean deleteComment(String commentid, String feedid) throws PrivacyLevelTypeNotFoundException, ColumnNameNotFoundException, CommentIDNotFoundException;
|
|
/**
|
|
* add a like to a feed
|
|
* @param like instance
|
|
*/
|
|
boolean like(Like like);
|
|
/**
|
|
* unlike a feed
|
|
* @param userid user identifier
|
|
* @param likeid the like identifier to delete
|
|
* @param feedid the feedid to which the comment is associated
|
|
* @return true if success, false otherwise
|
|
*/
|
|
boolean unlike(String userid, String likeid, String feedid) throws PrivacyLevelTypeNotFoundException, ColumnNameNotFoundException, LikeIDNotFoundException;
|
|
/**
|
|
* @param userid user identifier
|
|
* return all the feedids a user has liked
|
|
*/
|
|
List<String> getAllLikedPostIdsByUser(String userid);
|
|
|
|
/**
|
|
* @param userid user identifier
|
|
* @param limit set 0 to get everything, an int to get the most recent -limit- liked posts
|
|
* @throws ColumnNameNotFoundException .
|
|
* @throws PrivacyLevelTypeNotFoundException
|
|
* return all the feeds a user has liked
|
|
*/
|
|
List<Post> getAllLikedPostsByUser(String userid, int limit) throws PrivacyLevelTypeNotFoundException, ColumnNameNotFoundException;
|
|
|
|
/**
|
|
* @param userid user identifier
|
|
* @param timeInMillis time in milliseconds from which you want to start retrieve the feeds
|
|
* @return the likes made to feeds in the range from: today to: timeInMillis
|
|
*/
|
|
List<Post> getRecentLikedPostsByUserAndDate(String userid, long timeInMillis) throws IllegalArgumentException;
|
|
|
|
/**
|
|
* @param postid postid identifier
|
|
* return all the likes belonging to the postid
|
|
*/
|
|
List<Like> getAllLikesByPost(String postid);
|
|
/**
|
|
*
|
|
* @param hashtags the hashtag including the '#'
|
|
* @param postid the postid to which the hashtag is associated
|
|
* @param vreid VRE identifier
|
|
* @return true if success, false otherwise
|
|
*/
|
|
boolean saveHashTags(String postid, String vreid, List<String> hashtags);
|
|
/**
|
|
*
|
|
* @param hashtags the hashtag including the '#'
|
|
* @param commentId the commentId to which the hashtag is associated
|
|
* @param vreid VRE identifier
|
|
* @return true if success, false otherwise
|
|
* @throws CommentIDNotFoundException
|
|
*/
|
|
boolean saveHashTagsComment(String commentId, String vreid, List<String> hashtags) throws CommentIDNotFoundException;
|
|
/**
|
|
*
|
|
* @param hashtags the hashtag including the '#'
|
|
* @param postid the postid to which the hashtag is associated
|
|
* @param vreid VRE identifier
|
|
* @return true if success, false otherwise
|
|
*/
|
|
boolean deleteHashTags(String postid, String vreid, List<String> hashtags) ;
|
|
/**
|
|
*
|
|
* @param hashtags the hashtag including the '#'
|
|
* @param commentId the commentId to which the hashtag is associated
|
|
* @param vreid VRE identifier
|
|
* @return true if success, false otherwise
|
|
* @throws CommentIDNotFoundException
|
|
*/
|
|
boolean deleteHashTagsComment(String commentId, String vreid, List<String> hashtags) throws CommentIDNotFoundException;
|
|
/**
|
|
* get a map of vre hashtags where the key is the hashtag and the value is the occurrence of the hashtag in the VRE
|
|
* @param vreid vre identifier (scope)
|
|
* @return a HashMap<String, Integer> of vre Hashtags associated with their occurrence
|
|
*/
|
|
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
|
|
* @param vreid vre identifier (scope)
|
|
* @param timestamp do not consider hashtags used before timestamp
|
|
* @return a HashMap<String, Integer> of vre Hashtags associated with their occurrence
|
|
*/
|
|
Map<String, Integer> getVREHashtagsWithOccurrenceFilteredByTime(String vreid, long timestamp);
|
|
/**
|
|
*
|
|
* @param vreid VRE identifier
|
|
* @param hashtag the hashtag to look for including the '#', it is case sensitive
|
|
* @throws ColumnNameNotFoundException .
|
|
* @throws PrivacyLevelTypeNotFoundException
|
|
* @return all the feeds having the hashtag passed as parameter
|
|
*/
|
|
List<Post> getVREPostsByHashtag(String vreid, String hashtag) throws PrivacyLevelTypeNotFoundException, ColumnNameNotFoundException;
|
|
|
|
/**
|
|
* Save the invite for a given email into a given vre
|
|
* @param invite the invite object instanc to save
|
|
* @return {@link InviteOperationResult} SUCCESS, FAILED or ALREADY_INVITED (if an invite is sent to en existing email in the same environment more than once)
|
|
*/
|
|
InviteOperationResult saveInvite(Invite invite) throws AddressException;
|
|
/**
|
|
*
|
|
* @param vreid the environment where you want to check the invite
|
|
* @param email the email of the invite to check in the environmnet
|
|
* @return the InviteId if present, null otherwise
|
|
*/
|
|
String isExistingInvite(String vreid, String email);
|
|
/**
|
|
* read an invite from a given id
|
|
* @throws InviteIDNotFoundException
|
|
* @throws InviteStatusNotFoundException
|
|
*/
|
|
Invite readInvite(String inviteid) throws InviteIDNotFoundException, InviteStatusNotFoundException;
|
|
/**
|
|
* set the status of an invite, see {@link InviteStatus}
|
|
* @throws InviteIDNotFoundException
|
|
*/
|
|
boolean setInviteStatus(String vreid, String email, InviteStatus status) throws InviteIDNotFoundException, InviteStatusNotFoundException;
|
|
/**
|
|
* Use to get the list of invites per VRE
|
|
* @param vreid the vre id
|
|
* @param status optional, if you want to restict on the status, e.g. all pending invites
|
|
* @return return the list of invites
|
|
* @throws InviteIDNotFoundException
|
|
* @throws InviteStatusNotFoundException
|
|
*/
|
|
List<Invite> getInvitedEmailsByVRE(String vreid, InviteStatus... status) throws InviteIDNotFoundException, InviteStatusNotFoundException;
|
|
/**
|
|
*
|
|
* @param feedId
|
|
* @return the list of attachments of the feed feedId, starting from the second one (first attachment is included in Feed instance already)
|
|
*/
|
|
List<Attachment> getAttachmentsByFeedId(String feedId);
|
|
|
|
/**
|
|
* Retrieve all the ids of the vre
|
|
* @return the set of ids of the vre available or empty list in case of errors.
|
|
*/
|
|
public List<String> getAllVREIds();
|
|
|
|
/**
|
|
* close the connection to the underlying database
|
|
*/
|
|
void closeConnection();
|
|
}
|