org.jenkinsci.plugins.pipelineConfigHistory.model

Interface PipelineItemHistoryDao

All Known Implementing Classes:

FilePipelineItemHistoryDao

public interface PipelineItemHistoryDao

Config file I/O.

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	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.
boolean	isBuiltfromReplay(PipelineHistoryDescription pipelineHistoryDescription)
boolean	isHistoryPresent(org.jenkinsci.plugins.workflow.job.WorkflowJob workflowJob) Determines whether there are history entries present or not.
void	purgeEntriesByAge(int maxAge, org.jenkinsci.plugins.workflow.job.WorkflowJob workflowJob)
boolean	updateHistory(org.jenkinsci.plugins.workflow.job.WorkflowJob workflowJob, int buildNumber) Updates the history entry of this WorkflowJob.

Method Detail

createHistory

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

Creates the history entry of this WorkflowJob.

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.

updateHistory

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

Updates the history entry of this WorkflowJob.

Parameters:

workflowJob - the Pipeline Job.

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

Returns:

if the history got updated,

Throws:

IOException - if updating the history fails on IO level.

deleteHistory

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

Deletes the history of this WorkflowJob, if present.

Parameters:

workflowJob - the Pipeline Job.

Throws:

IOException - if deleting the history fails on IO level.

changeHistoryLocation

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

Change the history of this WorkflowJob, if present.

Parameters:

workflowJob - the Pipeline Job.

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

newFullName - the new full name

getRevision

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

Returns an old revision.

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

File getRevision(PipelineHistoryDescription pipelineHistoryDescription)
          throws FileNotFoundException

Throws:

FileNotFoundException

getMostRecentRevision

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

isBuiltfromReplay

boolean isBuiltfromReplay(PipelineHistoryDescription pipelineHistoryDescription)
                   throws IOException

Throws:

IOException

getOriginalBuildNumberFromReplay

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

Throws:

IOException

SAXException

ParserConfigurationException

getRevisions

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

For a given Pipeline Job, return all revisions.

Parameters:

workflowJob - the pipeline job

Returns:

all revisions the pipeline job has.

Throws:

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

isHistoryPresent

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

Determines whether there are history entries present or not.

Parameters:

workflowJob - the Pipeline Job.

Returns:

whether there are history entries present or not

purgeEntriesByAge

void purgeEntriesByAge(int maxAge,
                       org.jenkinsci.plugins.workflow.job.WorkflowJob workflowJob)