/**
* Copyright (C) 2012 - present by OpenGamma Inc. and the OpenGamma group of companies
*
* Please see distribution for license.
*/
package com.opengamma.master.position.impl;
import java.util.ArrayList;
import java.util.List;
import org.joda.beans.Bean;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.threeten.bp.Instant;
import com.opengamma.id.UniqueId;
import com.opengamma.id.VersionCorrection;
import com.opengamma.master.cache.AbstractEHCachingMaster;
import com.opengamma.master.cache.EHCachingSearchCache;
import com.opengamma.master.position.ManageableTrade;
import com.opengamma.master.position.PositionDocument;
import com.opengamma.master.position.PositionHistoryRequest;
import com.opengamma.master.position.PositionHistoryResult;
import com.opengamma.master.position.PositionMaster;
import com.opengamma.master.position.PositionSearchRequest;
import com.opengamma.master.position.PositionSearchResult;
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 PositionMaster}, mainly intended to reduce the frequency and repetition of queries
* from the management UI to a {@code DbPositionMaster}.
* <p>
* The cache is implemented using {@code EHCache}.
*/
public class EHCachingPositionMaster extends AbstractEHCachingMaster<PositionDocument> implements PositionMaster {
/** Logger. */
private static final Logger s_logger = LoggerFactory.getLogger(EHCachingPositionMaster.class);
/** The document search cache */
private EHCachingSearchCache _documentSearchCache;
/** The history search cache */
private EHCachingSearchCache _historySearchCache;
/**
* Creates an instance over an underlying master specifying the cache manager.
*
* @param name the cache name, not null
* @param underlying the underlying Position master, not null
* @param cacheManager the cache manager, not null
*/
public EHCachingPositionMaster(final String name, final PositionMaster underlying, final CacheManager cacheManager) {
super(name + "Position", underlying, cacheManager);
// Create the doc search cache and register a position master searcher
_documentSearchCache = new EHCachingSearchCache(name + "Position", cacheManager, new EHCachingSearchCache.Searcher() {
@Override
public ObjectsPair<Integer, List<UniqueId>> search(Bean request, PagingRequest pagingRequest) {
// Fetch search results from underlying master
PositionSearchResult result = ((PositionMaster) getUnderlying()).search((PositionSearchRequest)
EHCachingSearchCache.withPagingRequest(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 + "PositionHistory", cacheManager, new EHCachingSearchCache.Searcher() {
@Override
public ObjectsPair<Integer, List<UniqueId>> search(Bean request, PagingRequest pagingRequest) {
// Fetch search results from underlying master
PositionHistoryResult result = ((PositionMaster) getUnderlying()).history((PositionHistoryRequest)
EHCachingSearchCache.withPagingRequest(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 search cache
PositionSearchRequest defaultSearch = new PositionSearchRequest();
_documentSearchCache.prefetch(defaultSearch, PagingRequest.FIRST_PAGE);
}
@Override
public ManageableTrade getTrade(UniqueId tradeId) {
return ((PositionMaster) getUnderlying()).getTrade(tradeId);
}
@Override
public PositionSearchResult search(PositionSearchRequest 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<PositionDocument> documents = new ArrayList<>();
for (UniqueId uniqueId : pair.getSecond()) {
documents.add(get(uniqueId));
}
PositionSearchResult result = new PositionSearchResult(documents);
result.setPaging(Paging.of(request.getPagingRequest(), pair.getFirst()));
final VersionCorrection vc = request.getVersionCorrection().withLatestFixed(Instant.now());
result.setVersionCorrection(vc);
// Debug: check result against underlying
if (EHCachingSearchCache.TEST_AGAINST_UNDERLYING) {
PositionSearchResult check = ((PositionMaster) getUnderlying()).search(request);
if (!result.getPaging().equals(check.getPaging())) {
s_logger.error(_documentSearchCache.getCache().getName()
+ "\n\tCache:\t" + result.getPaging()
+ "\n\tUnderlying:\t" + check.getPaging());
}
if (!result.getDocuments().equals(check.getDocuments())) {
System.out.println(_documentSearchCache.getCache().getName() + ": ");
if (check.getDocuments().size() != result.getDocuments().size()) {
System.out.println("\tSizes differ (Underlying " + check.getDocuments().size()
+ "; Cache " + result.getDocuments().size() + ")");
} else {
for (int i = 0; i < check.getDocuments().size(); i++) {
if (!check.getDocuments().get(i).equals(result.getDocuments().get(i))) {
System.out.println("\tUnderlying\t" + i + ":\t" + check.getDocuments().get(i).getUniqueId());
}
}
}
}
}
return result;
}
@Override
public PositionHistoryResult history(PositionHistoryRequest 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<PositionDocument> documents = new ArrayList<>();
for (UniqueId uniqueId : pair.getSecond()) {
documents.add(get(uniqueId));
}
PositionHistoryResult result = new PositionHistoryResult(documents);
result.setPaging(Paging.of(request.getPagingRequest(), pair.getFirst()));
return result;
}
}