Package com.atlassian.confluence.incrementalsync

Interface SpaceFilteringManager

All Known Implementing Classes:

CachedSpaceFilteringManager, DefaultSpaceFilteringManager

@Transactional
public interface SpaceFilteringManager

Manager to work with SpaceInclusionEntity Before version 9.2.8 this class name was SpaceExclusionManager

Since:

9.2.7

Method Summary

Modifier and Type	Method	Description
void	addSpace(String key, String source)	Add space key to the allowlist
Set<String>	getAllowedSpaces()	Return the flag that indicates whether new spaces should be added to the allowlist automatically.
boolean	isExcluded(String spaceKey)	Check if the space with the given space key should be excluded from synchronisation.
boolean	isOptedIn()	Check if the content filtering is active (opted-in) or not
boolean	optInNewSpaces()	Return the flag that indicates whether new spaces should be added to the allowlist automatically.
void	replaceList(Set<String> spaceKeys, boolean optInNewSpaces, String source)	Update the list of spaces.
void	resetList(String source)	Reset the allowlist.

Method Details

replaceList

void replaceList(Set<String> spaceKeys,
 boolean optInNewSpaces,
 String source)

Update the list of spaces. Previous list is completely deleted on the upgrade.

Parameters:

spaceKeys - set of space keys for the allowlist

optInNewSpaces - flag that defines if the new spaces have to be added to the allowlist or not

source - initiator of changes

isExcluded

@Transactional(readOnly=true)
boolean isExcluded(String spaceKey)

Check if the space with the given space key should be excluded from synchronisation. Space key comparison is performed ignoring the case.

Parameters:

spaceKey - space key to check

Returns:

true if space should be excluded, false otherwise.

resetList

void resetList(String source)

Reset the allowlist. Resetting the list means opting out the filtering feature, and make all content available for synchronisation

Parameters:

source - initiator of changes

optInNewSpaces

boolean optInNewSpaces()

Return the flag that indicates whether new spaces should be added to the allowlist automatically. IMPORTANT: if the filter list is disabled (opted out), then this method will return true. To check opt-in/opt-out settings, please call isOptedIn()

Returns:

true if new spaces are allowed to synchronise, false otherwise

getAllowedSpaces

Set<String> getAllowedSpaces()

Return the flag that indicates whether new spaces should be added to the allowlist automatically. IMPORTANT: if the filter list is disabled (opted out), then this method will return empty set. To check opt-in/opt-out settings, please call isOptedIn()

Returns:

true if new spaces are allowed to synchronise, false otherwise

isOptedIn

boolean isOptedIn()

Check if the content filtering is active (opted-in) or not

Returns:

true if Confluence is opted in for content filtering, false otherwise

addSpace

void addSpace(String key,
 String source)

Add space key to the allowlist

Parameters:

key - space key

source - source of changes

Throws:

InvalidOperationException - if space filtering is disabled