/**
* Copyright (C) 2012 - present by OpenGamma Inc. and the OpenGamma group of companies
*
* Please see distribution for license.
*/
package com.opengamma.master.region.impl;
import java.util.ArrayList;
import java.util.List;
import org.joda.beans.Bean;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import com.opengamma.id.UniqueId;
import com.opengamma.master.cache.AbstractEHCachingMaster;
import com.opengamma.master.cache.EHCachingSearchCache;
import com.opengamma.master.region.RegionDocument;
import com.opengamma.master.region.RegionHistoryRequest;
import com.opengamma.master.region.RegionHistoryResult;
import com.opengamma.master.region.RegionMaster;
import com.opengamma.master.region.RegionSearchRequest;
import com.opengamma.master.region.RegionSearchResult;
import com.opengamma.util.paging.Paging;
import com.opengamma.util.paging.PagingRequest;
import com.opengamma.util.tuple.ObjectsPair;
import net.sf.ehcache.CacheManager;
/**
* A cache decorating a {@code RegionMaster}, mainly intended to reduce the frequency and repetition of queries
* from the management UI to a {@code DbRegionMaster}. In particular, prefetching is employed in paged queries,
* which tend to scale poorly.
* <p>
* The cache is implemented using {@code EHCache}.
*/
public class EHCachingRegionMaster extends AbstractEHCachingMaster<RegionDocument> implements RegionMaster {
/** Logger. */
private static final Logger s_logger = LoggerFactory.getLogger(EHCachingRegionMaster.class);
/** The document search cache */
private EHCachingSearchCache _documentSearchCache;
/** The history search cache */
private EHCachingSearchCache _historySearchCache;
/**
* Creates an instance over an underlying source specifying the cache manager.
*
* @param name the cache name, not empty
* @param underlying the underlying region source, not null
* @param cacheManager the cache manager, not null
*/
public EHCachingRegionMaster(final String name, final RegionMaster underlying, final CacheManager cacheManager) {
super(name + "Region", underlying, cacheManager);
// Create the doc search cache and register a region master searcher
_documentSearchCache = new EHCachingSearchCache(name + "Region", cacheManager, new EHCachingSearchCache.Searcher() {
@Override
public ObjectsPair<Integer, List<UniqueId>> search(Bean request, PagingRequest pagingRequest) {
// Fetch search results from underlying master
RegionSearchResult result = ((RegionMaster) getUnderlying()).search((RegionSearchRequest)
EHCachingSearchCache.withPagingRequest((RegionSearchRequest) request, pagingRequest));
// Cache the result documents
EHCachingSearchCache.cacheDocuments(result.getDocuments(), getUidToDocumentCache());
// Return the list of result UniqueIds
return new ObjectsPair<>(result.getPaging().getTotalItems(),
EHCachingSearchCache.extractUniqueIds(result.getDocuments()));
}
});
// Create the history search cache and register a security master searcher
_historySearchCache = new EHCachingSearchCache(name + "RegionHistory", cacheManager, new EHCachingSearchCache.Searcher() {
@Override
public ObjectsPair<Integer, List<UniqueId>> search(Bean request, PagingRequest pagingRequest) {
// Fetch search results from underlying master
RegionHistoryResult result = ((RegionMaster) getUnderlying()).history((RegionHistoryRequest)
EHCachingSearchCache.withPagingRequest((RegionHistoryRequest) request, pagingRequest));
// Cache the result documents
EHCachingSearchCache.cacheDocuments(result.getDocuments(), getUidToDocumentCache());
// Return the list of result UniqueIds
return new ObjectsPair<>(result.getPaging().getTotalItems(),
EHCachingSearchCache.extractUniqueIds(result.getDocuments()));
}
});
// Prime document search cache
RegionSearchRequest defaultSearch = new RegionSearchRequest();
_documentSearchCache.prefetch(defaultSearch, PagingRequest.FIRST_PAGE);
}
@Override
public RegionSearchResult search(RegionSearchRequest request) {
// Ensure that the relevant prefetch range is cached, otherwise fetch and cache any missing sub-ranges in background
_documentSearchCache.prefetch(EHCachingSearchCache.withPagingRequest(request, null), request.getPagingRequest());
// Fetch the paged request range; if not entirely cached then fetch and cache it in foreground
ObjectsPair<Integer, List<UniqueId>> pair = _documentSearchCache.search(
EHCachingSearchCache.withPagingRequest(request, null),
request.getPagingRequest(), false); // don't block until cached
List<RegionDocument> documents = new ArrayList<>();
for (UniqueId uniqueId : pair.getSecond()) {
documents.add(get(uniqueId));
}
RegionSearchResult result = new RegionSearchResult(documents);
result.setPaging(Paging.of(request.getPagingRequest(), pair.getFirst()));
// Debug: check result against underlying
if (EHCachingSearchCache.TEST_AGAINST_UNDERLYING) {
RegionSearchResult check = ((RegionMaster) getUnderlying()).search(request);
if (!result.getPaging().equals(check.getPaging())) {
s_logger.error("_documentSearchCache.getCache().getName() + \" returned paging:\\n\"" + result.getPaging() +
"\nbut the underlying master returned paging:\n" + check.getPaging());
}
if (!result.getDocuments().equals(check.getDocuments())) {
s_logger.error(_documentSearchCache.getCache().getName() + " returned documents:\n" + result.getDocuments() +
"\nbut the underlying master returned documents:\n" + check.getDocuments());
}
}
return result;
}
@Override
public RegionHistoryResult history(RegionHistoryRequest request) {
// Ensure that the relevant prefetch range is cached, otherwise fetch and cache any missing sub-ranges in background
_historySearchCache.prefetch(EHCachingSearchCache.withPagingRequest(request, null), request.getPagingRequest());
// Fetch the paged request range; if not entirely cached then fetch and cache it in foreground
ObjectsPair<Integer, List<UniqueId>> pair = _historySearchCache.search(
EHCachingSearchCache.withPagingRequest(request, null),
request.getPagingRequest(), false); // don't block until cached
List<RegionDocument> documents = new ArrayList<>();
for (UniqueId uniqueId : pair.getSecond()) {
documents.add(get(uniqueId));
}
RegionHistoryResult result = new RegionHistoryResult(documents);
result.setPaging(Paging.of(request.getPagingRequest(), pair.getFirst()));
return result;
}
}