Package com.atlassian.jira.issue.search

Class CachingSearchRequestStore

java.lang.Object

com.atlassian.jira.issue.search.CachingSearchRequestStore

All Implemented Interfaces:

InitializingComponent, SearchRequestStore

public class CachingSearchRequestStore
extends Object
implements SearchRequestStore, InitializingComponent

Caching store for SearchRequest.

Since:

v3.13

Constructor Summary

Constructors

Constructor	Description
CachingSearchRequestStore(SearchRequestStore delegateStore, com.atlassian.cache.CacheManager cacheManager)

Method Summary

Modifier and Type	Method	Description
SearchRequest	adjustFavouriteCount(Long searchRequestId, int incrementValue)	Updates the favourite count of the SearchRequest in the database.
void	afterInstantiation()	Called after all the beans are constructed and the ApplicationContext is fully populated.
protected void	clearCache()
SearchRequest	create(SearchRequest request)	Takes a SearchRequest, user, name of search request and description and persists the XML representation of the SearchRequest object to the database along with the rest of the details
void	delete(Long searchId)	Removes the SearchRequest GenericValue from the database based on its id
List<SearchRequest>	findByNameIgnoreCase(String name)	Find search requests matching the given name.
EnclosedIterable<SearchRequest>	get(SharedEntityAccessor.RetrievalDescriptor descriptor)	Get a EnclosedIterable of SearchRequests for the specified List of ids.
EnclosedIterable<SearchRequest>	getAll()	Get a EnclosedIterable of all SearchRequests in the database.
EnclosedIterable<IndexableSharedEntity<SearchRequest>>	getAllIndexableSharedEntities()	Get a EnclosedIterable of all IndexableSharedEntities representing SearchRequests in the database.
Collection<SearchRequest>	getAllOwnedSearchRequests(ApplicationUser owner)	Retrieves a collection of SearchRequest objects that a user created.
Collection<SearchRequest>	getAllOwnedSearchRequests(String userKey)	Retrieves a collection of SearchRequest objects that a user created.
SearchRequest	getRequestByAuthorAndName(ApplicationUser author, String name)	Find a search request given the author and the request name.
SearchRequest	getSearchRequest(Long searchRequestId)	Return the search request as stored in the database
EnclosedIterable<SearchRequest>	getSearchRequests(com.atlassian.crowd.embedded.api.Group group)	Get all search requests associated with a given Group.
EnclosedIterable<SearchRequest>	getSearchRequests(Project project)	Get all search requests associate with a given Project.
void	onClearCache(ClearCacheEvent event)
void	onSearchRequestUserFKChangedEvent(SearchRequestUserFKChangedEvent event)
SearchRequest	update(SearchRequest request)	Updates an existing search request in the database.
void	visitAll(Visitor<SearchRequestEntity> visitor)

Methods inherited from class java.lang.Object

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

Constructor Details

CachingSearchRequestStore

public CachingSearchRequestStore(SearchRequestStore delegateStore,
 com.atlassian.cache.CacheManager cacheManager)

Method Details

afterInstantiation

public void afterInstantiation()
                        throws Exception

Description copied from interface: InitializingComponent

Called after all the beans are constructed and the ApplicationContext is fully populated. Order of execution is order of bean creation, driven by InitializingComponentProcessor.

Specified by:

afterInstantiation in interface InitializingComponent

Throws:

Exception

onClearCache

@EventListener
public void onClearCache(ClearCacheEvent event)

onSearchRequestUserFKChangedEvent

@EventListener
public void onSearchRequestUserFKChangedEvent(SearchRequestUserFKChangedEvent event)

clearCache

protected void clearCache()

get

public EnclosedIterable<SearchRequest> get(SharedEntityAccessor.RetrievalDescriptor descriptor)

Description copied from interface: SearchRequestStore

Get a EnclosedIterable of SearchRequests for the specified List of ids.

Specified by:

get in interface SearchRequestStore

Parameters:

descriptor - retrieval descriptor

Returns:

CloseableIterable that contains reference to SearchRequests with the specified ids.

getAll

public EnclosedIterable<SearchRequest> getAll()

Description copied from interface: SearchRequestStore

Get a EnclosedIterable of all SearchRequests in the database.

Specified by:

getAll in interface SearchRequestStore

Returns:

CloseableIterable that contains reference to all SearchRequests.

visitAll

public void visitAll(Visitor<SearchRequestEntity> visitor)

Specified by:

visitAll in interface SearchRequestStore

getAllIndexableSharedEntities

public EnclosedIterable<IndexableSharedEntity<SearchRequest>> getAllIndexableSharedEntities()

