com.almworks.jira.structure.api.cache

Interface StructureCacheHelper

@Internal
public interface StructureCacheHelper

Method Summary

Modifier and Type	Method and Description
void	clearAllStructureCaches() Clears all caches on the current JIRA instance that are maintained by Structure and Structure extensions.
void	clearAllStructureCachesOnAllNodes() Clears all caches (maintained by Structure and Structure extensions) on the current JIRA instance and causes eventual caches clearing on other nodes (when running on JIRA Data Center).
void	clearCurrentUserStructureCaches() Clears caches on the current node for the current user.
void	clearUserStructureCaches(ApplicationUser user) Clears caches on the current node for the given non-anonymous user.
default void	clearUserStructureCachesOnAllNodes(ApplicationUser user) Clears caches on the all nodes for the given non-anonymous user (maintained by Structure and Structure extensions) on the current JIRA instance and causes eventual caches clearing on other nodes (when running on JIRA Data Center).
void	clearUserStructureCachesOnAllNodes(String userKey) Clears caches on the all nodes for the given user key (maintained by Structure and Structure extensions) on the current JIRA instance and causes eventual caches clearing on other nodes (when running on JIRA Data Center).

Method Detail

clearAllStructureCaches

void clearAllStructureCaches()

Clears all caches on the current JIRA instance that are maintained by Structure and Structure extensions.

Note that in JIRA Data Center environment, this does not clear caches on other nodes.

After this method has finished execution, the caches are cleared.

See Also:

CachingComponent, clearAllStructureCachesOnAllNodes()

clearAllStructureCachesOnAllNodes

void clearAllStructureCachesOnAllNodes()

Clears all caches (maintained by Structure and Structure extensions) on the current JIRA instance and causes eventual caches clearing on other nodes (when running on JIRA Data Center).

When running on non-JDC instance, works the same as clearAllStructureCaches().

After this method has finished execution, the caches are cleared on the local node, but may not be cleared yet on other nodes.

See Also:

CachingComponent, clearAllStructureCaches()

clearUserStructureCachesOnAllNodes

default void clearUserStructureCachesOnAllNodes(@NotNull
                                                ApplicationUser user)

Clears caches on the all nodes for the given non-anonymous user (maintained by Structure and Structure extensions) on the current JIRA instance and causes eventual caches clearing on other nodes (when running on JIRA Data Center).

When running on non-JDC instance, works the same as clearUserStructureCaches(ApplicationUser).

After this method has finished execution, the user-related caches are cleared on the local node, but may not be cleared yet on other nodes.

See Also:

CachingComponent, clearUserStructureCaches(ApplicationUser)

clearUserStructureCachesOnAllNodes

void clearUserStructureCachesOnAllNodes(@NotNull
                                        String userKey)

Clears caches on the all nodes for the given user key (maintained by Structure and Structure extensions) on the current JIRA instance and causes eventual caches clearing on other nodes (when running on JIRA Data Center).

After this method has finished execution, the user-related caches are cleared on the local node, but may not be cleared yet on other nodes.

Implementation should guarantee that cache will be cleared even user associated with the key doesn't exist, that might happen in case of changing user key during anonymization for the user that was created prior Jira 8.3

clearCurrentUserStructureCaches

void clearCurrentUserStructureCaches()

Clears caches on the current node for the current user.

clearUserStructureCaches

void clearUserStructureCaches(@NotNull
                              ApplicationUser user)

Clears caches on the current node for the given non-anonymous user.