org.jenkinsci.plugins.pipelineConfigHistory.view

Class PipelineConfigHistoryProjectAction

java.lang.Object

org.jenkinsci.plugins.pipelineConfigHistory.view.PipelineConfigHistoryProjectAction

All Implemented Interfaces:

hudson.model.Action, hudson.model.ModelObject

public class PipelineConfigHistoryProjectAction
extends Object
implements hudson.model.Action

Constructor Summary

Constructors

Constructor and Description
PipelineConfigHistoryProjectAction(org.jenkinsci.plugins.workflow.job.WorkflowJob project)

Method Summary

Modifier and Type	Method and Description
boolean	buildExists(int build)
void	doDiffFiles(org.kohsuke.stapler.StaplerRequest req, org.kohsuke.stapler.StaplerResponse rsp) Show a diff file overview or all diffs combined in one page, depending on the showDiffsInOneSite-parameter.
File[]	getAllFilesExceptHistoryXmlFromDirectory(File directory) Get all files the given directory contains, except the history xml in the root dir.
int	getBuildNumber(String timestamp) Get the given revision's associated build's buildNumber.
String	getDisplayName()
File	getFileByHashCode(String timestamp, String hashCode) Return a file from a given config by its hashcode.
String	getFileContentByHashCode(String timestamp, String hashCode) Return a file's content from a given config by its hashcode.
String	getFileContentByHashCode(String timestamp, String hashCode, boolean syntaxHighlighted) Return a file's content from a given config by its hashcode.
String	getFileNameDisplayable(String timestamp, File file)
String	getIconFileName()
String	getJenkinsfilePath()
int	getLeadingWhitespace(String str)
List<SideBySideView.Line>	getLines(File file1, File file2) Calculate the line-wise diff of the given files.
List<SideBySideView.Line>	getLines(Match match) Calculate the line-wise diff of the files contained in the given match.
List<SideBySideView.Line>	getLines(String file1Str, String file2Str) Calculate the line-wise diff of the given files (as \n-containing strings).
String	getLinkSymbol()
List<Match>	getMatchingFiles(String timestamp1, String timestamp2) Calculate the revision file equality and return a list encapsulating that .
int	getOriginalNumberFromReplayBuild(String timestamp) Get the original build number this revision's associated build is a replay from.
PipelineHistoryDescription	getPipelineHistoryDescription(String timestamp) Get the PipelineHistoryDescription describing the config this timestamp represents.
List<PipelineHistoryDescription>	getPipelineHistoryDescriptions() Get a list of all PipelineHistoryDescriptions.
hudson.model.AbstractItem	getProject() Get the current pipeline project.
File	getRevision(String timestamp) Get the wanted pipeline revision of the current project.
String	getScriptFromXmlFile(File file, boolean syntaxHighlighted) Return the content of the script-Tag in the given xml file.
String	getScriptFromXmlFile(String timestamp, String hashCode, boolean syntaxHighlighted) Return the content of the script-Tag in the given xml file.
List<SingleLineView.Line>	getSingleLineViewLines(File file1, File file2)
List<SingleLineView.Line>	getSingleLineViewLines(List<SideBySideView.Line> unsortedLines)
List<SingleLineView.Line>	getSingleLineViewLines(Match match)
List<SingleLineView.Line>	getSingleLineViewLines(String file1Str, String file2Str)
String	getTimestampWellFormatted(String timestamp) Get your timestamp well formatted.
String	getUrlName()
boolean	isAnyMatchUnequal(String timestamp1, String timestamp2) Determine whether the given revisions are unequal.
boolean	isBuiltfromReplay(String timestamp) Determine whether the given revision's associated build is a replay from anoter build.

Methods inherited from class java.lang.Object

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

Constructor Detail

PipelineConfigHistoryProjectAction

public PipelineConfigHistoryProjectAction(org.jenkinsci.plugins.workflow.job.WorkflowJob project)

Method Detail

getPipelineHistoryDescriptions

public List<PipelineHistoryDescription> getPipelineHistoryDescriptions()

Get a list of all PipelineHistoryDescriptions.

Returns:

a list representing all revisions of this pipeline.

getPipelineHistoryDescription

public PipelineHistoryDescription getPipelineHistoryDescription(String timestamp)
                                                         throws IOException

Get the PipelineHistoryDescription describing the config this timestamp represents.

Parameters:

timestamp - the timestamp to identify the config

Returns:

the config description object.

Throws:

IOException - if the wanted pipeline history is not found.

getFileNameDisplayable

public String getFileNameDisplayable(String timestamp,
                                     File file)

getJenkinsfilePath

public String getJenkinsfilePath()

getFileByHashCode

public File getFileByHashCode(String timestamp,
                              String hashCode)

Return a file from a given config by its hashcode.

Parameters:

timestamp - the config identifier

hashCode - the file identifier

Returns:

the wanted file.

getAllFilesExceptHistoryXmlFromDirectory

public File[] getAllFilesExceptHistoryXmlFromDirectory(File directory)

Get all files the given directory contains, except the history xml in the root dir.

Parameters:

directory - the directory.

Returns:

all files this directory contains, except the history xml in the root dir.

getFileContentByHashCode