Description copied from interface: SearchRequestStore

Get a EnclosedIterable of all IndexableSharedEntities representing SearchRequests in the database.

Note: this is used so that we can retrieve all the meta data about a SearchRequest without having to deal with the Query.

Specified by:

getAllIndexableSharedEntities in interface SearchRequestStore

Returns:

CloseableIterable that contains reference to all IndexableSharedEntities representing SearchRequests.

getAllOwnedSearchRequests

public Collection<SearchRequest> getAllOwnedSearchRequests(ApplicationUser owner)

Description copied from interface: SearchRequestStore

Retrieves a collection of SearchRequest objects that a user created.

Specified by:

getAllOwnedSearchRequests in interface SearchRequestStore

Parameters:

owner - The user who created the SearchRequests

Returns:

Collection of all SearchRequest that user created.

getAllOwnedSearchRequests

public Collection<SearchRequest> getAllOwnedSearchRequests(String userKey)

Description copied from interface: SearchRequestStore

Retrieves a collection of SearchRequest objects that a user created.

Specified by:

getAllOwnedSearchRequests in interface SearchRequestStore

Parameters:

userKey - The key of the user who created the SearchRequests

Returns:

Collection of all SearchRequest that user created.

getRequestByAuthorAndName

public SearchRequest getRequestByAuthorAndName(ApplicationUser author,
 String name)

Description copied from interface: SearchRequestStore

Find a search request given the author and the request name.

Specified by:

getRequestByAuthorAndName in interface SearchRequestStore

Parameters:

author - Author of the SearchRequest

name - Name of the SearchRequest

Returns:

The SearchRequest, or null if there is no matching request

getSearchRequest

public SearchRequest getSearchRequest(@Nonnull
 Long searchRequestId)

Description copied from interface: SearchRequestStore

Return the search request as stored in the database

Specified by:

getSearchRequest in interface SearchRequestStore

Parameters:

searchRequestId - Id of the SearchRequest

Returns:

The SearchRequest, or null if the request id does not exist

create

public SearchRequest create(@Nonnull
 SearchRequest request)

Description copied from interface: SearchRequestStore

Takes a SearchRequest, user, name of search request and description and persists the XML representation of the SearchRequest object to the database along with the rest of the details

Specified by:

create in interface SearchRequestStore

Parameters:

request - SearchResult that should be persisted

Returns:

SearchRequest object that was persisted to the database

update

public SearchRequest update(@Nonnull
 SearchRequest request)

Description copied from interface: SearchRequestStore

Updates an existing search request in the database.

Specified by:

update in interface SearchRequestStore

Parameters:

request - the request to persist.

Returns:

A SearchRequest that was persisted to the database

adjustFavouriteCount

public SearchRequest adjustFavouriteCount(@Nonnull
 Long searchRequestId,
 int incrementValue)

Description copied from interface: SearchRequestStore

Updates the favourite count of the SearchRequest in the database.

Specified by:

adjustFavouriteCount in interface SearchRequestStore

Parameters:

searchRequestId - the identifier of the search request to decrease.

incrementValue - the value to increase the favourite count by. Can be a number invalid input: '<' 0 to decrease the favourite count.

Returns:

the updated SearchRequest.

delete

public void delete(@Nonnull
 Long searchId)

Description copied from interface: SearchRequestStore

Removes the SearchRequest GenericValue from the database based on its id

Specified by:

delete in interface SearchRequestStore

Parameters:

searchId - of the search request to be removed from storage

getSearchRequests

public EnclosedIterable<SearchRequest> getSearchRequests(Project project)

Description copied from interface: SearchRequestStore

Get all search requests associate with a given Project.

Specified by:

getSearchRequests in interface SearchRequestStore

Parameters:

project - Project that is associated with the filters

Returns:

Collection of SearchRequest that have their project set to the given project

findByNameIgnoreCase

@Nonnull
public List<SearchRequest> findByNameIgnoreCase(String name)

Description copied from interface: SearchRequestStore

Find search requests matching the given name.

Specified by:

findByNameIgnoreCase in interface SearchRequestStore

Parameters:

name - Name of the SearchRequest

Returns:

List of all search requests matching the given name. Never null.

getSearchRequests

public EnclosedIterable<SearchRequest> getSearchRequests(com.atlassian.crowd.embedded.api.Group group)

Description copied from interface: SearchRequestStore

Get all search requests associated with a given Group.

Specified by:

getSearchRequests in interface SearchRequestStore

Parameters:

group - the group that is associated with the filters

Returns:

Collection of SearchRequest that have their project set to the given project