com.almworks.jira.structure.api.attribute.subscription

Interface AttributeSubscriptionService

@PublicApi
public interface AttributeSubscriptionService

AttributeSubscriptionService manages attribute subscriptions. A subscription allows the client to "watch" a particular set of values, identified by a set of rows and attributes, retrieve updates to this set of values in versioned manner, and perform background loading.

Subscriptions are kept in a cache and may be deleted / closed if not used or if there are too many subscriptions.

See Also:

AttributeSubscription

Method Summary

Modifier and Type	Method and Description
AttributeSubscription	createSubscription() Creates a new empty subscription.
void	dropSubscription(Long subscriptionId) Deletes the subscription.
AttributeSubscription	getSubscription(Long subscriptionId) Retrieves a previously created subscription.

Method Detail

createSubscription

@NotNull
AttributeSubscription createSubscription()

Creates a new empty subscription.

The subscription will be attached to the current user, and only that user will have the access to this subscription.

Returns:

a new subscription

See Also:

AttributeSubscription.changeSubscription(java.util.function.Consumer<com.almworks.jira.structure.api.attribute.subscription.AttributeSubscriptionPatch>)

getSubscription

@NotNull
AttributeSubscription getSubscription(@Nullable
                                               Long subscriptionId)
                                        throws StructureException

Retrieves a previously created subscription. The ID of the subscription should come from a previous call to AttributeSubscription.getSubscriptionId().

Parameters:

subscriptionId - subscription ID

Returns:

the subscription

Throws:

StructureException - if the current user is not the owner of the specified subscription, or if the subscription with this ID is not found

dropSubscription

void dropSubscription(@Nullable
                      Long subscriptionId)
               throws StructureException

Deletes the subscription. Any background loading is cancelled.

Parameters:

subscriptionId - subscription ID

Throws:

StructureException - if the current user is not the owner of the specified subscription, or if the subscription with this ID is not found