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

Class ServerSubscriptionJournalStateStore

java.lang.Object

com.atlassian.confluence.internal.api.impl.service.incrementalsync.journal.ServerSubscriptionJournalStateStore

All Implemented Interfaces:

JournalStateStore, SubscriptionJournalStateStore

Direct Known Subclasses:

ClientSubscriptionJournalStateStore

public class ServerSubscriptionJournalStateStore
extends Object
implements SubscriptionJournalStateStore

A Journal State Store which will store the state based on Subscription Id

Since:

9.3.0

Constructor Summary

Constructors

Constructor	Description
ServerSubscriptionJournalStateStore(String subscriptionContextKey, IncrementalSyncSubscriptionManager incrementalSyncSubscriptionManager)

Method Summary

Modifier and Type	Method	Description
void	cleanUpSubscriptions(JournalIdentifier identifier, long ttlInMillis)	A Utility which helps to clean up expired subscriptions and deleted subscription
SubscriptionId	createNewSubscription(String subscriptionData)	This method creates a new ACTIVE subscription
void	deactivateSubscription(@NonNull JournalIdentifier journalId)	Mark a subscription as deactivate so later on IncrementalSyncCleaner will clean it
List<SubscriptionId>	getAvailableSubscriptions()	Get all current subscriptions
List<SubscriptionId>	getDeactivateSubscriptions()	Get all inactive subscriptions
protected String	getKeyPrefix()
long	getMostRecentId(@NonNull JournalIdentifier journalId)	Returns the most recent id for a journal or 0 if no id has been stored yet.
protected String	getSubscriptionContextKey()
Optional<IncrementalSyncSubscription>	getSubscriptionStateData(MultiSubscriptionPerJournalIdentifier subscriptionJournalIdentifier)	Get subscription value detail
boolean	isSubscriptionActive(MultiSubscriptionPerJournalIdentifier subscriptionJournalIdentifier)
boolean	removeSubscriptionStateData(@NonNull JournalIdentifier journalId)	Remove a particular subscription from data store
void	resetAllJournalStates()	Resets the state of all journals.
protected SubscriptionId	saveSubscriptionStateData(IncrementalSyncSubscription value)
void	setMostRecentId(@NonNull JournalIdentifier journalId, long id)	Set the most recent identifier for a journal.

Methods inherited from class java.lang.Object

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

Constructor Details

ServerSubscriptionJournalStateStore

public ServerSubscriptionJournalStateStore(String subscriptionContextKey,
 IncrementalSyncSubscriptionManager incrementalSyncSubscriptionManager)

Method Details

getMostRecentId

public long getMostRecentId(@NonNull JournalIdentifier journalId)
                     throws org.springframework.dao.DataAccessException

Description copied from interface: JournalStateStore

Returns the most recent id for a journal or 0 if no id has been stored yet.

New journal is automatically created if a journal with the given name does not exists.

Specified by:

getMostRecentId in interface JournalStateStore

Parameters:

journalId - id of the journal

Returns:

most recent id for a journal or 0 if no id has been stored yet

Throws:

org.springframework.dao.DataAccessException - if reading the id failed

setMostRecentId

public void setMostRecentId(@NonNull JournalIdentifier journalId,
 long id)
                     throws org.springframework.dao.DataAccessException

Description copied from interface: JournalStateStore

Set the most recent identifier for a journal.

New journal is automatically created if a journal with the given name does not exists.

Only positive identifiers (e.g. > 0) can be stored.

Specified by:

setMostRecentId in interface JournalStateStore

Parameters:

journalId - id of the journal

id - identifier to store as the most recent id

Throws:

org.springframework.dao.DataAccessException - if persisting the id failed.

saveSubscriptionStateData

protected SubscriptionId saveSubscriptionStateData(IncrementalSyncSubscription value)

resetAllJournalStates

public void resetAllJournalStates()
                           throws org.springframework.dao.DataAccessException

Description copied from interface: JournalStateStore

Resets the state of all journals.

After calling this method all JournalStateStore.getMostRecentId(JournalIdentifier) calls will initially return 0.

Specified by:

resetAllJournalStates in interface JournalStateStore

Throws:

org.springframework.dao.DataAccessException - if reset fails

deactivateSubscription

public void deactivateSubscription(@NonNull JournalIdentifier journalId)

Description copied from interface: SubscriptionJournalStateStore

Mark a subscription as deactivate so later on IncrementalSyncCleaner will clean it

Specified by:

deactivateSubscription in interface SubscriptionJournalStateStore

removeSubscriptionStateData

public boolean removeSubscriptionStateData(@NonNull JournalIdentifier journalId)
                                    throws org.springframework.dao.DataAccessException

Description copied from interface: SubscriptionJournalStateStore

Remove a particular subscription from data store

Specified by:

removeSubscriptionStateData in interface SubscriptionJournalStateStore

Returns:

Throws:

org.springframework.dao.DataAccessException

getAvailableSubscriptions

public List<SubscriptionId> getAvailableSubscriptions()

Description copied from interface: SubscriptionJournalStateStore

Get all current subscriptions

Specified by:

getAvailableSubscriptions in interface SubscriptionJournalStateStore

Returns:

list of current subscription ids

getDeactivateSubscriptions

public List<SubscriptionId> getDeactivateSubscriptions()

Description copied from interface: SubscriptionJournalStateStore

Get all inactive subscriptions

Specified by:

getDeactivateSubscriptions in interface SubscriptionJournalStateStore

Returns:

list of inactive subscription ids

cleanUpSubscriptions

public void cleanUpSubscriptions(JournalIdentifier identifier,
 long ttlInMillis)

Description copied from interface: SubscriptionJournalStateStore

A Utility which helps to clean up expired subscriptions and deleted subscription

Specified by:

cleanUpSubscriptions in interface SubscriptionJournalStateStore

Parameters:

identifier - an identifier for journal which manage all subscription

ttlInMillis - time to leave in milliseconds

createNewSubscription

public SubscriptionId createNewSubscription(String subscriptionData)

Description copied from interface: SubscriptionJournalStateStore

This method creates a new ACTIVE subscription

Specified by:

createNewSubscription in interface SubscriptionJournalStateStore

Parameters:

subscriptionData - the data associated with the subscription

Returns:

getSubscriptionContextKey

protected String getSubscriptionContextKey()

getKeyPrefix

protected String getKeyPrefix()

getSubscriptionStateData

public Optional<IncrementalSyncSubscription> getSubscriptionStateData(MultiSubscriptionPerJournalIdentifier subscriptionJournalIdentifier)

Description copied from interface: SubscriptionJournalStateStore

Get subscription value detail

Specified by:

getSubscriptionStateData in interface SubscriptionJournalStateStore

Returns:

isSubscriptionActive

public boolean isSubscriptionActive(MultiSubscriptionPerJournalIdentifier subscriptionJournalIdentifier)

Specified by:

isSubscriptionActive in interface SubscriptionJournalStateStore

Parameters:

subscriptionJournalIdentifier - subscription identifier

Returns:

true if the subscription is active