Package dev.galasa.framework.spi

Interface IResultArchiveStore

All Known Subinterfaces:

IResultArchiveStoreService

public interface IResultArchiveStore

Used to gain access to the Result Archive Store (RAS)

POnce initialised, the Framework will provide access to 0 or more Result Archive Stores.

Apache CouchDB is the preferred RAS for an automation, and a file directory on the local filesystem is the preferred RAS for local runs.

An IResultArchiveStore can be obtained from IFramework.getResultArchiveStore().

Method Summary

Modifier and Type	Method	Description
String	calculateRasRunId()
void	flush()
@NotNull List<IResultArchiveStoreDirectoryService>	getDirectoryServices()
Path	getStoredArtifactsRoot()	Obtain the root directory of the stored artifacts file system
void	shutdown()
void	updateTestStructure(@NotNull TestStructure testStructure)	Update the Test Structure object in the RASs with the current status
void	writeLog(@NotNull String message)	Write a message to the run log in the RASs
void	writeLog(@NotNull List<String> messages)	Write multiple messages to the run log in the RASs

Method Details

writeLog

void writeLog(@NotNull
 @NotNull String message)
       throws ResultArchiveStoreException

Write a message to the run log in the RASs

Parameters:

message - - a Message to write to the run log

Throws:

ResultArchiveStoreException - - If there is a problem writing to the store

writeLog

void writeLog(@NotNull
 @NotNull List<String> messages)
       throws ResultArchiveStoreException

Write multiple messages to the run log in the RASs

Parameters:

messages - - Messages to write

Throws:

ResultArchiveStoreException - - If there is a problem writing to the store

updateTestStructure

void updateTestStructure(@NotNull
 @NotNull TestStructure testStructure)
                  throws ResultArchiveStoreException

Update the Test Structure object in the RASs with the current status

Parameters:

testStructure - - The Test Structure

Throws:

ResultArchiveStoreException - - If there is a problem writing to the store

getStoredArtifactsRoot

Path getStoredArtifactsRoot()

Obtain the root directory of the stored artifacts file system

Returns:

a Path

flush

void flush()

shutdown

void shutdown()

getDirectoryServices

@NotNull
@NotNull List<IResultArchiveStoreDirectoryService> getDirectoryServices()

calculateRasRunId

String calculateRasRunId()