com.indeed.proctor.store

Class FileBasedProctorStore

java.lang.Object

com.indeed.proctor.store.FileBasedProctorStore

All Implemented Interfaces:

ProctorReader, ProctorStore, ProctorWriter, Closeable, AutoCloseable

Direct Known Subclasses:

LocalDirectoryStore

public abstract class FileBasedProctorStore
extends Object
implements ProctorStore

Author:

ketan, parker

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	FileBasedProctorStore.ProctorUpdater
static interface	FileBasedProctorStore.RcsClient

Field Summary

Fields

Modifier and Type	Field and Description
protected FileBasedPersisterCore	core
static String	DEFAULT_TEST_DEFINITIONS_DIRECTORY

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	FileBasedProctorStore(FileBasedPersisterCore core)
protected	FileBasedProctorStore(FileBasedPersisterCore core, String testDefinitionsDirectory)

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)
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)
FileBasedPersisterCore	getCore()
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.
TestDefinition	getTestDefinition(String testName, 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	shutdown()
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) This is the normal operation that I expect to happen
protected <T> boolean	updateThing(FileBasedProctorStore.RcsClient rcsClient, File file, T thing)
protected static <T> boolean	writeIfChanged(com.fasterxml.jackson.databind.ObjectMapper mapper, File f, T newThing)
protected static <T> void	writeThing(com.fasterxml.jackson.databind.ObjectMapper mapper, File f, T newThing)

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.ProctorStore

getName

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

getAllHistories, getHistory, getHistory, getLatestVersion, getMatrixHistory, getRevisionDetails, refresh, verifySetup

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

cleanUserWorkspace, verifySetup

Field Detail

DEFAULT_TEST_DEFINITIONS_DIRECTORY

public static final String DEFAULT_TEST_DEFINITIONS_DIRECTORY

See Also:

Constant Field Values

core

protected final FileBasedPersisterCore core

Constructor Detail

FileBasedProctorStore

protected FileBasedProctorStore(FileBasedPersisterCore core,
                                String testDefinitionsDirectory)

FileBasedProctorStore

protected FileBasedProctorStore(FileBasedPersisterCore core)

Method Detail

writeIfChanged

protected static <T> boolean writeIfChanged(com.fasterxml.jackson.databind.ObjectMapper mapper,
                                            File f,
                                            T newThing)
                                     throws StoreException.TestUpdateException

Returns:

true if the file has changed

Throws:

StoreException.TestUpdateException

writeThing

protected static <T> void writeThing(com.fasterxml.jackson.databind.ObjectMapper mapper,
                                     File f,
                                     T newThing)
                              throws StoreException.TestUpdateException

Throws:

StoreException.TestUpdateException

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

getCore

public FileBasedPersisterCore getCore()

getTestMatrix

public final 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

getCurrentTestDefinition

public TestDefinition getCurrentTestDefinition(String testName)
                                        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:

testName - name of the test

Throws:

StoreException

getTestDefinition

public TestDefinition getTestDefinition(String testName,
                                        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:

testName - name of the test

fetchRevision - id of the revision

Throws:

StoreException

shutdown

public void shutdown()

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException

updateThing

protected final <T> boolean updateThing(FileBasedProctorStore.RcsClient rcsClient,
                                        File file,
                                        T thing)
                                 throws Exception

Throws:

Exception

updateTestDefinition

public final 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

updateTestDefinition

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

Description copied from interface: ProctorWriter

This is the normal operation that I expect to happen

Specified by:

updateTestDefinition in interface ProctorWriter

Throws:

StoreException.TestUpdateException

addTestDefinition

public final 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

addTestDefinition

public final 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

deleteTestDefinition

public final 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

deleteTestDefinition

public final 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