public class ApplicationNotificationsManager extends SocialPortalBridge implements NotificationsManager
applicationProfile, currGroupName, currScope, currUser| Constructor and Description |
|---|
ApplicationNotificationsManager(SocialNetworkingSite site,
String scope,
SocialNetworkingUser currUser)
Use this constructor if you do not need notifications to point back to your applications
|
ApplicationNotificationsManager(SocialNetworkingSite site,
String scope,
SocialNetworkingUser currUser,
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.WorkspaceSharedFolder sharedFolder)
use to notify a user he got a workspace item new in some of his workspace shared folder
|
boolean |
notifyAdministratorDowngrade(String userIdToNotify,
org.gcube.common.homelibrary.home.workspace.WorkspaceSharedFolder sharedFolder)
use to notify a user he got downgraded from Administrator of a folder shared
|
boolean |
notifyAdministratorUpgrade(String userIdToNotify,
org.gcube.common.homelibrary.home.workspace.WorkspaceSharedFolder sharedFolder)
use to notify a user he got upgraded to Administrator of a folder shared
|
boolean |
notifyCommentOnFavorite(String userIdToNotify,
String feedid,
String commentText,
String commentKey)
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,
String commentKey)
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.WorkspaceSharedFolder 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.WorkspaceSharedFolder 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.WorkspaceSharedFolder 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.WorkspaceSharedFolder sharedFolder)
use to notify a user he got a workspace folder shared
|
boolean |
notifyFolderUnsharing(String userIdToNotify,
String unsharedFolderId,
String unsharedFolderName)
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,
org.gcube.common.homelibrary.home.workspace.WorkspaceSharedFolder rootSharedFolder)
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 messageId,
String subject,
String messageText,
String... otherRecipientsFullNames) |
boolean |
notifyMovedItem(String userIdToNotify,
org.gcube.common.homelibrary.home.workspace.WorkspaceItem item,
org.gcube.common.homelibrary.home.workspace.WorkspaceSharedFolder 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,
String commentKey)
use to notify a user that someone commented on his post
|
boolean |
notifyPost(String userIdToNotify,
String feedid,
String feedText,
String... hashtags)
use to notify a user that someone created this post
|
boolean |
notifyRemovedItem(String userIdToNotify,
String itemName,
org.gcube.common.homelibrary.home.workspace.WorkspaceSharedFolder sharedFolder)
use to notify a user he got a workspace item deleted from one of his workspace shared folder
|
boolean |
notifyTDMObjectSharing(String userIdToNotify,
org.gcube.portal.databook.shared.NotificationType type,
String tdmObjectName,
String encodedTabularResourceParams)
use to notify a user he got a Tabular Data Resource shared
|
boolean |
notifyTDMTabularResourceSharing(String userIdToNotify,
String tabularResourceName,
String encodedTabularResourceParams)
use to notify a user he got a Tabular Data Resource shared
|
boolean |
notifyUpdatedItem(String userIdToNotify,
org.gcube.common.homelibrary.home.workspace.WorkspaceItem item,
org.gcube.common.homelibrary.home.workspace.WorkspaceSharedFolder 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,
String commentKey)
use to notify a user that he was mentioned (tagged) on a post
|
escapeHtml, getApplicationProfile, getScopeByVREId, getStoreInstancepublic ApplicationNotificationsManager(SocialNetworkingSite site, String scope, SocialNetworkingUser currUser)
scope - the current scopecurrUser - an instance of SocialNetworkingUser filled with the required user datasite - an instance of SocialNetworkingSite filled with the required datapublic ApplicationNotificationsManager(SocialNetworkingSite site, String scope, SocialNetworkingUser currUser, String portletClassName)
scope - the current scopecurrUser - an instance of SocialNetworkingUser filled with the required user datasite - an instance of SocialNetworkingSite filled with the required dataportletClassName - your portlet class name will be used ad unique identifier for your applicationProfilehttp://wiki.gcube-system.org/gcube/index.php/Social_Networking_Library#Create_Your_Application_Profilepublic boolean notifyFolderSharing(String userIdToNotify, org.gcube.common.homelibrary.home.workspace.WorkspaceSharedFolder sharedFolder) throws org.gcube.common.homelibrary.home.exceptions.InternalErrorException
notifyFolderSharing in interface NotificationsManageruserIdToNotify - the user you want to notifysharedFolder - the shared WorkspaceSharedFolderorg.gcube.common.homelibrary.home.exceptions.InternalErrorExceptionpublic boolean notifyFolderUnsharing(String userIdToNotify, String unsharedFolderId, String unsharedFolderName) throws Exception
notifyFolderUnsharing in interface NotificationsManageruserIdToNotify - the user you want to notifyunsharedFolderId - the unshared folder idunsharedFolderName - the unshared folder nameExceptionpublic boolean notifyAdministratorUpgrade(String userIdToNotify, org.gcube.common.homelibrary.home.workspace.WorkspaceSharedFolder sharedFolder) throws Exception
notifyAdministratorUpgrade in interface NotificationsManageruserIdToNotify - the user you want to notifysharedFolder - the shared WorkspaceSharedFolderExceptionpublic boolean notifyAdministratorDowngrade(String userIdToNotify, org.gcube.common.homelibrary.home.workspace.WorkspaceSharedFolder sharedFolder) throws Exception
notifyAdministratorDowngrade in interface NotificationsManageruserIdToNotify - the user you want to notifysharedFolder - the shared WorkspaceSharedFolderExceptionpublic boolean notifyFolderRenaming(String userIdToNotify, String previousName, String newName, String renamedFolderId) throws org.gcube.common.homelibrary.home.exceptions.InternalErrorException
notifyFolderRenaming in interface NotificationsManageruserIdToNotify - 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.InternalErrorExceptionpublic boolean notifyFolderAddedUser(String userIdToNotify, org.gcube.common.homelibrary.home.workspace.WorkspaceSharedFolder 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 NotificationsManageruserIdToNotify - the user you want to notifysharedFolder - the shared WorkspaceSharedFoldernewAddedUserId - the new user that was addedorg.gcube.vomanagement.usermanagement.exception.UserManagementPortalExceptionorg.gcube.vomanagement.usermanagement.exception.UserRetrievalFaultorg.gcube.vomanagement.usermanagement.exception.UserManagementSystemExceptionorg.gcube.common.homelibrary.home.exceptions.InternalErrorExceptionpublic boolean notifyFolderAddedUsers(String userIdToNotify, org.gcube.common.homelibrary.home.workspace.WorkspaceSharedFolder 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 NotificationsManageruserIdToNotify - the user you want to notifysharedFolder - the shared WorkspaceSharedFoldernewAddedUserIds - List of new users that were addedorg.gcube.vomanagement.usermanagement.exception.UserManagementPortalExceptionorg.gcube.vomanagement.usermanagement.exception.UserRetrievalFaultorg.gcube.vomanagement.usermanagement.exception.UserManagementSystemExceptionorg.gcube.common.homelibrary.home.exceptions.InternalErrorExceptionpublic boolean notifyFolderRemovedUser(String userIdToNotify, org.gcube.common.homelibrary.home.workspace.WorkspaceSharedFolder 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 NotificationsManageruserIdToNotify - the user you want to notifysharedFolder - the shared WorkspaceSharedFolderorg.gcube.common.homelibrary.home.exceptions.InternalErrorExceptionorg.gcube.vomanagement.usermanagement.exception.UserManagementSystemExceptionorg.gcube.vomanagement.usermanagement.exception.UserRetrievalFaultorg.gcube.vomanagement.usermanagement.exception.UserManagementPortalExceptionpublic boolean notifyAddedItem(String userIdToNotify, org.gcube.common.homelibrary.home.workspace.WorkspaceItem item, org.gcube.common.homelibrary.home.workspace.WorkspaceSharedFolder sharedFolder) throws org.gcube.common.homelibrary.home.exceptions.InternalErrorException
notifyAddedItem in interface NotificationsManageruserIdToNotify - the user you want to notifysharedFolder - the shared folder WorkspaceSharedFolderorg.gcube.common.homelibrary.home.exceptions.InternalErrorExceptionpublic boolean notifyMovedItem(String userIdToNotify, org.gcube.common.homelibrary.home.workspace.WorkspaceItem item, org.gcube.common.homelibrary.home.workspace.WorkspaceSharedFolder sharedFolder) throws org.gcube.common.homelibrary.home.exceptions.InternalErrorException
notifyMovedItem in interface NotificationsManageruserIdToNotify - the user you want to notifysharedFolder - the shared folder WorkspaceSharedFolderorg.gcube.common.homelibrary.home.exceptions.InternalErrorExceptionpublic boolean notifyRemovedItem(String userIdToNotify, String itemName, org.gcube.common.homelibrary.home.workspace.WorkspaceSharedFolder sharedFolder) throws org.gcube.common.homelibrary.home.exceptions.InternalErrorException
notifyRemovedItem in interface NotificationsManageruserIdToNotify - the user you want to notifysharedFolder - the shared folder WorkspaceSharedFolderorg.gcube.common.homelibrary.home.exceptions.InternalErrorExceptionpublic boolean notifyUpdatedItem(String userIdToNotify, org.gcube.common.homelibrary.home.workspace.WorkspaceItem item, org.gcube.common.homelibrary.home.workspace.WorkspaceSharedFolder sharedFolder) throws org.gcube.common.homelibrary.home.exceptions.InternalErrorException
notifyUpdatedItem in interface NotificationsManageruserIdToNotify - the user you want to notifysharedFolder - the shared folder WorkspaceFolderorg.gcube.common.homelibrary.home.exceptions.InternalErrorExceptionpublic boolean notifyItemRenaming(String userIdToNotify, String previousName, org.gcube.common.homelibrary.home.workspace.WorkspaceItem renamedItem, org.gcube.common.homelibrary.home.workspace.WorkspaceSharedFolder rootSharedFolder) throws org.gcube.common.homelibrary.home.exceptions.InternalErrorException
notifyItemRenaming in interface NotificationsManageruserIdToNotify - the user you want to notifypreviousName - the previous name of the folderrenamedItem - the renamed WorkspaceItemrootSharedFolder - the root shared WorkspaceSharedFolder of the WorkspaceItemorg.gcube.common.homelibrary.home.exceptions.InternalErrorExceptionpublic boolean notifyMessageReceived(String userIdToNotify, String messageId, String subject, String messageText, String... otherRecipientsFullNames)
notifyMessageReceived in interface NotificationsManageruserIdToNotify - the user you want to notifymessageId - the unique identifier of the messagesubject - the subject of the message sentmessageText - the text of the message (text/plain)otherRecipientsFullNames - the Full Names of the other recipients. if anypublic boolean notifyPost(String userIdToNotify, String feedid, String feedText, String... hashtags)
notifyPost in interface NotificationsManageruserIdToNotify - 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, String commentKey)
notifyOwnCommentReply in interface NotificationsManageruserIdToNotify - the user you want to notifyfeedid - the liked feedidfeedText - the liked feed text or a portion of itcommentKey - when sending email, stop the shown discussion at that commentpublic boolean notifyCommentReply(String userIdToNotify, String feedid, String commentText, String feedOwnerFullName, String feedOwnerId, String commentKey)
notifyCommentReply in interface NotificationsManageruserIdToNotify - 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 postcommentKey - when sending email, stop the shown discussion at that commentpublic boolean notifyCommentOnFavorite(String userIdToNotify, String feedid, String commentText, String commentKey)
notifyCommentOnFavorite in interface NotificationsManageruserIdToNotify - the user you want to notifyfeedid - the liked feedidcommentText - the commentTextcommentKey - when sending email, stop the shown discussion at that commentpublic boolean notifyUserTag(String userIdToNotify, String feedid, String feedText, String commentKey)
notifyUserTag in interface NotificationsManageruserIdToNotify - the user you want to notifyfeedid - the liked feedidcommentKey - when sending email, stop the shown discussion at that commentpublic boolean notifyLikedFeed(String userIdToNotify, String feedid, String feedText)
notifyLikedFeed in interface NotificationsManageruserIdToNotify - 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 NotificationsManageruserIdToNotify - the user you want to notifypublic boolean notifyDocumentWorkflowView(String userIdToNotify, String documentWorkflowId, String documentName)
notifyDocumentWorkflowView in interface NotificationsManageruserIdToNotify - the user you want to notifydocumentName - the document titlepublic boolean notifyDocumentWorkflowUpdate(String userIdToNotify, String documentWorkflowId, String documentName)
notifyDocumentWorkflowUpdate in interface NotificationsManageruserIdToNotify - the user you want to notifydocumentName - the document titlepublic boolean notifyDocumentWorkflowTaskRequest(String userIdToNotify, String documentWorkflowId, String documentName, String assignedRoleName)
notifyDocumentWorkflowTaskRequest in interface NotificationsManageruserIdToNotify - the user you want to notifydocumentName - the document titlepublic boolean notifyDocumentWorkflowUserForward(String userIdToNotify, String documentWorkflowId, String documentName, String fromStepName, String toStepName)
notifyDocumentWorkflowUserForward in interface NotificationsManageruserIdToNotify - 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 NotificationsManageruserIdToNotify - 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 NotificationsManageruserIdToNotify - the user you want to notifydocumentName - the document titlepublic boolean notifyNewCalendarEvent(String userIdToNotify, String eventTitle, String eventType, Date startDate, Date endingDate)
notifyNewCalendarEvent in interface NotificationsManageruserIdToNotify - 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 NotificationsManageruserIdToNotify - 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 NotificationsManageruserIdToNotify - the user you want to notifyeventTitle - the title of the eventeventType - the type of the eventstartDate - staring dateendingDate - ending datepublic boolean notifyTDMTabularResourceSharing(String userIdToNotify, String tabularResourceName, String encodedTabularResourceParams) throws Exception
notifyTDMTabularResourceSharing in interface NotificationsManageruserIdToNotify - the user you want to notifytabularResourceName - the shared tabular resource nameencodedTabularResourceParams - the parameters to be placed in the HTTP GET Request (must be encoded)Exceptionpublic boolean notifyTDMObjectSharing(String userIdToNotify, org.gcube.portal.databook.shared.NotificationType type, String tdmObjectName, String encodedTabularResourceParams) throws Exception
notifyTDMObjectSharing in interface NotificationsManageruserIdToNotify - the user you want to notifytype - type of the shared tdm object (TDM Rule or TDM Template at the moment)tdmObjectName - the nameencodedTabularResourceParams - the parameters to be placed in the HTTP GET Request (must be encoded)ExceptionCopyright © 2016. All Rights Reserved.