com.indeed.proctor.store

Class LocalDirectoryStore

java.lang.Object

com.indeed.proctor.store.FileBasedProctorStore

com.indeed.proctor.store.LocalDirectoryStore

All Implemented Interfaces:

ProctorReader, ProctorStore, ProctorWriter, Closeable, AutoCloseable

public class LocalDirectoryStore
extends FileBasedProctorStore

Nested Class Summary

Nested classes/interfaces inherited from class com.indeed.proctor.store.FileBasedProctorStore

FileBasedProctorStore.ProctorUpdater, FileBasedProctorStore.RcsClient

Field Summary

Fields inherited from class com.indeed.proctor.store.FileBasedProctorStore

core, DEFAULT_TEST_DEFINITIONS_DIRECTORY

Constructor Summary

Constructors

Constructor and Description
LocalDirectoryStore(File baseDir)
LocalDirectoryStore(File baseDir, String testDefinitionsDirectory)

Method Summary

Modifier and Type	Method and Description
boolean	cleanUserWorkspace(String username)
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.
List<Revision>	getHistory(String test, int ignoredStart, int limit)
List<Revision>	getHistory(String test, String revision, int start, int limit)
String	getLatestVersion()
List<Revision>	getMatrixHistory(Instant sinceInclusive, Instant untilExclusive)
List<Revision>	getMatrixHistory(int start, int limit)
String	getName() This method returns a name of the ProctorStore instance for logging purpose.
RevisionDetails	getRevisionDetails(String revisionId)
List<TestEdit>	getTestEdits(String testName, int start, int limit)
List<TestEdit>	getTestEdits(String testName, String revision, int start, int limit)
void	refresh() Update the local state with the remote database.
String	toString()
void	verifySetup() Verifies the data store object is ready to operate.

Methods inherited from class com.indeed.proctor.store.FileBasedProctorStore

addTestDefinition, close, deleteTestDefinition, getCore, getCurrentTestDefinition, getCurrentTestMatrix, getTestDefinition, getTestMatrix, shutdown, updateTestDefinition, updateThing, writeIfChanged, writeThing

Methods inherited from class java.lang.Object

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

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

addTestDefinition, addTestDefinition, deleteTestDefinition, deleteTestDefinition, updateTestDefinition, updateTestDefinition

Constructor Detail

LocalDirectoryStore

public LocalDirectoryStore(File baseDir)

LocalDirectoryStore

public LocalDirectoryStore(File baseDir,
                           String testDefinitionsDirectory)

Method Detail

getLatestVersion

@Nonnull
public String getLatestVersion()
                                 throws StoreException

Returns:

the latest revision id.

Throws:

StoreException

cleanUserWorkspace

public boolean cleanUserWorkspace(String username)

getHistory

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

Parameters:

test - name of the test

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

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

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

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

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

getMatrixHistory

@Nonnull
public 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
public 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

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.

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.

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.

Throws:

StoreException - if it's not ready to operate.

toString

public String toString()

Overrides:

toString in class Object

getName

public String getName()

Description copied from interface: ProctorStore

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