com.atlassian.jira.issue.subscription

Class DefaultSubscriptionManager

java.lang.Object

com.atlassian.jira.mail.MailingListCompiler

com.atlassian.jira.issue.subscription.DefaultSubscriptionManager

All Implemented Interfaces:

GroupConfigurable, SubscriptionManager

public class DefaultSubscriptionManager
extends MailingListCompiler
implements SubscriptionManager, GroupConfigurable

Field Summary

Fields

Modifier and Type	Field and Description
static String	JOB_RUNNER_KEY
static String	SUBSCRIPTION_PREFIX

Fields inherited from interface com.atlassian.jira.issue.subscription.SubscriptionManager

SUBSCRIPTION_IDENTIFIER

Constructor Summary

Constructors

Constructor and Description

DefaultSubscriptionManager(com.atlassian.mail.queue.MailQueue mailQueue, TemplateManager templateManager, SubscriptionMailQueueItemFactory subscriptionMailQueueItemFactory, ProjectRoleManager projectRoleManager, GroupManager groupManager, com.atlassian.scheduler.SchedulerService schedulerService, EntityEngine entityEngine, DateTimeFormatterFactory dateTimeFormatterFactory, UserManager userManager, FeatureManager featureManager)

Method Summary

Modifier and Type	Method and Description
FilterSubscription	createSubscription(ApplicationUser user, Long filterId, String groupName, String cronExpression, Boolean emailOnEmpty) Creates a new subscription based on the passed in filter id and fired in accordance with the passed in trigger
void	deleteSubscription(Long subId)
void	deleteSubscriptionsForGroup(com.atlassian.crowd.embedded.api.Group group)
void	deleteSubscriptionsForUser(ApplicationUser user) Delete all subscriptions owned by a user.
List<FilterSubscription>	getAllFilterSubscriptions()
List<FilterSubscription>	getAllFilterSubscriptions(Long filterId)
String	getCronExpressionForSubscription(FilterSubscription subscription) Retrieve the cron expression associated with this subscription
FilterSubscription	getFilterSubscription(ApplicationUser user, Long subId)
FilterSubscription	getFilterSubscription(Long subId) Get a subscription by Id
List<FilterSubscription>	getFilterSubscriptions(ApplicationUser user, Long filterId)
Date	getNextSendTime(FilterSubscription sub) Returns the next send time for this subscription.
List<FilterSubscription>	getSubscriptionsForUser(ApplicationUser user) Get all subscriptions owned by the given user
boolean	hasSubscription(ApplicationUser user, Long filterId)
boolean	isGroupUsed(com.atlassian.crowd.embedded.api.Group group) Determine whether configuration exists for the specified Group.
void	runSubscription(ApplicationUser user, Long subId) Run this subscription now.
void	runSubscription(Long subId)
void	updateSubscription(ApplicationUser user, Long subId, String groupName, String cronExpression, Boolean emailOnEmpty)

Methods inherited from class com.atlassian.jira.mail.MailingListCompiler

getEmailAddresses, prepareEmail, sendLists

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.atlassian.jira.config.group.GroupConfigurable

isGroupUsed

Field Detail

SUBSCRIPTION_PREFIX

public static final String SUBSCRIPTION_PREFIX

JOB_RUNNER_KEY

public static final String JOB_RUNNER_KEY

Constructor Detail

DefaultSubscriptionManager

public DefaultSubscriptionManager(com.atlassian.mail.queue.MailQueue mailQueue,
                                  TemplateManager templateManager,
                                  SubscriptionMailQueueItemFactory subscriptionMailQueueItemFactory,
                                  ProjectRoleManager projectRoleManager,
                                  GroupManager groupManager,
                                  com.atlassian.scheduler.SchedulerService schedulerService,
                                  EntityEngine entityEngine,
                                  DateTimeFormatterFactory dateTimeFormatterFactory,
                                  UserManager userManager,
                                  FeatureManager featureManager)

Method Detail

hasSubscription

public boolean hasSubscription(ApplicationUser user,
                               Long filterId)
                        throws org.ofbiz.core.entity.GenericEntityException

Specified by:

hasSubscription in interface SubscriptionManager

Throws:

org.ofbiz.core.entity.GenericEntityException

getFilterSubscription

public FilterSubscription getFilterSubscription(Long subId)
                                         throws org.ofbiz.core.entity.GenericEntityException

Description copied from interface: SubscriptionManager

Get a subscription by Id

Specified by:

getFilterSubscription in interface SubscriptionManager

Parameters:

subId - Subscription Id

Returns:

Subscription

Throws:

org.ofbiz.core.entity.GenericEntityException

getFilterSubscription

public FilterSubscription getFilterSubscription(ApplicationUser user,
                                                Long subId)
                                         throws org.ofbiz.core.entity.GenericEntityException

Specified by:

getFilterSubscription in interface SubscriptionManager

Throws:

org.ofbiz.core.entity.GenericEntityException

getFilterSubscriptions

