com.indeed.proctor.store

Interface ProctorWriter

All Known Subinterfaces:

ProctorStore

All Known Implementing Classes:

CachingProctorStore, FileBasedProctorStore, InMemoryProctorStore, LocalDirectoryStore

public interface ProctorWriter

Author:

parker

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.
default void	addTestDefinition(String username, String password, String author, String testName, TestDefinition testDefinition, Map<String,String> metadata, String comment) Deprecated. use ChangeMetadata
default void	addTestDefinition(String username, String password, String testName, TestDefinition testDefinition, Map<String,String> metadata, String comment) Deprecated. use ChangeMetadata
boolean	cleanUserWorkspace(String username)
void	deleteTestDefinition(ChangeMetadata changeMetadata, String previousVersion, String testName, TestDefinition testDefinition)
default void	deleteTestDefinition(String username, String password, String author, String previousVersion, String testName, TestDefinition testDefinition, String comment) Deprecated. use ChangeMetadata
default void	deleteTestDefinition(String username, String password, String previousVersion, String testName, TestDefinition testDefinition, String comment) Deprecated. use ChangeMetadata
void	updateTestDefinition(ChangeMetadata changeMetadata, String previousVersion, String testName, TestDefinition testDefinition, Map<String,String> metadata) Updates a test with testName that already exists in this store Fails with Exception when testName does not exist, or neither testDefinition nor metadata has changes to current version
default void	updateTestDefinition(String username, String password, String author, String previousVersion, String testName, TestDefinition testDefinition, Map<String,String> metadata, String comment) Deprecated. use ChangeMetadata
default void	updateTestDefinition(String username, String password, String previousVersion, String testName, TestDefinition testDefinition, Map<String,String> metadata, String comment) Deprecated. use ChangeMetadata
void	verifySetup()

Method Detail

verifySetup

void verifySetup()
          throws StoreException

Throws:

StoreException

cleanUserWorkspace

boolean cleanUserWorkspace(String username)

updateTestDefinition

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

Deprecated. use ChangeMetadata

ProctorWriter.updateTestDefinition, using username as author

Throws:

StoreException.TestUpdateException

updateTestDefinition

@Deprecated
default void updateTestDefinition(String username,
                                              String password,
                                              String author,
                                              String previousVersion,
                                              String testName,
                                              TestDefinition testDefinition,
                                              Map<String,String> metadata,
                                              String comment)
                                       throws StoreException.TestUpdateException

Deprecated. use ChangeMetadata

ProctorWriter.updateTestDefinition, using Instant.now

Throws:

StoreException.TestUpdateException

updateTestDefinition

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

Updates a test with testName that already exists in this store Fails with Exception when testName does not exist, or neither testDefinition nor metadata has changes to current version

Throws:

StoreException.TestUpdateException

deleteTestDefinition

@Deprecated
default void deleteTestDefinition(String username,
                                              String password,
                                              String previousVersion,
                                              String testName,
                                              TestDefinition testDefinition,
                                              String comment)
                                       throws StoreException.TestUpdateException

Deprecated. use ChangeMetadata

ProctorWriter.deleteTestDefinition, using username as author

Throws:

StoreException.TestUpdateException

deleteTestDefinition

@Deprecated
default void deleteTestDefinition(String username,
                                              String password,
                                              String author,
                                              String previousVersion,
                                              String testName,
                                              TestDefinition testDefinition,
                                              String comment)
                                       throws StoreException.TestUpdateException

Deprecated. use ChangeMetadata

ProctorWriter.deleteTestDefinition, using Instant.now

Throws:

StoreException.TestUpdateException

deleteTestDefinition

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

Throws:

StoreException.TestUpdateException - when

addTestDefinition

@Deprecated
default void addTestDefinition(String username,
                                           String password,
                                           String testName,
                                           TestDefinition testDefinition,
                                           Map<String,String> metadata,
                                           String comment)
                                    throws StoreException.TestUpdateException

Deprecated. use ChangeMetadata

ProctorWriter.addTestDefinition, using username as author

Throws:

StoreException.TestUpdateException

addTestDefinition

@Deprecated
default void addTestDefinition(String username,
                                           String password,
                                           String author,
                                           String testName,
                                           TestDefinition testDefinition,
                                           Map<String,String> metadata,
                                           String comment)
                                    throws StoreException.TestUpdateException

Deprecated. use ChangeMetadata

ProctorWriter.addTestDefinition, using Instant.now

Throws:

StoreException.TestUpdateException

addTestDefinition

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

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

Throws:

StoreException.TestUpdateException - on invalid inputs