com.indeed.proctor.store

Interface ProctorReader

All Known Subinterfaces:

ProctorStore

All Known Implementing Classes:

CachingProctorStore, FileBasedProctorStore, InMemoryProctorStore, LocalDirectoryStore

public interface ProctorReader

Read interface of Proctor Store. It provides read access to test definitions and their histories in the database. Each store has a single global linear history of states, each having a unique revision id. All methods throws StoreException when it failed to handle request because of errors in the database.

Author:

parker

Method Summary

Modifier and Type	Method and Description
Map<String,List<Revision>>	getAllHistories() Deprecated. does not scale, avoid if possible, prefer getMatrixHistory and getRevisionDetails methods
TestDefinition	getCurrentTestDefinition(String testName)
TestMatrixVersion	getCurrentTestMatrix()
List<Revision>	getHistory(String testName, int start, int limit)
List<Revision>	getHistory(String testName, String revisionId, int start, int limit)
String	getLatestVersion()
List<Revision>	getMatrixHistory(Instant sinceInclusive, Instant untilExclusive)
List<Revision>	getMatrixHistory(int start, int limit)
RevisionDetails	getRevisionDetails(String revisionId)
TestDefinition	getTestDefinition(String testName, String revisionId)
List<TestEdit>	getTestEdits(String testName, int start, int limit)
List<TestEdit>	getTestEdits(String testName, String revision, int start, int limit)
TestMatrixVersion	getTestMatrix(String revisionId)
void	refresh() Update the local state with the remote database.
void	verifySetup() Verifies the data store object is ready to operate.

Method Detail

getCurrentTestMatrix

TestMatrixVersion getCurrentTestMatrix()
                                throws StoreException

Returns:

the current test matrix in the database.

Throws:

StoreException

getCurrentTestDefinition

@CheckForNull
TestDefinition getCurrentTestDefinition(String testName)
                                               throws StoreException

Parameters:

testName - 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

void verifySetup()
          throws StoreException

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

Throws:

StoreException - if it's not ready to operate.

getLatestVersion

@Nonnull
String getLatestVersion()
                          throws StoreException

Returns:

the latest revision id.

Throws:

StoreException

getTestMatrix

TestMatrixVersion getTestMatrix(String revisionId)
                         throws StoreException

Parameters:

revisionId - id of the revision

Returns:

a test matrix when the revision was made.

Throws:

StoreException - if the revision is not found.

getTestDefinition

@CheckForNull
TestDefinition getTestDefinition(String testName,
                                               String revisionId)
                                        throws StoreException

Parameters:

testName - name of the test

revisionId - 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
List<Revision> getMatrixHistory(int start,
                                         int limit)
                                  throws StoreException

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
List<Revision> getMatrixHistory(Instant sinceInclusive,
                                         Instant untilExclusive)
                                  throws StoreException

Parameters:

sinceInclusive - earliest date

untilExclusive - 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
List<Revision> getHistory(String testName,
                                   int start,
                                   int limit)
                            throws StoreException

Parameters:

testName - 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
List<Revision> getHistory(String testName,
                                   String revisionId,
                                   int start,
                                   int limit)
                            throws StoreException

Parameters:

testName - 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
RevisionDetails getRevisionDetails(String revisionId)
                                          throws StoreException

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
List<TestEdit> getTestEdits(String testName,
                                     int start,
                                     int limit)
                              throws StoreException

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
List<TestEdit> getTestEdits(String testName,
                                     String revision,
                                     int start,
                                     int limit)
                              throws StoreException

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
 @Deprecated
Map<String,List<Revision>> getAllHistories()
                                                          throws StoreException

Deprecated. does not scale, avoid if possible, prefer getMatrixHistory and getRevisionDetails methods

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.

Returns:

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

Throws:

StoreException

refresh

void refresh()
      throws StoreException

Update the local state with the remote database.

Throws:

StoreException