public String getFileContentByHashCode(String timestamp,
                                       String hashCode,
                                       boolean syntaxHighlighted)

Return a file's content from a given config by its hashcode.

Parameters:

timestamp - the config identifier

hashCode - the file identifier

syntaxHighlighted - whether syntax highlighting html tags should be included or not

Returns:

the wanted file.

getFileContentByHashCode

public String getFileContentByHashCode(String timestamp,
                                       String hashCode)

Return a file's content from a given config by its hashcode.

Parameters:

timestamp - the config identifier

hashCode - the file identifier

Returns:

the wanted file.

getScriptFromXmlFile

public String getScriptFromXmlFile(File file,
                                   boolean syntaxHighlighted)

Return the content of the script-Tag in the given xml file.

Parameters:

file - the xml file.

syntaxHighlighted - whether syntax highlighting html tags should be included or not

Returns:

the wanted script

getScriptFromXmlFile

public String getScriptFromXmlFile(String timestamp,
                                   String hashCode,
                                   boolean syntaxHighlighted)

Return the content of the script-Tag in the given xml file.

Parameters:

timestamp - the config identifier

hashCode - the file identifier

syntaxHighlighted - whether syntax highlighting html tags should be included or not

Returns:

the wanted script

getTimestampWellFormatted

public String getTimestampWellFormatted(String timestamp)

Get your timestamp well formatted.

Parameters:

timestamp - the config identifier

Returns:

the timestamp in a humanly readable format.

getRevision

public File getRevision(String timestamp)

Get the wanted pipeline revision of the current project.

Parameters:

timestamp - the config identifier

Returns:

the wanted revision

isBuiltfromReplay

public boolean isBuiltfromReplay(String timestamp)

Determine whether the given revision's associated build is a replay from anoter build.

Parameters:

timestamp - the config revision identifier.

Returns:

true or false

getOriginalNumberFromReplayBuild

public int getOriginalNumberFromReplayBuild(String timestamp)

Get the original build number this revision's associated build is a replay from. (Only if isBuiltfromReplay(timestamp) is true.)

Parameters:

timestamp - the config revision identifier.

Returns:

true or false

getBuildNumber

public int getBuildNumber(String timestamp)

Get the given revision's associated build's buildNumber.

Parameters:

timestamp - the config revision identifier

Returns:

the buildNumber

buildExists

public boolean buildExists(int build)

getProject

public final hudson.model.AbstractItem getProject()

Get the current pipeline project.

Returns:

the pipeline project

isAnyMatchUnequal

public boolean isAnyMatchUnequal(String timestamp1,
                                 String timestamp2)

Determine whether the given revisions are unequal.

Parameters:

timestamp1 - the first config revision identifier

timestamp2 - the second config revision identifier

Returns:

whether the given revisions are unequal.

getMatchingFiles

public List<Match> getMatchingFiles(String timestamp1,
                                    String timestamp2)

Calculate the revision file equality and return a list encapsulating that .

Parameters:

timestamp1 - the first config revision identifier

timestamp2 - the second config revision identifier

Returns:

the given revisions' matching files.

getLines

public final List<SideBySideView.Line> getLines(File file1,
                                                File file2)

Calculate the line-wise diff of the given files.

Parameters:

file1 - the first file

file2 - the second file

Returns:

the difference between the given files.

getLines

public final List<SideBySideView.Line> getLines(Match match)

Calculate the line-wise diff of the files contained in the given match.

Parameters:

match - the match.

Returns:

the diff.

getLines

public final List<SideBySideView.Line> getLines(String file1Str,
                                                String file2Str)

Calculate the line-wise diff of the given files (as \n-containing strings).

Parameters:

file1Str - the first file

file2Str - the second file

Returns:

the diff.

getSingleLineViewLines

public final List<SingleLineView.Line> getSingleLineViewLines(File file1,
                                                              File file2)

getSingleLineViewLines

public final List<SingleLineView.Line> getSingleLineViewLines(Match match)

getSingleLineViewLines

public final List<SingleLineView.Line> getSingleLineViewLines(List<SideBySideView.Line> unsortedLines)

getLinkSymbol

public String getLinkSymbol()

getSingleLineViewLines

public final List<SingleLineView.Line> getSingleLineViewLines(String file1Str,
                                                              String file2Str)

doDiffFiles

public void doDiffFiles(org.kohsuke.stapler.StaplerRequest req,
                        org.kohsuke.stapler.StaplerResponse rsp)
                 throws IOException

Show a diff file overview or all diffs combined in one page, depending on the showDiffsInOneSite-parameter.

Parameters:

req - the request containing the parameters

rsp - the response.

Throws:

IOException - some exception that might occur.

getLeadingWhitespace

public int getLeadingWhitespace(String str)

getIconFileName

@CheckForNull
public String getIconFileName()

Specified by:

getIconFileName in interface hudson.model.Action

getDisplayName

@CheckForNull
public String getDisplayName()

Specified by:

getDisplayName in interface hudson.model.Action

Specified by:

getDisplayName in interface hudson.model.ModelObject

getUrlName

@CheckForNull
public String getUrlName()

Specified by:

getUrlName in interface hudson.model.Action