public List<FilterSubscription> getFilterSubscriptions(ApplicationUser user,
                                                       Long filterId)
                                                throws org.ofbiz.core.entity.GenericEntityException

Specified by:

getFilterSubscriptions in interface SubscriptionManager

Throws:

org.ofbiz.core.entity.GenericEntityException

getCronExpressionForSubscription

@Nullable
public String getCronExpressionForSubscription(FilterSubscription subscription)

Description copied from interface: SubscriptionManager

Retrieve the cron expression associated with this subscription

Specified by:

getCronExpressionForSubscription in interface SubscriptionManager

Returns:

the cron expression associated with this subscription

updateSubscription

public void updateSubscription(ApplicationUser user,
                               Long subId,
                               String groupName,
                               String cronExpression,
                               Boolean emailOnEmpty)
                        throws DataAccessException

Specified by:

updateSubscription in interface SubscriptionManager

Parameters:

user - new owner for the subscription

subId - identifies the subscription to update

groupName - (optional) the name of the group to receive the email

cronExpression - The Cron expression to update the subscription with

Throws:

DataAccessException - if there is a problem persisting the data.

getAllFilterSubscriptions

public List<FilterSubscription> getAllFilterSubscriptions(Long filterId)

Specified by:

getAllFilterSubscriptions in interface SubscriptionManager

getAllFilterSubscriptions

public List<FilterSubscription> getAllFilterSubscriptions()

Specified by:

getAllFilterSubscriptions in interface SubscriptionManager

getSubscriptionsForUser

@Nonnull
public List<FilterSubscription> getSubscriptionsForUser(@Nullable
                                                                 ApplicationUser user)

Description copied from interface: SubscriptionManager

Get all subscriptions owned by the given user

Specified by:

getSubscriptionsForUser in interface SubscriptionManager

Parameters:

user - subscription owner or null for an anonymous user

Returns:

list of subscriptions. Can be empty.

createSubscription

public FilterSubscription createSubscription(ApplicationUser user,
                                             Long filterId,
                                             String groupName,
                                             String cronExpression,
                                             Boolean emailOnEmpty)

Description copied from interface: SubscriptionManager

Creates a new subscription based on the passed in filter id and fired in accordance with the passed in trigger

Specified by:

createSubscription in interface SubscriptionManager

Parameters:

user - the owner of the subscription

filterId - Id of the filter subscribing to

groupName - Sent ot group

cronExpression - The Cron expression for the subscription

emailOnEmpty - send email if filter returns no results

Returns:

FilterSubscription representing new subscription

getNextSendTime

@Nullable
public Date getNextSendTime(@Nonnull
                                      FilterSubscription sub)

Description copied from interface: SubscriptionManager

Returns the next send time for this subscription. This may return null if the scheduler does not support the reporting of next send times.

Specified by:

getNextSendTime in interface SubscriptionManager

Parameters:

sub - The subscription

Returns:

Next send time

deleteSubscription

public void deleteSubscription(Long subId)
                        throws org.ofbiz.core.entity.GenericEntityException

Specified by:

deleteSubscription in interface SubscriptionManager

Throws:

org.ofbiz.core.entity.GenericEntityException

deleteSubscriptionsForUser

public void deleteSubscriptionsForUser(@Nonnull
                                       ApplicationUser user)
                                throws org.ofbiz.core.entity.GenericEntityException

Description copied from interface: SubscriptionManager

Delete all subscriptions owned by a user.

Specified by:

deleteSubscriptionsForUser in interface SubscriptionManager

Parameters:

user - the current user performing this operation

Throws:

org.ofbiz.core.entity.GenericEntityException

runSubscription

public void runSubscription(Long subId)
                     throws org.ofbiz.core.entity.GenericEntityException

Specified by:

runSubscription in interface SubscriptionManager

Throws:

org.ofbiz.core.entity.GenericEntityException

runSubscription

public void runSubscription(ApplicationUser user,
                            Long subId)
                     throws org.ofbiz.core.entity.GenericEntityException

Description copied from interface: SubscriptionManager

Run this subscription now.

Specified by:

runSubscription in interface SubscriptionManager

Parameters:

user - the current user performing this operation

subId - identifies the subscription to update

Throws:

org.ofbiz.core.entity.GenericEntityException

deleteSubscriptionsForGroup

public void deleteSubscriptionsForGroup(com.atlassian.crowd.embedded.api.Group group)
                                 throws org.ofbiz.core.entity.GenericEntityException

Specified by:

deleteSubscriptionsForGroup in interface SubscriptionManager

Throws:

org.ofbiz.core.entity.GenericEntityException

isGroupUsed

public boolean isGroupUsed(@Nonnull
                           com.atlassian.crowd.embedded.api.Group group)

Description copied from interface: GroupConfigurable

Determine whether configuration exists for the specified Group.

Specified by:

isGroupUsed in interface GroupConfigurable

Parameters:

group - that may or may not exist.

Returns:

true if the group is used in the components configuration.