com.atlassian.jira.bc.filter

Class DefaultFilterSubscriptionService

java.lang.Object

com.atlassian.jira.bc.filter.DefaultFilterSubscriptionService

All Implemented Interfaces:

FilterSubscriptionService

public class DefaultFilterSubscriptionService
extends Object
implements FilterSubscriptionService

Uses Atlassian Scheduler

Constructor Summary

Constructors

Constructor and Description
DefaultFilterSubscriptionService(JiraAuthenticationContext jiraAuthenticationContext, SubscriptionManager subscriptionManager, com.atlassian.scheduler.SchedulerService schedulerService, FeatureManager featureManager, GlobalPermissionManager globalPermissionManager)

Method Summary

Modifier and Type	Method and Description
String	getCronExpression(JiraServiceContext context, FilterSubscription subscription) Retrieve the cron expression associated with this subscription
Date	getNextSendTime(FilterSubscription subscription) Returns the next send time for this subscription.
String	getPrettySchedule(JiraServiceContext context, String cronExpression) Renders a human readable description of the given cron expression.
Collection<FilterSubscription>	getVisibleFilterSubscriptions(ApplicationUser user, SearchRequest filter) Retrieves subscriptions that a user can see for a filter.
void	storeSubscription(JiraServiceContext context, Long filterId, String groupName, String expr, boolean emailOnEmpty) Create and store a subscription that uses the given cron expression
void	updateSubscription(JiraServiceContext context, ApplicationUser owner, Long subscriptionId, String groupName, String expr, boolean emailOnEmpty) Updates the subscription to the new given values and persists.
void	updateSubscription(JiraServiceContext context, Long subscriptionId, String groupName, String expr, boolean emailOnEmpty) Updates the subscription to the new given values and persists.
void	validateCronExpression(JiraServiceContext context, String expr) Validates a given cron expression

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultFilterSubscriptionService

public DefaultFilterSubscriptionService(JiraAuthenticationContext jiraAuthenticationContext,
                                        SubscriptionManager subscriptionManager,
                                        com.atlassian.scheduler.SchedulerService schedulerService,
                                        FeatureManager featureManager,
                                        GlobalPermissionManager globalPermissionManager)

Method Detail

validateCronExpression

public void validateCronExpression(JiraServiceContext context,
                                   String expr)

Description copied from interface: FilterSubscriptionService

Validates a given cron expression

Errors are passed back in the ErrorCollection of the JiraServiceContext

Specified by:

validateCronExpression in interface FilterSubscriptionService

Parameters:

context - Jira service context

expr - expression to evaluate

storeSubscription

public void storeSubscription(JiraServiceContext context,
                              Long filterId,
                              String groupName,
                              String expr,
                              boolean emailOnEmpty)

Description copied from interface: FilterSubscriptionService

Create and store a subscription that uses the given cron expression

Specified by:

storeSubscription in interface FilterSubscriptionService

Parameters:

context - Jira service context

filterId - id of the filter subscribing to

groupName - sent to group (may be null if sent to self)

expr - cron expression to store

emailOnEmpty - send email if filter returns no results

updateSubscription

public void updateSubscription(JiraServiceContext context,
                               Long subscriptionId,
                               String groupName,
                               String expr,
                               boolean emailOnEmpty)

Description copied from interface: FilterSubscriptionService

Updates the subscription to the new given values and persists.

Note: This method will always change the owner of the subscription to the logged in user. If you don't want this behavior, use FilterSubscriptionService.updateSubscription(JiraServiceContext, ApplicationUser, Long, String, String, boolean).

Specified by:

updateSubscription in interface FilterSubscriptionService

Parameters:

context - Jira service context

subscriptionId - id of the subscription being updated

groupName - sent to group (may be null if sent to self)

expr - cron expression to store

emailOnEmpty - send email if filter returns no results

updateSubscription

public void updateSubscription(JiraServiceContext context,
                               ApplicationUser owner,
                               Long subscriptionId,
                               String groupName,
                               String expr,
                               boolean emailOnEmpty)

Description copied from interface: FilterSubscriptionService

Updates the subscription to the new given values and persists.

Specified by:

updateSubscription in interface FilterSubscriptionService

Parameters:

context - Jira service context

owner - new owner for the subscription

subscriptionId - id of the subscription being updated

groupName - sent to group (may be null if sent to self)

expr - cron expression to store

emailOnEmpty - send email if filter returns no results

getPrettySchedule

public String getPrettySchedule(JiraServiceContext context,
                                String cronExpression)

Description copied from interface: FilterSubscriptionService

Renders a human readable description of the given cron expression.

Returns the cron expression if it can't be parsed by the com.atlassian.core.cron.parser.CronExpressionParser.

Specified by:

getPrettySchedule in interface FilterSubscriptionService

Parameters:

context - Jira service context

cronExpression - a cron expression.

Returns:

a locale-specific sentence describing the cron string (or on failure, the cron string).

getCronExpression

public String getCronExpression(JiraServiceContext context,
                                FilterSubscription subscription)

Description copied from interface: FilterSubscriptionService

Retrieve the cron expression associated with this subscription

Specified by:

getCronExpression in interface FilterSubscriptionService

Returns:

the cron expression associated with this subscription

getVisibleFilterSubscriptions

public Collection<FilterSubscription> getVisibleFilterSubscriptions(ApplicationUser user,
                                                                    SearchRequest filter)

Description copied from interface: FilterSubscriptionService

Retrieves subscriptions that a user can see for a filter.

An admin can see all subscriptions, the filter owner can see all subscriptions for their filter, otherwise a user can only see their own subscriptions.

Specified by:

getVisibleFilterSubscriptions in interface FilterSubscriptionService

Parameters:

user - the user that can see the subscriptions

filter - the filter with the associated subscriptions

Returns:

a collection of subscriptions

getNextSendTime

@Nullable
public Date getNextSendTime(@Nonnull
                                      FilterSubscription subscription)

Description copied from interface: FilterSubscriptionService

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 FilterSubscriptionService

Parameters:

subscription - the subscription

Returns:

next send time