org.jenkinsci.plugins.pipelineConfigHistory.model

Class FilePipelineItemHistoryDao

java.lang.Object

org.jenkinsci.plugins.pipelineConfigHistory.model.FilePipelineItemHistoryDao

All Implemented Interfaces:

PipelineItemHistoryDao

public class FilePipelineItemHistoryDao
extends Object
implements PipelineItemHistoryDao

A PipelineItemHistoryDao-Implementation for storing the history directly in the file system (where Jenkins is stored).

Constructor Summary

Constructors

Constructor and Description
FilePipelineItemHistoryDao(File historyRootDir)

Method Summary

Modifier and Type	Method and Description
void	changeHistoryLocation(org.jenkinsci.plugins.workflow.job.WorkflowJob workflowJob, String oldFullName, String newFullName) Change the history of this WorkflowJob, if present.
void	createHistory(org.jenkinsci.plugins.workflow.job.WorkflowJob workflowJob, int buildNumber) Creates the history entry of this WorkflowJob.
void	deleteHistory(org.jenkinsci.plugins.workflow.job.WorkflowJob workflowJob) Deletes the history of this WorkflowJob, if present.
File	getHistoryRootDirectory(org.jenkinsci.plugins.workflow.job.WorkflowJob workflowJob)
File	getMostRecentRevision(org.jenkinsci.plugins.workflow.job.WorkflowJob workflowJob)
int	getOriginalBuildNumberFromReplay(PipelineHistoryDescription pipelineHistoryDescription)
File	getRevision(PipelineHistoryDescription pipelineHistoryDescription)
File	getRevision(org.jenkinsci.plugins.workflow.job.WorkflowJob workflowJob, String identifier) Returns an old revision.
SortedMap<String,PipelineHistoryDescription>	getRevisions(org.jenkinsci.plugins.workflow.job.WorkflowJob workflowJob) For a given Pipeline Job, return all revisions.
File	getRootDirectory()
boolean	isBuiltfromReplay(PipelineHistoryDescription pipelineHistoryDescription)
boolean	isHistoryPresent(org.jenkinsci.plugins.workflow.job.WorkflowJob workflowJob) Determines whether there are history entries present or not.
void	updateHistory(org.jenkinsci.plugins.workflow.job.WorkflowJob workflowJob, int buildNumber) Updates the history entry of this WorkflowJob.

Methods inherited from class java.lang.Object

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

Constructor Detail

FilePipelineItemHistoryDao

public FilePipelineItemHistoryDao(File historyRootDir)

Method Detail

createHistory

public void createHistory(org.jenkinsci.plugins.workflow.job.WorkflowJob workflowJob,
                          int buildNumber)
                   throws IOException

Description copied from interface: PipelineItemHistoryDao

Creates the history entry of this WorkflowJob.

Specified by:

createHistory in interface PipelineItemHistoryDao

Parameters:

workflowJob - the Pipeline Job.

buildNumber - the build number to be associated to the history entry.

Throws:

IOException - if creating a history entry fails on IO level.

getRootDirectory

public File getRootDirectory()

updateHistory

public void updateHistory(org.jenkinsci.plugins.workflow.job.WorkflowJob workflowJob,
                          int buildNumber)
                   throws IOException

Description copied from interface: PipelineItemHistoryDao

Updates the history entry of this WorkflowJob.

Specified by:

updateHistory in interface PipelineItemHistoryDao

Parameters:

workflowJob - the Pipeline Job.

buildNumber - the build number to be associated to the history entry.

Throws:

IOException - if updating the history fails on IO level.

deleteHistory

public void deleteHistory(org.jenkinsci.plugins.workflow.job.WorkflowJob workflowJob)
                   throws IOException

Description copied from interface: PipelineItemHistoryDao

Deletes the history of this WorkflowJob, if present.

Specified by:

deleteHistory in interface PipelineItemHistoryDao

Parameters:

workflowJob - the Pipeline Job.

Throws:

IOException - if deleting the history fails on IO level.

changeHistoryLocation

public void changeHistoryLocation(org.jenkinsci.plugins.workflow.job.WorkflowJob workflowJob,
                                  String oldFullName,
                                  String newFullName)

Description copied from interface: PipelineItemHistoryDao

Change the history of this WorkflowJob, if present.

Specified by:

changeHistoryLocation in interface PipelineItemHistoryDao

Parameters:

workflowJob - the Pipeline Job.

oldFullName - the old full name (its folder-including tree path)

newFullName - the new full name

getMostRecentRevision

public File getMostRecentRevision(org.jenkinsci.plugins.workflow.job.WorkflowJob workflowJob)

Specified by:

getMostRecentRevision in interface PipelineItemHistoryDao

getRevision

public File getRevision(org.jenkinsci.plugins.workflow.job.WorkflowJob workflowJob,
                        String identifier)
                 throws FileNotFoundException

Description copied from interface: PipelineItemHistoryDao

Returns an old revision.

Specified by:

getRevision in interface PipelineItemHistoryDao

Parameters:

workflowJob - the workflowJob

identifier - the identifier

Returns:

the wanted revision identified by the workflowjob and a revision identifier.

Throws:

FileNotFoundException - if the revision id'd by the identifier can't be found.

getRevision

public File getRevision(PipelineHistoryDescription pipelineHistoryDescription)
                 throws FileNotFoundException

Specified by:

getRevision in interface PipelineItemHistoryDao

Throws:

FileNotFoundException

isBuiltfromReplay

public boolean isBuiltfromReplay(PipelineHistoryDescription pipelineHistoryDescription)
                          throws IOException

Specified by:

isBuiltfromReplay in interface PipelineItemHistoryDao

Throws:

IOException

getOriginalBuildNumberFromReplay

public int getOriginalBuildNumberFromReplay(PipelineHistoryDescription pipelineHistoryDescription)
                                     throws IOException,
                                            SAXException,
                                            ParserConfigurationException

Specified by:

getOriginalBuildNumberFromReplay in interface PipelineItemHistoryDao

Throws:

IOException

SAXException

ParserConfigurationException

getRevisions

public SortedMap<String,PipelineHistoryDescription> getRevisions(org.jenkinsci.plugins.workflow.job.WorkflowJob workflowJob)
                                                          throws IOException

Description copied from interface: PipelineItemHistoryDao

For a given Pipeline Job, return all revisions.

Specified by:

getRevisions in interface PipelineItemHistoryDao

Parameters:

workflowJob - the pipeline job

Returns:

all revisions the pipeline job has.

Throws:

IOException - if retrieving the history revisions fails on IO level.

isHistoryPresent

public boolean isHistoryPresent(org.jenkinsci.plugins.workflow.job.WorkflowJob workflowJob)

Description copied from interface: PipelineItemHistoryDao

Determines whether there are history entries present or not.

Specified by:

isHistoryPresent in interface PipelineItemHistoryDao

Parameters:

workflowJob - the Pipeline Job.

Returns:

whether there are history entries present or not

getHistoryRootDirectory

public final File getHistoryRootDirectory(org.jenkinsci.plugins.workflow.job.WorkflowJob workflowJob)