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(ChangeMetadata changeMetadata, String testName, TestDefinition testDefinition, Map<String,String> metadata) Add new test definition to this store.
boolean	cleanUserWorkspace(String username)
void	close()
void	deleteTestDefinition(ChangeMetadata changeMetadata, String previousVersion, String testName, TestDefinition testDefinition)
Map<String,List<Revision>>	getAllHistories() Get all the revisions for all tests in history Same revision may appear in two or more lists if multiple tests are modified in the revision.
TestDefinition	getCurrentTestDefinition(String test)
TestMatrixVersion	getCurrentTestMatrix()
List<Revision>	getHistory(String test, int start, int limit)
List<Revision>	getHistory(String test, String revision, int start, int limit)
String	getLatestVersion()
List<Revision>	getMatrixHistory(Instant start, Instant limit)
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)
TestDefinition	getTestDefinition(String test, String fetchRevision)
List<TestEdit>	getTestEdits(String testName, int start, int limit)
List<TestEdit>	getTestEdits(String testName, String revision, int start, int limit)
TestMatrixVersion	getTestMatrix(String fetchRevision)
void	refresh() Update the local state with the remote database.
static <T> List<T>	selectHistorySet(List<T> histories, int start, int limit) Deprecated. Please use HistoryUtil.selectHistorySet(List, int, int)
static List<Revision>	selectRevisionHistorySetFrom(List<Revision> history, String from, int start, int limit) Deprecated. Please use HistoryUtil.selectRevisionHistorySetFrom(List, String, int, int)
void	updateTestDefinition(ChangeMetadata changeMetadata, String previousVersion, String testName, TestDefinition testDefinition, Map<String,String> metadata) 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

Methods inherited from interface com.indeed.proctor.store.ProctorWriter

addTestDefinition, addTestDefinition, deleteTestDefinition, deleteTestDefinition, updateTestDefinition, updateTestDefinition

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

Specified by:

getCurrentTestMatrix in interface ProctorReader

Returns:

the current test matrix in the database.

Throws:

StoreException

getCurrentTestDefinition

public TestDefinition getCurrentTestDefinition(String test)
                                        throws StoreException

Specified by:

getCurrentTestDefinition in interface ProctorReader

Parameters:

test - name of the test.

Returns:

a current test definition of a test in the database. null if the test is not found in the current state.

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

Specified by:

getLatestVersion in interface ProctorReader

Returns:

the latest revision id.

Throws:

StoreException

getTestMatrix

public TestMatrixVersion getTestMatrix(String fetchRevision)
                                throws StoreException

Specified by:

getTestMatrix in interface ProctorReader

Parameters:

fetchRevision - id of the revision

Returns:

a test matrix when the revision was made.

Throws:

StoreException - if the revision is not found.

getTestDefinition

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

Specified by:

getTestDefinition in interface ProctorReader

Parameters:

test - name of the test

fetchRevision - id of the revision

Returns:

a test definition of a test when the revision was made. null if the test is not found at the revision

Throws:

StoreException - if the revision is not found.

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, -1 might be usable for unlimited (depending on implementation)

Returns:

a list of revisions for all tests ordered by recency.

Throws:

StoreException

getMatrixHistory

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

Specified by:

getMatrixHistory in interface ProctorReader

Parameters:

start - earliest date

limit - latest date

Returns:

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

Throws:

StoreException - if the revision is not found, or date range is bigger than the implementation allows

getHistory

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

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, -1 might be usable for unlimited (depending on implementation)

Returns:

a list of revisions for a test ordered by recency.

Throws:

StoreException

getHistory

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

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, -1 might be usable for unlimited (depending on implementation)

Returns:

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

Throws:

StoreException - if the revision is not found.

getRevisionDetails

@CheckForNull
public RevisionDetails getRevisionDetails(String revisionId)
                                                 throws StoreException

Specified by:

getRevisionDetails in interface ProctorReader

Parameters:

revisionId - id of the revision

Returns:

details of the single revision. null if the revision is not found in the store.

Throws:

StoreException

getTestEdits

@Nonnull
public List<TestEdit> getTestEdits(String testName,
                                            int start,
                                            int limit)
                                     throws StoreException

Specified by:

getTestEdits in interface ProctorReader

Parameters:

testName - to get test edits

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

limit - limit of the number of test edits

Returns:

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

Throws:

StoreException - if the revision is not found

getTestEdits

@Nonnull
public List<TestEdit> getTestEdits(String testName,
                                            String revision,
                                            int start,
                                            int limit)
                                     throws StoreException

Specified by:

getTestEdits in interface ProctorReader

Parameters:

testName - to get test edits

revision - from which the search of test edit is initiated

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

limit - limit of the number of test edits

Returns:

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

Throws:

StoreException - if the revision is not found

getAllHistories

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

Description copied from interface: ProctorReader

Get all the revisions for all tests in history Same revision may appear in two or more lists if multiple tests are modified in the revision.

Specified by:

getAllHistories in interface ProctorReader

Returns:

a list of revisions grouped by a test. Each list is ordered by recency.

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(ChangeMetadata changeMetadata,
                                 String previousVersion,
                                 String testName,
                                 TestDefinition testDefinition,
                                 Map<String,String> metadata)
                          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

deleteTestDefinition

public void deleteTestDefinition(ChangeMetadata changeMetadata,
                                 String previousVersion,
                                 String testName,
                                 TestDefinition testDefinition)
                          throws StoreException.TestUpdateException

Specified by:

deleteTestDefinition in interface ProctorWriter

Throws:

StoreException.TestUpdateException - when

addTestDefinition

public void addTestDefinition(ChangeMetadata changeMetadata,
                              String testName,
                              TestDefinition testDefinition,
                              Map<String,String> metadata)
                       throws StoreException.TestUpdateException

Description copied from interface: ProctorWriter

Add new test definition to this store. Fails with Exception when testName already exists

Specified by:

addTestDefinition in interface ProctorWriter

Throws:

StoreException.TestUpdateException - on invalid inputs

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