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() Returns a list of revisions grouped by a test.
TestDefinition	getCurrentTestDefinition(String testName) 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 testName, int start, int limit) Returns a list of revisions for a test ordered by recency.
List<Revision>	getHistory(String testName, String revisionId, 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) Returns a list of revisions for all tests ordered by recency.
RevisionDetails	getRevisionDetails(String revisionId) Returns a details of a single revision.
TestDefinition	getTestDefinition(String testName, String revisionId) Returns a test definition of a test when the revision was made.
TestMatrixVersion	getTestMatrix(String revisionId) Returns a test matrix when the revision was made.
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

TestDefinition getCurrentTestDefinition(String testName)
                                 throws StoreException

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

Parameters:

testName - name of the test

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

Returns a test matrix when the revision was made.

Parameters:

revisionId - id of the revision

Throws:

StoreException

getTestDefinition

TestDefinition getTestDefinition(String testName,
                                 String revisionId)
                          throws StoreException

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

Parameters:

testName - name of the test

revisionId - id of the revision

Throws:

StoreException

getMatrixHistory

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

Returns a list of revisions for all tests ordered by recency.

Parameters:

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

limit - limit of the number of revisions

Throws:

StoreException

getHistory

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

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

Parameters:

testName - name of the test

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

limit - limit of the number of revisions

Throws:

StoreException

getHistory

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

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

Parameters:

testName - name of the test

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

limit - limit of the number of revisions

Throws:

StoreException

getRevisionDetails

@CheckForNull
RevisionDetails getRevisionDetails(String revisionId)
                                          throws StoreException

Returns a details of a single revision.

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

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.

Returns:

Map from test name to a list of revision.

Throws:

StoreException

refresh

void refresh()
      throws StoreException

Update the local state with the remote database.

Throws:

StoreException