one.edee.darwin.storage

Interface DarwinStorage

All Known Implementing Classes:

DefaultDatabaseDarwinStorage

public interface DarwinStorage

Describes base persistence layer contract for Darwin.

Author:

Jan Novotný, FG Forrest a.s. (c) 2007

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	DarwinStorage.SqlScriptStatus Contains all possible states of the SQL script.

Method Summary

Modifier and Type	Method and Description
Patch	getPatchByResourcePath(String resourcePath, String componentName) Returns record for the patch by its path and component name in case it exists in database.
VersionDescriptor	getVersionDescriptorForComponent(String componentName) Returns version descriptor for particular component.
void	insertComponentToDatabase(String componentName) Inserts information about the component to the database with initial data layer version of 1.0
Patch	insertPatchToDatabase(String patchName, String componentName, LocalDateTime detectedOn, Platform platform) Inserts patch to db and returns its ID.
void	insertSqlScriptToDB(Patch patch, SqlCommand sqlCommand) Inserts information about performed SQL command to database.
boolean	isAnyPatchRecordedFor(String componentName) Returns true if there is any patch recorded for this component.
boolean	isPatchFinishedInDb(Patch patch) Tries to find record for the patch in internal database and looks for timestamp Patch#getFinishedOn() that signalizes that patch was successfully and entirely applied.
boolean	isPatchRecordedByResourcePath(String resourcePath, String componentName) Check if the patch by its path and component name in case it exists in database.
void	markPatchAsFinished(Patch patch) Stores timestamp of the completely and successfully applied patch.
void	setResourceAccessor(ResourceAccessor resourceAccessor) Sets initialized resource utils.
void	updateSqlScriptInDB(Patch patch, SqlCommand sqlCommand) Updates information about performed SQL command in database.
void	updateVersionDescriptorForComponent(String componentName, String version) Updates version descriptor for particular component.
DarwinStorage.SqlScriptStatus	wasSqlCommandAlreadyExecuted(int patchId, String script, int occurrence) Checks if is sql command was already applied to the database.

Method Detail

setResourceAccessor

void setResourceAccessor(ResourceAccessor resourceAccessor)

Sets initialized resource utils.

Parameters:

resourceAccessor - to use for accessing resources

getVersionDescriptorForComponent

VersionDescriptor getVersionDescriptorForComponent(String componentName)

Returns version descriptor for particular component.

Parameters:

componentName - unique identification of the component to retrieve version for.

updateVersionDescriptorForComponent

void updateVersionDescriptorForComponent(String componentName,
                                         String version)

Updates version descriptor for particular component.

Parameters:

componentName - unique identification of the component for updating version

version - of the component

insertPatchToDatabase

Patch insertPatchToDatabase(String patchName,
                            String componentName,
                            LocalDateTime detectedOn,
                            Platform platform)

Inserts patch to db and returns its ID. If patch is already in db it returns ID of such existing patch.

Parameters:

patchName - file name of the patch

componentName - unique identification of the component this patch belongs to

detectedOn - date and time patch was observed for the first time

platform - target database platform of the patch

Returns:

patch identification

insertSqlScriptToDB

void insertSqlScriptToDB(Patch patch,
                         SqlCommand sqlCommand)

Inserts information about performed SQL command to database.

Parameters:

patch - file name of the patch

sqlCommand - contents of the SQL command inside the patch

updateSqlScriptInDB

void updateSqlScriptInDB(Patch patch,
                         SqlCommand sqlCommand)

Updates information about performed SQL command in database.

Parameters:

patch - file name of the patch

sqlCommand - contents of the SQL command inside the patch

markPatchAsFinished

void markPatchAsFinished(Patch patch)

Stores timestamp of the completely and successfully applied patch.

Parameters:

patch - identification

getPatchByResourcePath

Patch getPatchByResourcePath(String resourcePath,
                             String componentName)

Returns record for the patch by its path and component name in case it exists in database.

Parameters:

resourcePath - platform and name of patch, example mysql/patch_1.1.sql

componentName - name of component on which is patch applied

Returns:

patch from db, by #resourcePath and #componentName

isPatchFinishedInDb

boolean isPatchFinishedInDb(Patch patch)

Tries to find record for the patch in internal database and looks for timestamp Patch#getFinishedOn() that signalizes that patch was successfully and entirely applied.

Parameters:

patch - identification

Returns:

true if patch was entirely applied

isPatchRecordedByResourcePath

boolean isPatchRecordedByResourcePath(String resourcePath,
                                      String componentName)

Check if the patch by its path and component name in case it exists in database.

Parameters:

resourcePath - platform and name of patch, example mysql/patch_1.1.sql

componentName - name of component on which is patch applied

Returns:

true if patch record is in database

isAnyPatchRecordedFor

boolean isAnyPatchRecordedFor(String componentName)

Returns true if there is any patch recorded for this component. Determines whether the component was updated by the new generation of darwin.

Parameters:

componentName - name of component what we want check

insertComponentToDatabase

void insertComponentToDatabase(String componentName)

Inserts information about the component to the database with initial data layer version of 1.0

wasSqlCommandAlreadyExecuted

DarwinStorage.SqlScriptStatus wasSqlCommandAlreadyExecuted(int patchId,
                                                           String script,
                                                           int occurrence)

Checks if is sql command was already applied to the database.

Parameters:

patchId - id of the patch this script is part of

script - SqlCommand#getStatement()

occurrence - number of the identical occurence of the same script in the patch