Package com.atlassian.confluence.cache

Enum CoreCache

java.lang.Object

java.lang.Enum<CoreCache>

com.atlassian.confluence.cache.CoreCache

All Implemented Interfaces:

Serializable, Comparable<CoreCache>

@Internal
public enum CoreCache
extends Enum<CoreCache>

An enumeration which defines various caches used in Confluence Core.

The enumeration values themselves are fairly arbitrary, intended to be descriptive of what they contain. The systemCacheName field contains the name of the cache as used by the various Cache APIs.

Note that ideally every cache used by core would be listed here, but in practice it's likely to be slightly incomplete, so don't depend on it being exhaustive.

Note also that Hibernate caches won't be listed here.

Since:

7.5

Enum Constant Summary

Enum Constants

Enum Constant	Description
ATTACHMENT_DOWNLOAD_PATH_BY_CONTENT_ID_AND_FILENAME
ATTACHMENT_ID_BY_CONTENT_ID_AND_FILENAME
BANDANA_VALUE_BY_CONTEXT_AND_KEY
CAPTCHA_BY_ID
CONTENT_PERMISSION_SETS_BY_CONTENT_ID
CONTENT_PROPERTY_BY_CONTENT_ID_AND_KEY
CROWD_GROUP_ATTRIBUTES_BY_NAME
CROWD_GROUPS_BY_NAME
CROWD_USER_ATTRIBUTES_BY_NAME
CROWD_USERS_BY_EMAIL
CROWD_USERS_BY_NAME
DECORATORS_BY_SPACE_KEY
DECORATORS_EXIST_BY_SPACE_KEY
DIFF_RESULT_BY_KEY
FINALIZED_BUILD_NUMBER
FORMAT_SETTINGS
GLOBAL_THEME_KEY
GROUP_MEMBERSHIPS_BY_USER
I18N_BY_LOCALE
IS_USER_WATCHING_CONTENT
LOCALE_BY_USER_NAME
LOGIN_MANAGER_FAILURE_CACHE
MACRO_METADATA
MAU_LAST_SENT_TIME_BY_USER
MOST_POPULAR_BY_SPACE
MOST_RECENT_JOURNAL_ID
PAGE_ID_BY_SPACE_KEY_AND_TITLE
PERMITTED_GROUP_NAMES_BY_SPACE
PLUGIN_PERSISTENT_STATE
REGISTERED_USERS
REMOTE_DIRECTORY_BY_ID
SCHEDULED_JOB_STATUS
SITE_ENABLED_DARK_FEATURES
SPACE_ID_BY_SPACE_KEY
SPACE_PERMISSIONS
SPACE_PERMISSIONS_BY_SPACE_KEY
SPACE_RETENTION_POLICY_BY_SPACE_KEY
SPACE_THEME_KEY
UPGRADE_HISTORY
USER_ID_BY_USER_KEY
USER_KEY_BY_USER_NAME
USER_PROPERTY_SET_REFERENCES
USER_PROPERTY_SETS
VELOCITY_RESOURCES

Method Summary

