org.whitesource.jenkins.model

Class WhiteSourceStep

java.lang.Object

org.whitesource.jenkins.model.WhiteSourceStep

public class WhiteSourceStep
extends Object

Holds job related configuration

Author:

artiom.petrov

Field Summary

Fields

Modifier and Type	Field and Description
static String	AGENT_KEYWORD
static String	COMMA
static String	GENERIC_GLOB_PATTERN
static String	SLASH
static String	SPACE
static String	WITH_MAVEN

Constructor Summary

Constructors

Constructor and Description
WhiteSourceStep(WhiteSourceDescriptor globalConfig, String jobApiToken, String jobForceUpdate, String jobCheckPolicies, String jobUserKey)
WhiteSourceStep(WhiteSourcePipelineStep step, WhiteSourceDescriptor globalConfig)
WhiteSourceStep(WhiteSourcePublisher publisher, WhiteSourceDescriptor globalConfig)

Method Summary

Modifier and Type	Method and Description
Collection<org.whitesource.agent.api.model.AgentProjectInfo>	getFSAProjects(PrintStream logger, hudson.FilePath workspace)
WhiteSourceDescriptor	getGlobalConfig()
String	getJobApiToken()
String	getJobUserKey()
String	getLibExcludes()
String	getLibIncludes()
String	getMavenProjectToken()
String	getModulesToExclude()
String	getModulesToInclude()
String	getModuleTokens()
String	getProduct()
String	getProductNameOrToken()
String	getProductVersion()
Collection<org.whitesource.agent.api.model.AgentProjectInfo>	getProjectInfos(hudson.model.Run<?,?> run, hudson.model.TaskListener listener, hudson.FilePath workspace, boolean isFreeStyleStep)
String	getProjectToken()
String	getRequesterEmail()
void	initializeIncludes()
boolean	isCheckAllLibraries()
boolean	isForceUpdate()
boolean	isIgnorePomModules()
boolean	isShouldCheckPolicies()
void	setCheckAllLibraries(boolean checkAllLibraries)
void	setForceUpdate(boolean forceUpdate)
void	setGlobalConfig(WhiteSourceDescriptor globalConfig)
void	setIgnorePomModules(boolean ignorePomModules)
void	setJobApiToken(String jobApiToken)
void	setJobUserKey(String jobUserKey)
void	setLibExcludes(String libExcludes)
void	setLibIncludes(String libIncludes)
void	setMavenProjectToken(String mavenProjectToken)
void	setModulesToExclude(String modulesToExclude)
void	setModulesToInclude(String modulesToInclude)
void	setModuleTokens(String moduleTokens)
void	setProduct(String product)
void	setProductNameOrToken(String productNameOrToken)
void	setProductVersion(String productVersion)
void	setProjectToken(String projectToken)
void	setRequesterEmail(String requesterEmail)
void	setShouldCheckPolicies(boolean shouldCheckPolicies)
void	stopBuild(hudson.model.Run<?,?> run, hudson.model.TaskListener listener, String message)
void	update(hudson.model.Run<?,?> run, hudson.model.TaskListener listener, Collection<org.whitesource.agent.api.model.AgentProjectInfo> projectInfos)

Methods inherited from class java.lang.Object

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

Field Detail

SPACE

public static final String SPACE

See Also:

Constant Field Values

WITH_MAVEN

public static final String WITH_MAVEN

See Also:

Constant Field Values

GENERIC_GLOB_PATTERN

public static final String GENERIC_GLOB_PATTERN

See Also:

Constant Field Values

COMMA

public static final String COMMA

See Also:

Constant Field Values

SLASH

public static final String SLASH

See Also:

Constant Field Values

AGENT_KEYWORD

public static final String AGENT_KEYWORD

See Also:

Constant Field Values

Constructor Detail

WhiteSourceStep

public WhiteSourceStep(WhiteSourceDescriptor globalConfig,
                       String jobApiToken,
                       String jobForceUpdate,
                       String jobCheckPolicies,
                       String jobUserKey)

WhiteSourceStep

public WhiteSourceStep(WhiteSourcePublisher publisher,
                       WhiteSourceDescriptor globalConfig)

WhiteSourceStep

public WhiteSourceStep(WhiteSourcePipelineStep step,
                       WhiteSourceDescriptor globalConfig)

Method Detail

update

public void update(hudson.model.Run<?,?> run,
                   hudson.model.TaskListener listener,
                   Collection<org.whitesource.agent.api.model.AgentProjectInfo> projectInfos)

getProjectInfos

public Collection<org.whitesource.agent.api.model.AgentProjectInfo> getProjectInfos(hudson.model.Run<?,?> run,
                                                                                    hudson.model.TaskListener listener,
                                                                                    hudson.FilePath workspace,
                                                                                    boolean isFreeStyleStep)
                                                                             throws IOException,
                                                                                    InterruptedException

Throws:

IOException

InterruptedException

stopBuild

public void stopBuild(hudson.model.Run<?,?> run,
                      hudson.model.TaskListener listener,
                      String message)

getGlobalConfig

public WhiteSourceDescriptor getGlobalConfig()

setGlobalConfig

public void setGlobalConfig(WhiteSourceDescriptor globalConfig)

getJobApiToken

public String getJobApiToken()

setJobApiToken

public void setJobApiToken(String jobApiToken)

getJobUserKey

public String getJobUserKey()

setJobUserKey

public void setJobUserKey(String jobUserKey)

getProduct

public String getProduct()

setProduct

public void setProduct(String product)

getProductVersion

public String getProductVersion()

setProductVersion

public void setProductVersion(String productVersion)

getProjectToken

public String getProjectToken()

setProjectToken

public void setProjectToken(String projectToken)

getLibIncludes

public String getLibIncludes()

setLibIncludes

public void setLibIncludes(String libIncludes)

getLibExcludes

public String getLibExcludes()

setLibExcludes

public void setLibExcludes(String libExcludes)

getMavenProjectToken

public String getMavenProjectToken()

setMavenProjectToken

public void setMavenProjectToken(String mavenProjectToken)

getRequesterEmail

public String getRequesterEmail()

setRequesterEmail

public void setRequesterEmail(String requesterEmail)

getModuleTokens

public String getModuleTokens()

setModuleTokens

public void setModuleTokens(String moduleTokens)

getModulesToInclude

public String getModulesToInclude()

setModulesToInclude

public void setModulesToInclude(String modulesToInclude)

getModulesToExclude

public String getModulesToExclude()

setModulesToExclude

public void setModulesToExclude(String modulesToExclude)

isIgnorePomModules

public boolean isIgnorePomModules()

setIgnorePomModules

public void setIgnorePomModules(boolean ignorePomModules)

getProductNameOrToken

public String getProductNameOrToken()

setProductNameOrToken

public void setProductNameOrToken(String productNameOrToken)

isShouldCheckPolicies

public boolean isShouldCheckPolicies()

setShouldCheckPolicies

public void setShouldCheckPolicies(boolean shouldCheckPolicies)

isCheckAllLibraries

public boolean isCheckAllLibraries()

setCheckAllLibraries

public void setCheckAllLibraries(boolean checkAllLibraries)

setForceUpdate

public void setForceUpdate(boolean forceUpdate)

isForceUpdate

public boolean isForceUpdate()

initializeIncludes

public void initializeIncludes()

getFSAProjects

public Collection<org.whitesource.agent.api.model.AgentProjectInfo> getFSAProjects(PrintStream logger,
                                                                                   hudson.FilePath workspace)