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, hudson.util.Secret jobApiToken, String jobForceUpdate, String jobCheckPolicies, hudson.util.Secret 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()
hudson.util.Secret	getJobApiToken()
hudson.util.Secret	getJobUserKey()
String	getLibExcludes()
String	getLibIncludes()
hudson.util.Secret	getMavenProjectToken()
String	getModulesToExclude()
String	getModulesToInclude()
hudson.util.Secret	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)
hudson.util.Secret	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(hudson.util.Secret jobApiToken)
void	setJobUserKey(hudson.util.Secret jobUserKey)
void	setLibExcludes(String libExcludes)
void	setLibIncludes(String libIncludes)
void	setMavenProjectToken(hudson.util.Secret mavenProjectToken)
void	setModulesToExclude(String modulesToExclude)
void	setModulesToInclude(String modulesToInclude)
void	setModuleTokens(hudson.util.Secret moduleTokens)
void	setProduct(String product)
void	setProductNameOrToken(String productNameOrToken)
void	setProductVersion(String productVersion)
void	setProjectToken(hudson.util.Secret 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,
                       hudson.util.Secret jobApiToken,
                       String jobForceUpdate,
                       String jobCheckPolicies,
                       hudson.util.Secret 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 hudson.util.Secret getJobApiToken()

setJobApiToken

public void setJobApiToken(hudson.util.Secret jobApiToken)

getJobUserKey

public hudson.util.Secret getJobUserKey()

setJobUserKey

public void setJobUserKey(hudson.util.Secret jobUserKey)

getProduct

public String getProduct()

setProduct

public void setProduct(String product)

getProductVersion

public String getProductVersion()

setProductVersion

public void setProductVersion(String productVersion)

getProjectToken

public hudson.util.Secret getProjectToken()

setProjectToken

public void setProjectToken(hudson.util.Secret projectToken)

getLibIncludes

public String getLibIncludes()

setLibIncludes

public void setLibIncludes(String libIncludes)

getLibExcludes

public String getLibExcludes()

setLibExcludes

public void setLibExcludes(String libExcludes)

getMavenProjectToken

public hudson.util.Secret getMavenProjectToken()

setMavenProjectToken

public void setMavenProjectToken(hudson.util.Secret mavenProjectToken)

getRequesterEmail

public String getRequesterEmail()

setRequesterEmail

public void setRequesterEmail(String requesterEmail)

getModuleTokens

public hudson.util.Secret getModuleTokens()

setModuleTokens

public void setModuleTokens(hudson.util.Secret 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)