com.indeed.proctor.store.cache

Class CachingProctorStore

java.lang.Object

com.indeed.proctor.store.cache.CachingProctorStore

All Implemented Interfaces:

ProctorReader, ProctorStore, ProctorWriter, Closeable, AutoCloseable

public class CachingProctorStore
extends Object
implements ProctorStore

A decorator class for ProctorStore. This class caches result of read methods and invalidates cache on add/update/delete methods

Author:

yiqing

Constructor Summary

Constructors

Constructor and Description
CachingProctorStore(ProctorStore delegate)

Method Summary

Modifier and Type	Method and Description
void	addTestDefinition(String username, String password, String author, String testName, TestDefinition testDefinition, Map<String,String> metadata, String comment)
void	addTestDefinition(String username, String password, String testName, TestDefinition testDefinition, Map<String,String> metadata, String comment)
boolean	cleanUserWorkspace(String username)
void	close()
void	deleteTestDefinition(String username, String password, String author, String previousVersion, String testName, TestDefinition testDefinition, String comment)
void	deleteTestDefinition(String username, String password, String previousVersion, String testName, TestDefinition testDefinition, String comment)
Map<String,List<Revision>>	getAllHistories() Returns a list of revisions grouped by a test.
TestDefinition	getCurrentTestDefinition(String test) Returns a current test definition of a test in the database.
TestMatrixVersion	getCurrentTestMatrix() Returns the current test matrix in the database.
List<Revision>	getHistory(String test, int start, int limit) Returns a list of revisions for a test ordered by recency.
List<Revision>	getHistory(String test, String revision, int start, int limit) Returns a list of revisions for a test when test revision was made ordered by recency.
String	getLatestVersion() Returns the latest revision id.
List<Revision>	getMatrixHistory(int start, int limit) caching is not supported for this method
String	getName() This method returns a name of the ProctorStore instance for logging purpose.
RevisionDetails	getRevisionDetails(String revisionId) Returns a details of a single revision.
TestDefinition	getTestDefinition(String test, String fetchRevision) Returns a test definition of a test when the revision was made.
TestMatrixVersion	getTestMatrix(String fetchRevision) Returns a test matrix when the revision was made.
void	refresh() Update the local state with the remote database.
static <T> List<T>	selectHistorySet(List<T> histories, int start, int limit) Deprecated.
static List<Revision>	selectRevisionHistorySetFrom(List<Revision> history, String from, int start, int limit) Deprecated.
void	updateTestDefinition(String username, String password, String author, String previousVersion, String testName, TestDefinition testDefinition, Map<String,String> metadata, String comment)
void	updateTestDefinition(String username, String password, String previousVersion, String testName, TestDefinition testDefinition, Map<String,String> metadata, String comment) Following three methods make side-effect and it would trigger cache refreshing at once
void	verifySetup() Verifies the data store object is ready to operate.

Methods inherited from class java.lang.Object

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

Constructor Detail

CachingProctorStore

public CachingProctorStore(ProctorStore delegate)

Method Detail

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException

getCurrentTestMatrix

public TestMatrixVersion getCurrentTestMatrix()
                                       throws StoreException

Description copied from interface: ProctorReader

Returns the current test matrix in the database.

Specified by:

getCurrentTestMatrix in interface ProctorReader

Throws:

StoreException

getCurrentTestDefinition

public TestDefinition getCurrentTestDefinition(String test)
                                        throws StoreException

Description copied from interface: ProctorReader

Returns a current test definition of a test in the database.

Specified by:

getCurrentTestDefinition in interface ProctorReader

Parameters:

test - name of the test

Throws:

StoreException

verifySetup

public void verifySetup()
                 throws StoreException

Description copied from interface: ProctorReader

Verifies the data store object is ready to operate. Throwing an exception allows the implementer to signal bad health status.

Specified by:

verifySetup in interface ProctorReader

Specified by:

verifySetup in interface ProctorWriter

Throws:

StoreException - if it's not ready to operate.

getLatestVersion

@Nonnull
public String getLatestVersion()
                                 throws StoreException

Description copied from interface: ProctorReader

Returns the latest revision id.

Specified by:

getLatestVersion in interface ProctorReader

Throws:

StoreException

getTestMatrix

public TestMatrixVersion getTestMatrix(String fetchRevision)
                                throws StoreException

Description copied from interface: ProctorReader

Returns a test matrix when the revision was made.

Specified by:

getTestMatrix in interface ProctorReader

Parameters:

fetchRevision - id of the revision

Throws:

StoreException

getTestDefinition

public TestDefinition getTestDefinition(String test,
                                        String fetchRevision)
                                 throws StoreException

Description copied from interface: ProctorReader

Returns a test definition of a test when the revision was made.

Specified by:

getTestDefinition in interface ProctorReader

Parameters:

test - name of the test

fetchRevision - id of the revision

Throws:

StoreException

getMatrixHistory

@Nonnull
public List<Revision> getMatrixHistory(int start,
                                                int limit)
                                         throws StoreException

caching is not supported for this method

Specified by:

