public class ApplicationNotificationsManager extends SocialPortalBridge implements NotificationsManager
applicationProfile, aslSession
Constructor and Description |
---|
ApplicationNotificationsManager(org.gcube.application.framework.core.session.ASLSession session)
Use this constructor if you do not need notifications to point back to your applications
|
ApplicationNotificationsManager(org.gcube.application.framework.core.session.ASLSession session,
String portletClassName)
Use this constructor if you do need notifications to point back to your applications,
make sure you create your application profile on the infrastructure.
|
Modifier and Type | Method and Description |
---|---|
boolean |
notifyAddedItem(String userIdToNotify,
org.gcube.common.homelibrary.home.workspace.WorkspaceItem item,
org.gcube.common.homelibrary.home.workspace.WorkspaceFolder sharedFolder)
use to notify a user he got a workspace item new in some of his workspace shared folder
|
boolean |
notifyCommentOnFavorite(String userIdToNotify,
String feedid,
String commentText)
use to notify a user that someone commented on one of his favorite posts
|
boolean |
notifyCommentReply(String userIdToNotify,
String feedid,
String commentText,
String feedOwnerFullName,
String feedOwnerId)
use to notify a user that commented on a post (Not his) that someone commented too
|
boolean |
notifyDeletedCalendarEvent(String userIdToNotify,
String eventTitle,
String eventType,
Date startDate,
Date endingDate) |
boolean |
notifyDocumentWorkflowFirstStepRequest(String userIdToNotify,
String documentWorkflowId,
String documentName,
String assignedRole)
use to notify a document workflow user that a new Document Workflow was created and he is involved in the first step
and he is requested to do a task
|
boolean |
notifyDocumentWorkflowStepForwardComplete(String userIdToNotify,
String documentWorkflowId,
String documentName,
String fromStepName,
String toStepName)
use to notify a document workflow owner that someone forwarded and the workflow moved to another step a document worflow he created
|
boolean |
notifyDocumentWorkflowTaskRequest(String userIdToNotify,
String documentWorkflowId,
String documentName,
String assignedRoleName)
use to notify a document workflow user (user that in the same document workflow)
that he is requested to do a task
|
boolean |
notifyDocumentWorkflowUpdate(String userIdToNotify,
String documentWorkflowId,
String documentName)
use to notify a document workflow owner that someone
has updated a document involved in a worflow he created
|
boolean |
notifyDocumentWorkflowUserForward(String userIdToNotify,
String documentWorkflowId,
String documentName,
String fromStepName,
String toStepName)
use to notify a document workflow owner that a user performed a forward action to another step a document worflow he created
|
boolean |
notifyDocumentWorkflowView(String userIdToNotify,
String documentWorkflowId,
String documentName)
use to notify a document workflow owner that someone
has viewed a document involved in a worflow he created
|
boolean |
notifyEditedCalendarEvent(String userIdToNotify,
String eventTitle,
String eventType,
Date startDate,
Date endingDate) |
boolean |
notifyFolderAddedUser(String userIdToNotify,
org.gcube.common.homelibrary.home.workspace.WorkspaceFolder sharedFolder,
String newAddedUserId)
use to notify a user that a new user was added in on of his workspace shared folder
|
boolean |
notifyFolderAddedUsers(String userIdToNotify,
org.gcube.common.homelibrary.home.workspace.WorkspaceFolder sharedFolder,
List<String> newAddedUserIds)
use to notify a user that a new user was added in on of his workspace shared folder
|
boolean |
notifyFolderRemovedUser(String userIdToNotify,
org.gcube.common.homelibrary.home.workspace.WorkspaceFolder sharedFolder)
use to notify a user that an existing user was removed from one of his workspace shared folder
|
boolean |
notifyFolderRenaming(String userIdToNotify,
String previousName,
String newName,
String renamedFolderId)
use to notify a user he got a workspace folder renamed
|
boolean |
notifyFolderSharing(String userIdToNotify,
org.gcube.common.homelibrary.home.workspace.WorkspaceFolder sharedFolder)
use to notify a user he got a workspace folder shared
|
boolean |
notifyItemRenaming(String userIdToNotify,
String previousName,
org.gcube.common.homelibrary.home.workspace.WorkspaceItem renamedItem)
use to notify a user he got a workspace item renamed
|
boolean |
notifyJobStatus(String userIdToNotify,
org.gcube.portal.databook.shared.ApplicationProfile executingJobApId,
org.gcube.portal.databook.shared.RunningJob job)
use to notify a user he got one of his job finished
|
boolean |
notifyLikedFeed(String userIdToNotify,
String feedid,
String feedText)
use to notify a user he got one of his post liked
|
boolean |
notifyMessageReceived(String userIdToNotify,
String subject) |
boolean |
notifyMovedItem(String userIdToNotify,
org.gcube.common.homelibrary.home.workspace.WorkspaceItem item,
org.gcube.common.homelibrary.home.workspace.WorkspaceFolder sharedFolder)
use to notify a user he got a workspace item deleted from one of his workspace shared folder
|
boolean |
notifyNewCalendarEvent(String userIdToNotify,
String eventTitle,
String eventType,
Date startDate,
Date endingDate) |
boolean |
notifyOwnCommentReply(String userIdToNotify,
String feedid,
String feedText)
use to notify a user that someone commented on his post
|
boolean |
notifyPost(String userIdToNotify,
String feedid,
String feedText)
use to notify a user that someone created this post
|
boolean |
notifyRemovedItem(String userIdToNotify,
String itemName,
org.gcube.common.homelibrary.home.workspace.WorkspaceFolder sharedFolder)
use to notify a user he got a workspace item deleted from one of his workspace shared folder
|
boolean |
notifyUpdatedItem(String userIdToNotify,
org.gcube.common.homelibrary.home.workspace.WorkspaceItem item,
org.gcube.common.homelibrary.home.workspace.WorkspaceFolder sharedFolder)
use to notify a user he got a workspace item updated from one of his workspace shared folder
|
boolean |
notifyUserTag(String userIdToNotify,
String feedid,
String feedText)
use to notify a user that he was mentioned (tagged) on a post
|
escapeHtml, getApplicationProfile, getScopeByOrganizationId, getStoreInstance
public ApplicationNotificationsManager(org.gcube.application.framework.core.session.ASLSession session)
aslSession
- the ASLSession instancepublic ApplicationNotificationsManager(org.gcube.application.framework.core.session.ASLSession session, String portletClassName)
aslSession
- the ASLSession instanceportletClassName
- your portlet class name will be used ad unique identifier for your applicationProfilehttp://gcube.wiki.gcube-system.org/gcube/index.php/Social_Networking_Library#Create_Your_Application_Profile
public boolean notifyFolderSharing(String userIdToNotify, org.gcube.common.homelibrary.home.workspace.WorkspaceFolder sharedFolder) throws org.gcube.common.homelibrary.home.exceptions.InternalErrorException
notifyFolderSharing
in interface NotificationsManager
userIdToNotify
- the user you want to notifysharedFolder
- the shared WorkspaceFolder
org.gcube.common.homelibrary.home.exceptions.InternalErrorException
public boolean notifyFolderRenaming(String userIdToNotify, String previousName, String newName, String renamedFolderId) throws org.gcube.common.homelibrary.home.exceptions.InternalErrorException
notifyFolderRenaming
in interface NotificationsManager
userIdToNotify
- the user you want to notifypreviousName
- the previous name of the foldernewName
- the new name of the folderrenamedFolderId
- the folderIdorg.gcube.common.homelibrary.home.exceptions.InternalErrorException
public boolean notifyFolderAddedUser(String userIdToNotify, org.gcube.common.homelibrary.home.workspace.WorkspaceFolder sharedFolder, String newAddedUserId) throws org.gcube.common.homelibrary.home.exceptions.InternalErrorException, org.gcube.vomanagement.usermanagement.exception.UserManagementSystemException, org.gcube.vomanagement.usermanagement.exception.UserRetrievalFault, org.gcube.vomanagement.usermanagement.exception.UserManagementPortalException
notifyFolderAddedUser
in interface NotificationsManager
userIdToNotify
- the user you want to notifysharedFolder
- the shared WorkspaceFolder
newAddedUserId
- the new user that was addedorg.gcube.vomanagement.usermanagement.exception.UserManagementPortalException
org.gcube.vomanagement.usermanagement.exception.UserRetrievalFault
org.gcube.vomanagement.usermanagement.exception.UserManagementSystemException
org.gcube.common.homelibrary.home.exceptions.InternalErrorException
public boolean notifyFolderAddedUsers(String userIdToNotify, org.gcube.common.homelibrary.home.workspace.WorkspaceFolder sharedFolder, List<String> newAddedUserIds) throws org.gcube.common.homelibrary.home.exceptions.InternalErrorException, org.gcube.vomanagement.usermanagement.exception.UserManagementSystemException, org.gcube.vomanagement.usermanagement.exception.UserRetrievalFault, org.gcube.vomanagement.usermanagement.exception.UserManagementPortalException
notifyFolderAddedUsers
in interface NotificationsManager
userIdToNotify
- the user you want to notifysharedFolder
- the shared WorkspaceFolder
newAddedUserIds
- List of new users that were addedorg.gcube.vomanagement.usermanagement.exception.UserManagementPortalException
org.gcube.vomanagement.usermanagement.exception.UserRetrievalFault
org.gcube.vomanagement.usermanagement.exception.UserManagementSystemException
org.gcube.common.homelibrary.home.exceptions.InternalErrorException
public boolean notifyFolderRemovedUser(String userIdToNotify, org.gcube.common.homelibrary.home.workspace.WorkspaceFolder sharedFolder) throws org.gcube.common.homelibrary.home.exceptions.InternalErrorException, org.gcube.vomanagement.usermanagement.exception.UserManagementSystemException, org.gcube.vomanagement.usermanagement.exception.UserRetrievalFault, org.gcube.vomanagement.usermanagement.exception.UserManagementPortalException
notifyFolderRemovedUser
in interface NotificationsManager
userIdToNotify
- the user you want to notifysharedFolder
- the shared WorkspaceFolder
org.gcube.common.homelibrary.home.exceptions.InternalErrorException
org.gcube.vomanagement.usermanagement.exception.UserManagementSystemException
org.gcube.vomanagement.usermanagement.exception.UserRetrievalFault
org.gcube.vomanagement.usermanagement.exception.UserManagementPortalException
public boolean notifyAddedItem(String userIdToNotify, org.gcube.common.homelibrary.home.workspace.WorkspaceItem item, org.gcube.common.homelibrary.home.workspace.WorkspaceFolder sharedFolder) throws org.gcube.common.homelibrary.home.exceptions.InternalErrorException
notifyAddedItem
in interface NotificationsManager
userIdToNotify
- the user you want to notifysharedFolder
- the shared folder WorkspaceFolder
org.gcube.common.homelibrary.home.exceptions.InternalErrorException
public boolean notifyMovedItem(String userIdToNotify, org.gcube.common.homelibrary.home.workspace.WorkspaceItem item, org.gcube.common.homelibrary.home.workspace.WorkspaceFolder sharedFolder) throws org.gcube.common.homelibrary.home.exceptions.InternalErrorException
notifyMovedItem
in interface NotificationsManager
userIdToNotify
- the user you want to notifysharedFolder
- the shared folder WorkspaceFolder
org.gcube.common.homelibrary.home.exceptions.InternalErrorException
public boolean notifyRemovedItem(String userIdToNotify, String itemName, org.gcube.common.homelibrary.home.workspace.WorkspaceFolder sharedFolder) throws org.gcube.common.homelibrary.home.exceptions.InternalErrorException
notifyRemovedItem
in interface NotificationsManager
userIdToNotify
- the user you want to notifysharedFolder
- the shared folder WorkspaceFolder
org.gcube.common.homelibrary.home.exceptions.InternalErrorException
public boolean notifyUpdatedItem(String userIdToNotify, org.gcube.common.homelibrary.home.workspace.WorkspaceItem item, org.gcube.common.homelibrary.home.workspace.WorkspaceFolder sharedFolder) throws org.gcube.common.homelibrary.home.exceptions.InternalErrorException
notifyUpdatedItem
in interface NotificationsManager
userIdToNotify
- the user you want to notifysharedFolder
- the shared folder WorkspaceFolder
org.gcube.common.homelibrary.home.exceptions.InternalErrorException
public boolean notifyItemRenaming(String userIdToNotify, String previousName, org.gcube.common.homelibrary.home.workspace.WorkspaceItem renamedItem) throws org.gcube.common.homelibrary.home.exceptions.InternalErrorException
notifyItemRenaming
in interface NotificationsManager
userIdToNotify
- the user you want to notifypreviousName
- the previous name of the folderrenamedItem
- the renamed WorkspaceItem
org.gcube.common.homelibrary.home.exceptions.InternalErrorException
public boolean notifyMessageReceived(String userIdToNotify, String subject)
notifyMessageReceived
in interface NotificationsManager
userIdToNotify
- the user you want to notifysubject
- the subject of the message sentpublic boolean notifyPost(String userIdToNotify, String feedid, String feedText)
notifyPost
in interface NotificationsManager
userIdToNotify
- the user you want to notifyfeedid
- the liked feedidfeedText
- the liked feed text or a portion of itpublic boolean notifyOwnCommentReply(String userIdToNotify, String feedid, String feedText)
notifyOwnCommentReply
in interface NotificationsManager
userIdToNotify
- the user you want to notifyfeedid
- the liked feedidfeedText
- the liked feed text or a portion of itpublic boolean notifyCommentReply(String userIdToNotify, String feedid, String commentText, String feedOwnerFullName, String feedOwnerId)
notifyCommentReply
in interface NotificationsManager
userIdToNotify
- the user you want to notifyfeedid
- the liked feedidcommentText
- the liked feed text or a portion of itfeedOwnerFullName
- the full name of the user who created this postpublic boolean notifyCommentOnFavorite(String userIdToNotify, String feedid, String commentText)
notifyCommentOnFavorite
in interface NotificationsManager
userIdToNotify
- the user you want to notifyfeedid
- the liked feedidcommentText
- the commentTextpublic boolean notifyUserTag(String userIdToNotify, String feedid, String feedText)
notifyUserTag
in interface NotificationsManager
userIdToNotify
- the user you want to notifyfeedid
- the liked feedidpublic boolean notifyLikedFeed(String userIdToNotify, String feedid, String feedText)
notifyLikedFeed
in interface NotificationsManager
userIdToNotify
- the user you want to notifyfeedid
- the liked feedidfeedText
- the liked feed text or a portion of itpublic boolean notifyJobStatus(String userIdToNotify, org.gcube.portal.databook.shared.ApplicationProfile executingJobApId, org.gcube.portal.databook.shared.RunningJob job)
notifyJobStatus
in interface NotificationsManager
userIdToNotify
- the user you want to notifypublic boolean notifyDocumentWorkflowView(String userIdToNotify, String documentWorkflowId, String documentName)
notifyDocumentWorkflowView
in interface NotificationsManager
userIdToNotify
- the user you want to notifydocumentName
- the document titlepublic boolean notifyDocumentWorkflowUpdate(String userIdToNotify, String documentWorkflowId, String documentName)
notifyDocumentWorkflowUpdate
in interface NotificationsManager
userIdToNotify
- the user you want to notifydocumentName
- the document titlepublic boolean notifyDocumentWorkflowTaskRequest(String userIdToNotify, String documentWorkflowId, String documentName, String assignedRoleName)
notifyDocumentWorkflowTaskRequest
in interface NotificationsManager
userIdToNotify
- the user you want to notifydocumentName
- the document titlepublic boolean notifyDocumentWorkflowUserForward(String userIdToNotify, String documentWorkflowId, String documentName, String fromStepName, String toStepName)
notifyDocumentWorkflowUserForward
in interface NotificationsManager
userIdToNotify
- the owner of this document workflowfromStepName
- the name of the step from which the user performed the forwardtoStepName
- the name of the step to which the user performed the forwardpublic boolean notifyDocumentWorkflowStepForwardComplete(String userIdToNotify, String documentWorkflowId, String documentName, String fromStepName, String toStepName)
notifyDocumentWorkflowStepForwardComplete
in interface NotificationsManager
userIdToNotify
- the owner of this document workflowfromStepName
- the name of the step from which the user performed the forwardtoStepName
- the name of the step to which the user performed the forwardpublic boolean notifyDocumentWorkflowFirstStepRequest(String userIdToNotify, String documentWorkflowId, String documentName, String assignedRole)
notifyDocumentWorkflowFirstStepRequest
in interface NotificationsManager
userIdToNotify
- the user you want to notifydocumentName
- the document titlepublic boolean notifyNewCalendarEvent(String userIdToNotify, String eventTitle, String eventType, Date startDate, Date endingDate)
notifyNewCalendarEvent
in interface NotificationsManager
userIdToNotify
- the user you want to notifyeventTitle
- the title of the eventeventType
- the type of the eventstartDate
- staring dateendingDate
- ending datepublic boolean notifyEditedCalendarEvent(String userIdToNotify, String eventTitle, String eventType, Date startDate, Date endingDate)
notifyEditedCalendarEvent
in interface NotificationsManager
userIdToNotify
- the user you want to notifyeventTitle
- the title of the eventeventType
- the type of the eventstartDate
- staring dateendingDate
- ending datepublic boolean notifyDeletedCalendarEvent(String userIdToNotify, String eventTitle, String eventType, Date startDate, Date endingDate)
notifyDeletedCalendarEvent
in interface NotificationsManager
userIdToNotify
- the user you want to notifyeventTitle
- the title of the eventeventType
- the type of the eventstartDate
- staring dateendingDate
- ending dateCopyright © 2014. All Rights Reserved.