com.atlassian.jira.cache.request.context

Class MapBasedRequestCacheContext

java.lang.Object

com.atlassian.jira.cache.request.context.MapBasedRequestCacheContext

All Implemented Interfaces:

RequestCacheContext

public class MapBasedRequestCacheContext
extends Object
implements RequestCacheContext

Constructor Summary

Constructors

Constructor and Description
MapBasedRequestCacheContext(java.util.function.Supplier<Map<Object,Object>> mapSupplier, Runnable cleaningCallback)

Method Summary

Modifier and Type	Method and Description
void	clearAll() Clears all local storage for this thread.
void	clearLocalMap(RequestCache<?,?> requestCache) Clears a specific request cache's local storage for this thread.
void	close() Should be called to indicate the attempt to stop the context.
Map<Object,Object>	getLocalMap(RequestCache<?,?> requestCache) Returns the request-scoped storage for the given request cache.
Map<Object,Object>	getLocalMapIfExists(RequestCache<?,?> requestCache) Returns the request-scoped storage for the given request cache, if it exists.
void	markValueLoading() Mark the success of adding the value to map returned by RequestCacheContext.getLocalMap(RequestCache) or RequestCacheContext.getLocalMapIfExists(RequestCache)
void	open() Should be called to indicate the start of the context.

Methods inherited from class java.lang.Object

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

Constructor Detail

MapBasedRequestCacheContext

public MapBasedRequestCacheContext(java.util.function.Supplier<Map<Object,Object>> mapSupplier,
                                   Runnable cleaningCallback)

Parameters:

mapSupplier - supplier for map returned by getLocalMap(RequestCache) and getLocalMapIfExists(RequestCache)

cleaningCallback - callback executed during close()

Method Detail

getLocalMap

@Nonnull
public Map<Object,Object> getLocalMap(RequestCache<?,?> requestCache)

Description copied from interface: RequestCacheContext

Returns the request-scoped storage for the given request cache. If that storage does not already exist, then one is created.

Specified by:

getLocalMap in interface RequestCacheContext

Parameters:

requestCache - the cache for which to locate

Returns:

the local storage corresponding to the given request cache

getLocalMapIfExists

@Nullable
public Map<Object,Object> getLocalMapIfExists(RequestCache<?,?> requestCache)

Description copied from interface: RequestCacheContext

Returns the request-scoped storage for the given request cache, if it exists.

Specified by:

getLocalMapIfExists in interface RequestCacheContext

Parameters:

requestCache - the cache for which to locate

Returns:

the local storage corresponding to the given request cache, if it already exists; otherwise null.

clearAll

public void clearAll()

Description copied from interface: RequestCacheContext

Clears all local storage for this thread. Any request caches that belong to other threads are not affected by this.

Specified by:

clearAll in interface RequestCacheContext

clearLocalMap

public void clearLocalMap(RequestCache<?,?> requestCache)

Description copied from interface: RequestCacheContext

Clears a specific request cache's local storage for this thread. Any request caches that belong to other threads are not affected by this.

Specified by:

clearLocalMap in interface RequestCacheContext

Parameters:

requestCache - the cache for which to clear the current thread's local storage

open

public void open()

Description copied from interface: RequestCacheContext

Should be called to indicate the start of the context. Can be called multiple times. Calls to this method must be paired with the same number of calls to RequestCacheContext.close()

Specified by:

open in interface RequestCacheContext

close

public void close()

Description copied from interface: RequestCacheContext

Should be called to indicate the attempt to stop the context. Calls to this method must be paired with the same number of calls to RequestCacheContext.open()

Specified by:

close in interface RequestCacheContext

markValueLoading

public void markValueLoading()

Description copied from interface: RequestCacheContext

Mark the success of adding the value to map returned by RequestCacheContext.getLocalMap(RequestCache) or RequestCacheContext.getLocalMapIfExists(RequestCache)

Specified by:

markValueLoading in interface RequestCacheContext