com.infostretch.labs.transformers

Class Transformer

java.lang.Object

com.infostretch.labs.transformers.Transformer

public class Transformer
extends Object

Transformer class is the main class that handles the conversion of FreeStyle job configuration to pipeline Job configuration.

Author:

Mohit Dharamshi

Field Summary

Fields

Modifier and Type	Field and Description
protected NodeList	buildersList
StringBuffer	buildSteps
String	currentJobName
protected Document	dest
protected Document	doc
boolean	firstJob
Element	jdk
String	previousLabel
String	previousUrl
StringBuffer	publishSteps
StringBuffer	script

Constructor Summary

Constructors

Constructor and Description
Transformer(Map requestParams) Constructor to initialise variables required to process transformation.

Method Summary

Modifier and Type	Method and Description
void	appendToScript(String block) General method to append script block to main script.
void	appendToScript(String stage, String block) General method to append script block with a stage wrap.
Element	getElementByTag(Node node, String tag) Gets Element object from Node based on tag name.
boolean	getOnlyBuildTrigger()
InputStream	getStream() Returns the input stream which consists of the entire XML structure of the new pipeline job.
void	performFreeStyleTransformation() Initialises transformation process of Freestyle project to Pipeline.
void	setOnlyBuildTrigger(boolean value)
void	setScmBranch(String scmBranch) Setter method to set SCM Branch.
void	setScmCredentialsId(String scmCredentialsId) Setter method to set SCM Credentials Id.
void	setScmType(String scmType) Setter method to set SCM Type.
void	setScmURL(String scmURL) Setter method to set SCM URL.

Methods inherited from class java.lang.Object

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

Field Detail

doc

protected Document doc

dest

protected Document dest

jdk

public Element jdk

buildersList

protected NodeList buildersList

firstJob

public boolean firstJob

script

public StringBuffer script

buildSteps

public StringBuffer buildSteps

publishSteps

public StringBuffer publishSteps

currentJobName

public String currentJobName

previousUrl

public String previousUrl

previousLabel

public String previousLabel

Constructor Detail

Transformer

public Transformer(Map requestParams)

Constructor to initialise variables required to process transformation.

Parameters:

requestParams - Map that contains request parameters.

Method Detail

performFreeStyleTransformation

public void performFreeStyleTransformation()

Initialises transformation process of Freestyle project to Pipeline.

getStream

public InputStream getStream()

Returns the input stream which consists of the entire XML structure of the new pipeline job.

Returns:

InputStream of XML structure of the new pipeline job.

appendToScript

public void appendToScript(String stage,
                           String block)

General method to append script block with a stage wrap.

Parameters:

stage - Name of stage to create.

block - Script block to add under stage.

appendToScript

public void appendToScript(String block)

General method to append script block to main script.

Parameters:

block - Script block to add to main script.

getElementByTag

public Element getElementByTag(Node node,
                               String tag)

Gets Element object from Node based on tag name.

Parameters:

node - Node object from which element is to be extracted.

tag - Name of tag to extract.

Returns:

Element derived from node by given tag name.

setScmBranch

public void setScmBranch(String scmBranch)

Setter method to set SCM Branch. Useful when committing Jenkinsfile to SCM.

Parameters:

scmBranch - SCM Branch to set for committing Jenkinsfile to SCM.

setScmURL

public void setScmURL(String scmURL)

Setter method to set SCM URL. Useful when committing Jenkinsfile to SCM.

Parameters:

scmURL - SCM URL to set for committing Jenkinsfile to SCM.

setScmType

public void setScmType(String scmType)

Setter method to set SCM Type. Useful when committing Jenkinsfile to SCM.

Parameters:

scmType - SCM Type to set for committing Jenkinsfile to SCM.

setScmCredentialsId

public void setScmCredentialsId(String scmCredentialsId)

Setter method to set SCM Credentials Id. Useful when committing Jenkinsfile to SCM.

Parameters:

scmCredentialsId - SCM Credentials Id to set for committing Jenkinsfile to SCM.

setOnlyBuildTrigger

public void setOnlyBuildTrigger(boolean value)

getOnlyBuildTrigger

public boolean getOnlyBuildTrigger()