getMatrixHistory in interface ProctorReader

Parameters:

start - offset of the first revision (0-indexed)

limit - limit of the number of revisions

Throws:

StoreException

getHistory

@Nonnull
public List<Revision> getHistory(String test,
                                          int start,
                                          int limit)
                                   throws StoreException

Description copied from interface: ProctorReader

Returns a list of revisions for a test ordered by recency.

Specified by:

getHistory in interface ProctorReader

Parameters:

test - name of the test

start - offset of the first revision (0-indexed)

limit - limit of the number of revisions

Throws:

StoreException

getHistory

@Nonnull
public List<Revision> getHistory(String test,
                                          String revision,
                                          int start,
                                          int limit)
                                   throws StoreException

Description copied from interface: ProctorReader

Returns a list of revisions for a test when test revision was made ordered by recency.

Specified by:

getHistory in interface ProctorReader

Parameters:

test - name of the test

start - offset of the first revision (0-indexed)

limit - limit of the number of revisions

Throws:

StoreException

getRevisionDetails

@CheckForNull
public RevisionDetails getRevisionDetails(String revisionId)
                                                 throws StoreException

Description copied from interface: ProctorReader

Returns a details of a single revision.

Specified by:

getRevisionDetails in interface ProctorReader

Parameters:

revisionId - id of the revision

Returns:

details of the revision. null if the id is not found in the database.

Throws:

StoreException

getAllHistories

@Nonnull
public Map<String,List<Revision>> getAllHistories()
                                                    throws StoreException

Description copied from interface: ProctorReader

Returns a list of revisions grouped by a test. Each list is ordered by recency. Same revision may appear in two or more lists if multiple tests are modified in the revision.

Specified by:

getAllHistories in interface ProctorReader

Returns:

Map from test name to a list of revision.

Throws:

StoreException

refresh

public void refresh()
             throws StoreException

Description copied from interface: ProctorReader

Update the local state with the remote database.

Specified by:

refresh in interface ProctorReader

Throws:

StoreException

selectHistorySet

@Deprecated
public static <T> List<T> selectHistorySet(List<T> histories,
                                                       int start,
                                                       int limit)

Deprecated.

Please use HistoryUtil.selectHistorySet(List, int, int)

selectRevisionHistorySetFrom

@Deprecated
public static List<Revision> selectRevisionHistorySetFrom(List<Revision> history,
                                                                      String from,
                                                                      int start,
                                                                      int limit)

Deprecated.

Please use HistoryUtil.selectRevisionHistorySetFrom(List, String, int, int)

cleanUserWorkspace

public boolean cleanUserWorkspace(String username)

Specified by:

cleanUserWorkspace in interface ProctorWriter

updateTestDefinition

public void updateTestDefinition(String username,
                                 String password,
                                 String previousVersion,
                                 String testName,
                                 TestDefinition testDefinition,
                                 Map<String,String> metadata,
                                 String comment)
                          throws StoreException.TestUpdateException

Following three methods make side-effect and it would trigger cache refreshing at once

Specified by:

updateTestDefinition in interface ProctorWriter

Throws:

StoreException.TestUpdateException

updateTestDefinition

public void updateTestDefinition(String username,
                                 String password,
                                 String author,
                                 String previousVersion,
                                 String testName,
                                 TestDefinition testDefinition,
                                 Map<String,String> metadata,
                                 String comment)
                          throws StoreException.TestUpdateException

Specified by:

updateTestDefinition in interface ProctorWriter

Throws:

StoreException.TestUpdateException

deleteTestDefinition

public void deleteTestDefinition(String username,
                                 String password,
                                 String previousVersion,
                                 String testName,
                                 TestDefinition testDefinition,
                                 String comment)
                          throws StoreException.TestUpdateException

Specified by:

deleteTestDefinition in interface ProctorWriter

Throws:

StoreException.TestUpdateException

deleteTestDefinition

public void deleteTestDefinition(String username,
                                 String password,
                                 String author,
                                 String previousVersion,
                                 String testName,
                                 TestDefinition testDefinition,
                                 String comment)
                          throws StoreException.TestUpdateException

Specified by:

deleteTestDefinition in interface ProctorWriter

Throws:

StoreException.TestUpdateException

addTestDefinition

public void addTestDefinition(String username,
                              String password,
                              String testName,
                              TestDefinition testDefinition,
                              Map<String,String> metadata,
                              String comment)
                       throws StoreException.TestUpdateException

Specified by:

addTestDefinition in interface ProctorWriter

Throws:

StoreException.TestUpdateException

addTestDefinition

public void addTestDefinition(String username,
                              String password,
                              String author,
                              String testName,
                              TestDefinition testDefinition,
                              Map<String,String> metadata,
                              String comment)
                       throws StoreException.TestUpdateException

Specified by:

addTestDefinition in interface ProctorWriter

Throws:

StoreException.TestUpdateException

getName

public String getName()

Description copied from interface: ProctorStore

This method returns a name of the ProctorStore instance for logging purpose.

Specified by:

getName in interface ProctorStore