Package com.atlassian.confluence.internal.api.impl.service.incrementalsync

Class AbstractIncrementalSyncService<S extends SubscriptionSpec,T extends IncrementalSyncModel>

java.lang.Object

com.atlassian.confluence.internal.api.impl.service.incrementalsync.AbstractIncrementalSyncService<S,T>

All Implemented Interfaces:

IncrementalSyncCleaner, IncrementalSyncService<S,T>

Direct Known Subclasses:

ContentManagementIncrementalSyncServiceImpl, GlobalPermissionManagementIncrementalSyncServiceImpl, UserManagementIncrementalSyncServiceImpl

public abstract class AbstractIncrementalSyncService<S extends SubscriptionSpec,T extends IncrementalSyncModel>
extends Object
implements IncrementalSyncService<S,T>, IncrementalSyncCleaner

Field Summary

Fields

Modifier and Type	Field	Description
protected final com.atlassian.core.util.Clock	clock
static final String	INCREMENTAL_SYNC_EVENTS_BATCH_LIMIT_PREFIX
protected final IncrementalSyncDataFetcher<T>	incrementalSyncDataFetcher
protected final JournalServiceInternal	journalService
protected final org.slf4j.Logger	logger
protected final PermissionManager	permissionManager
protected final ScopesRequestCacheDelegate	scopesRequestCacheDelegate
protected final SubscriptionJournalStateStore	subscriptionJournalStateStore

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractIncrementalSyncService(JournalServiceInternal journalService, SubscriptionJournalStateStore subscriptionJournalStateStore, com.atlassian.core.util.Clock clock, PermissionManager permissionManager, IncrementalSyncDataFetcher<T> incrementalSyncDataFetcher, ScopesRequestCacheDelegate scopesRequestCacheDelegate)

Method Summary

Modifier and Type	Method	Description
void	cleanObsoleteData()	This will clean both obsolete journal entry and subscription.
void	cleanUpSubscriptions()	This will clean up inactive/unused subscription
List<SubscriptionId>	getAvailableSubscriptions()	Get all subscription for current service
protected abstract MultiSubscriptionPerJournalIdentifier	getJournalIdentifier(long subscriptionId)
protected abstract String	getJournalName()
IncrementalSyncCursor	getMostRecentCursor(long id)	This will find and return the most recent incremental sync cursor corresponding to the provided subscription's most recent journal entry, if one exists.
protected abstract String	getSubscriptionData(S spec)
<E> void	handleEventForSubscription(E event, Consumer<JournalIdentifier> processor)	Based on input event this method will find a corresponding subscription which would like to handle it.
boolean	isSubscriptionActive(long subscriptionId)
IncrementalSyncPageResponse<T>	processEvents(PageRequest pageRequest)	Processing events
SubscriptionId	subscribe(S spec)	Register to incremental api
boolean	unsubscribe(SubscriptionId subscriptionId)	Remove an exising subscription
protected void	verifyAdminUserOrManageSubscriptionScope()
protected void	verifyAdminUserOrReadAllScope()

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.atlassian.confluence.internal.api.service.incrementalsync.IncrementalSyncCleaner

getManagedJournalIdentifier

Methods inherited from interface com.atlassian.confluence.internal.api.service.incrementalsync.IncrementalSyncService

getEventsBatchLimit

Field Details

INCREMENTAL_SYNC_EVENTS_BATCH_LIMIT_PREFIX

public static final String INCREMENTAL_SYNC_EVENTS_BATCH_LIMIT_PREFIX

See Also:

• Constant Field Values

logger

protected final org.slf4j.Logger logger

permissionManager

protected final PermissionManager permissionManager

journalService

protected final JournalServiceInternal journalService

clock

protected final com.atlassian.core.util.Clock clock

subscriptionJournalStateStore

protected final SubscriptionJournalStateStore subscriptionJournalStateStore

incrementalSyncDataFetcher

protected final IncrementalSyncDataFetcher<T extends IncrementalSyncModel> incrementalSyncDataFetcher

scopesRequestCacheDelegate

protected final ScopesRequestCacheDelegate scopesRequestCacheDelegate

Constructor Details

AbstractIncrementalSyncService