Modifier and Type	Method	Description
<K,V> com.atlassian.cache.Cache<K,V>	getCache(com.atlassian.cache.CacheFactory cacheFactory)	Convenince method that resolves this cache against an Atlassian Cache CacheFactory.
<T> T	resolve(Function<String,T> resolver)	Resolves this cache using a function which takes the systemCacheName.
static CoreCache	valueOf(String name)	Returns the enum constant of this type with the specified name.
static CoreCache[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

ATTACHMENT_DOWNLOAD_PATH_BY_CONTENT_ID_AND_FILENAME

public static final CoreCache ATTACHMENT_DOWNLOAD_PATH_BY_CONTENT_ID_AND_FILENAME

ATTACHMENT_ID_BY_CONTENT_ID_AND_FILENAME

public static final CoreCache ATTACHMENT_ID_BY_CONTENT_ID_AND_FILENAME

BANDANA_VALUE_BY_CONTEXT_AND_KEY

public static final CoreCache BANDANA_VALUE_BY_CONTEXT_AND_KEY

CAPTCHA_BY_ID

public static final CoreCache CAPTCHA_BY_ID

CONTENT_PERMISSION_SETS_BY_CONTENT_ID

public static final CoreCache CONTENT_PERMISSION_SETS_BY_CONTENT_ID

CONTENT_PROPERTY_BY_CONTENT_ID_AND_KEY

public static final CoreCache CONTENT_PROPERTY_BY_CONTENT_ID_AND_KEY

CROWD_GROUPS_BY_NAME

public static final CoreCache CROWD_GROUPS_BY_NAME

CROWD_GROUP_ATTRIBUTES_BY_NAME

public static final CoreCache CROWD_GROUP_ATTRIBUTES_BY_NAME

CROWD_USERS_BY_NAME

public static final CoreCache CROWD_USERS_BY_NAME

CROWD_USERS_BY_EMAIL

public static final CoreCache CROWD_USERS_BY_EMAIL

CROWD_USER_ATTRIBUTES_BY_NAME

public static final CoreCache CROWD_USER_ATTRIBUTES_BY_NAME

DECORATORS_BY_SPACE_KEY

public static final CoreCache DECORATORS_BY_SPACE_KEY

DECORATORS_EXIST_BY_SPACE_KEY

public static final CoreCache DECORATORS_EXIST_BY_SPACE_KEY

DIFF_RESULT_BY_KEY

public static final CoreCache DIFF_RESULT_BY_KEY

FORMAT_SETTINGS

public static final CoreCache FORMAT_SETTINGS

GLOBAL_THEME_KEY

public static final CoreCache GLOBAL_THEME_KEY

GROUP_MEMBERSHIPS_BY_USER

public static final CoreCache GROUP_MEMBERSHIPS_BY_USER

I18N_BY_LOCALE

public static final CoreCache I18N_BY_LOCALE

IS_USER_WATCHING_CONTENT

public static final CoreCache IS_USER_WATCHING_CONTENT

LOCALE_BY_USER_NAME

public static final CoreCache LOCALE_BY_USER_NAME

LOGIN_MANAGER_FAILURE_CACHE

public static final CoreCache LOGIN_MANAGER_FAILURE_CACHE

MACRO_METADATA

public static final CoreCache MACRO_METADATA

MAU_LAST_SENT_TIME_BY_USER

public static final CoreCache MAU_LAST_SENT_TIME_BY_USER

MOST_POPULAR_BY_SPACE

public static final CoreCache MOST_POPULAR_BY_SPACE

MOST_RECENT_JOURNAL_ID

public static final CoreCache MOST_RECENT_JOURNAL_ID

PAGE_ID_BY_SPACE_KEY_AND_TITLE

public static final CoreCache PAGE_ID_BY_SPACE_KEY_AND_TITLE

PERMITTED_GROUP_NAMES_BY_SPACE

public static final CoreCache PERMITTED_GROUP_NAMES_BY_SPACE

PLUGIN_PERSISTENT_STATE

public static final CoreCache PLUGIN_PERSISTENT_STATE

REGISTERED_USERS

public static final CoreCache REGISTERED_USERS

REMOTE_DIRECTORY_BY_ID

public static final CoreCache REMOTE_DIRECTORY_BY_ID

SCHEDULED_JOB_STATUS

public static final CoreCache SCHEDULED_JOB_STATUS

SITE_ENABLED_DARK_FEATURES

public static final CoreCache SITE_ENABLED_DARK_FEATURES

SPACE_ID_BY_SPACE_KEY

public static final CoreCache SPACE_ID_BY_SPACE_KEY

SPACE_PERMISSIONS

public static final CoreCache SPACE_PERMISSIONS

SPACE_PERMISSIONS_BY_SPACE_KEY

public static final CoreCache SPACE_PERMISSIONS_BY_SPACE_KEY

SPACE_RETENTION_POLICY_BY_SPACE_KEY

public static final CoreCache SPACE_RETENTION_POLICY_BY_SPACE_KEY

SPACE_THEME_KEY

public static final CoreCache SPACE_THEME_KEY

UPGRADE_HISTORY

public static final CoreCache UPGRADE_HISTORY

FINALIZED_BUILD_NUMBER

public static final CoreCache FINALIZED_BUILD_NUMBER

USER_ID_BY_USER_KEY

public static final CoreCache USER_ID_BY_USER_KEY

USER_KEY_BY_USER_NAME

public static final CoreCache USER_KEY_BY_USER_NAME

USER_PROPERTY_SETS

public static final CoreCache USER_PROPERTY_SETS

USER_PROPERTY_SET_REFERENCES

public static final CoreCache USER_PROPERTY_SET_REFERENCES

VELOCITY_RESOURCES

public static final CoreCache VELOCITY_RESOURCES

Method Detail

values

public static CoreCache[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (CoreCache c : CoreCache.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static CoreCache valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

resolve

public <T> T resolve(Function<String,T> resolver)

Resolves this cache using a function which takes the systemCacheName.

getCache

public <K,V> com.atlassian.cache.Cache<K,V> getCache(com.atlassian.cache.CacheFactory cacheFactory)

Convenince method that resolves this cache against an Atlassian Cache CacheFactory.