protected AbstractIncrementalSyncService(JournalServiceInternal journalService,
 SubscriptionJournalStateStore subscriptionJournalStateStore,
 com.atlassian.core.util.Clock clock,
 PermissionManager permissionManager,
 IncrementalSyncDataFetcher<T> incrementalSyncDataFetcher,
 ScopesRequestCacheDelegate scopesRequestCacheDelegate)

Method Details

subscribe

public SubscriptionId subscribe(S spec)

Description copied from interface: IncrementalSyncService

Register to incremental api

Specified by:

subscribe in interface IncrementalSyncService<S extends SubscriptionSpec,T extends IncrementalSyncModel>

Parameters:

spec - the specification

Returns:

an unique id

unsubscribe

public boolean unsubscribe(SubscriptionId subscriptionId)

Description copied from interface: IncrementalSyncService

Remove an exising subscription

Specified by:

unsubscribe in interface IncrementalSyncService<S extends SubscriptionSpec,T extends IncrementalSyncModel>

Returns:

indicate the operation is success or not

getAvailableSubscriptions

public List<SubscriptionId> getAvailableSubscriptions()

Description copied from interface: IncrementalSyncService

Get all subscription for current service

Specified by:

getAvailableSubscriptions in interface IncrementalSyncService<S extends SubscriptionSpec,T extends IncrementalSyncModel>

Returns:

list of available subscriptions

cleanUpSubscriptions

public void cleanUpSubscriptions()

Description copied from interface: IncrementalSyncService

This will clean up inactive/unused subscription

Specified by:

cleanUpSubscriptions in interface IncrementalSyncService<S extends SubscriptionSpec,T extends IncrementalSyncModel>

processEvents

public IncrementalSyncPageResponse<T> processEvents(PageRequest pageRequest)

Description copied from interface: IncrementalSyncService

Processing events

Specified by:

processEvents in interface IncrementalSyncService<S extends SubscriptionSpec,T extends IncrementalSyncModel>

Parameters:

pageRequest - Page request with cursor.

Returns:

IncrementalSyncPageResponse which will contain the next cursor

getSubscriptionData

protected abstract String getSubscriptionData(S spec)

getJournalName

protected abstract String getJournalName()

getJournalIdentifier

protected abstract MultiSubscriptionPerJournalIdentifier getJournalIdentifier(long subscriptionId)

verifyAdminUserOrReadAllScope

protected void verifyAdminUserOrReadAllScope()

verifyAdminUserOrManageSubscriptionScope

protected void verifyAdminUserOrManageSubscriptionScope()

cleanObsoleteData

public void cleanObsoleteData()

Description copied from interface: IncrementalSyncCleaner

This will clean both obsolete journal entry and subscription. We need to clean Journal Entry first then clean Subscription. For Subscription, there are obsolete subscription and deleted subscription

Specified by:

cleanObsoleteData in interface IncrementalSyncCleaner

isSubscriptionActive

public boolean isSubscriptionActive(long subscriptionId)

Specified by:

isSubscriptionActive in interface IncrementalSyncService<S extends SubscriptionSpec,T extends IncrementalSyncModel>

Parameters:

subscriptionId - the subscription id

Returns:

{code true} if the subscription is active

getMostRecentCursor

public IncrementalSyncCursor getMostRecentCursor(long id)

Description copied from interface: IncrementalSyncService

This will find and return the most recent incremental sync cursor corresponding to the provided subscription's most recent journal entry, if one exists.

Specified by:

getMostRecentCursor in interface IncrementalSyncService<S extends SubscriptionSpec,T extends IncrementalSyncModel>

Parameters:

id - ID of the subscription.

Returns:

Optional incremental sync cursor pointing the latest journal entry.

handleEventForSubscription

public <E> void handleEventForSubscription(E event,
 Consumer<JournalIdentifier> processor)

Description copied from interface: IncrementalSyncService

Based on input event this method will find a corresponding subscription which would like to handle it. Then will trigger the call back to handle that

Specified by:

handleEventForSubscription in interface IncrementalSyncService<S extends SubscriptionSpec,T extends IncrementalSyncModel>

Type Parameters:

E - an event