org.whitesource.agent.api.dispatch

Class BaseRequest<R>

java.lang.Object

org.whitesource.agent.api.dispatch.BaseRequest<R>

Type Parameters:

R - Type of expected result.

All Implemented Interfaces:

java.io.Serializable, ServiceRequest<R>

Direct Known Subclasses:

AsyncCheckPolicyComplianceRequest, AsyncCheckPolicyComplianceResponseRequest, AsyncCheckPolicyComplianceStatusRequest, CheckPoliciesRequest, CheckPolicyComplianceRequest, CheckVulnerabilitiesRequest, ConfigurationRequest, GetCloudNativeVulnerabilitiesRequest, GetDependencyDataRequest, JwtAccessTokenRequest, SendMetricsRequest, SummaryScanRequest, UpdateInventoryRequest, UploadScaLogsRequest

public abstract class BaseRequest<R>
extends java.lang.Object
implements ServiceRequest<R>

Base, abstract, implementation of the interface.

Author:

Edo.Shor

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	agent
protected java.lang.String	agentVersion
protected boolean	aggregateModules
protected java.lang.String	aggregateProjectName
protected java.lang.String	aggregateProjectToken
protected java.util.Collection<ContributionInfo>	contributions
protected java.util.Map<java.lang.String,java.lang.String>	extraProperties
protected java.lang.String	logData
protected java.lang.String	orgToken
protected java.lang.String	pluginVersion
protected boolean	preserveModuleStructure
protected java.lang.String	product
protected java.lang.String	productToken
protected java.lang.String	productVersion
protected java.util.Collection<AgentProjectInfo>	projects
protected java.lang.String	requesterEmail
protected java.lang.String	scanComment
protected ScanSummaryInfo	scanSummaryInfo
protected long	timeStamp
protected RequestType	type
protected java.lang.String	userKey

Constructor Summary

Constructors

Constructor and Description
BaseRequest(RequestType type) Constructor
BaseRequest(RequestType type, java.lang.String agent) Constructor
BaseRequest(RequestType type, java.lang.String agent, java.lang.String agentVersion, java.lang.String pluginVersion) Constructor

Method Summary

Modifier and Type	Method and Description
java.lang.String	agent()
java.lang.String	agentVersion()
boolean	aggregateModules()
java.lang.String	aggregateProjectName()
java.lang.String	aggregateProjectToken()
java.util.Map<java.lang.String,java.lang.String>	extraProperties()
java.util.Collection<ContributionInfo>	getContributions()
java.util.Map<java.lang.String,java.lang.String>	getExtraProperties()
java.util.Collection<AgentProjectInfo>	getProjects()
ScanSummaryInfo	getScanSummaryInfo()
java.lang.String	logData()
java.lang.String	orgToken()
java.lang.String	pluginVersion()
boolean	preserveModuleStructure()
java.lang.String	product()
java.lang.String	productToken()
java.lang.String	productVersion()
java.lang.String	requesterEmail()
java.lang.String	scanComment()
void	setAgent(java.lang.String agent)
void	setAgentVersion(java.lang.String agentVersion)
void	setAggregateModules(boolean aggregateModules)
void	setAggregateProjectName(java.lang.String aggregateProjectName)
void	setAggregateProjectToken(java.lang.String aggregateProjectToken)
void	setContributions(java.util.Collection<ContributionInfo> contributions)
void	setExtraProperties(java.util.Map<java.lang.String,java.lang.String> extraProperties)
void	setLogData(java.lang.String logData)
void	setOrgToken(java.lang.String orgToken)
void	setPluginVersion(java.lang.String pluginVersion)
void	setPreserveModuleStructure(boolean preserveModuleStructure)
void	setProduct(java.lang.String product)
void	setProductToken(java.lang.String productToken)
void	setProductVersion(java.lang.String productVersion)
void	setProjects(java.util.Collection<AgentProjectInfo> projects)
void	setRequesterEmail(java.lang.String requesterEmail)
void	setScanComment(java.lang.String scanComment)
void	setScanSummaryInfo(ScanSummaryInfo scanSummaryInfo)
void	setTimeStamp(long timeStamp)
void	setUserKey(java.lang.String userKey)
long	timeStamp()
RequestType	type()
java.lang.String	userKey()

Methods inherited from class java.lang.Object

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

Field Detail

type

protected final RequestType type

agent

protected java.lang.String agent

agentVersion

protected java.lang.String agentVersion

pluginVersion

protected java.lang.String pluginVersion

orgToken

protected java.lang.String orgToken

userKey

protected java.lang.String userKey

product

protected java.lang.String product

productVersion

protected java.lang.String productVersion

timeStamp

protected long timeStamp

requesterEmail

protected java.lang.String requesterEmail

projects

protected java.util.Collection<AgentProjectInfo> projects

aggregateModules

protected boolean aggregateModules

preserveModuleStructure

protected boolean preserveModuleStructure

aggregateProjectName

protected java.lang.String aggregateProjectName

aggregateProjectToken

protected java.lang.String aggregateProjectToken

logData

protected java.lang.String logData

scanComment

protected java.lang.String scanComment

productToken

protected java.lang.String productToken

extraProperties

protected java.util.Map<java.lang.String,java.lang.String> extraProperties

scanSummaryInfo

protected ScanSummaryInfo scanSummaryInfo

contributions

protected java.util.Collection<ContributionInfo> contributions

Constructor Detail

BaseRequest

public BaseRequest(RequestType type)

Constructor

Parameters:

type - Request operation type.

BaseRequest

public BaseRequest(RequestType type,
                   java.lang.String agent)

Constructor

Parameters:

type - Request operation type.

agent - Agent type identifier.

BaseRequest

public BaseRequest(RequestType type,
                   java.lang.String agent,
                   java.lang.String agentVersion,
                   java.lang.String pluginVersion)

Constructor

Parameters:

type - Request operation type.

agent - Agent type identifier.

agentVersion - Agent version.

pluginVersion - Plugin version.

Method Detail

type

public RequestType type()

Specified by:

type in interface ServiceRequest<R>

Returns:

Request type.

orgToken

public java.lang.String orgToken()

Specified by:

orgToken in interface ServiceRequest<R>

Returns:

WhiteSource service token of the organization to update.

agent

public java.lang.String agent()

Specified by:

agent in interface ServiceRequest<R>

Returns:

Agent type identifier.

agentVersion

public java.lang.String agentVersion()

Specified by:

agentVersion in interface ServiceRequest<R>

Returns:

Agent API version.

pluginVersion

public java.lang.String pluginVersion()

Specified by:

pluginVersion in interface ServiceRequest<R>

Returns:

Plugin version.

product

public java.lang.String product()

Specified by:

product in interface ServiceRequest<R>

Returns:

Name or WhiteSource service token of the product to update.

productVersion

public java.lang.String productVersion()

Specified by:

productVersion in interface ServiceRequest<R>

Returns:

Version of the product to update.

timeStamp

public long timeStamp()

Specified by:

timeStamp in interface ServiceRequest<R>

Returns:

Time stamp when the request created (client side)

requesterEmail

public java.lang.String requesterEmail()

Specified by:

requesterEmail in interface ServiceRequest<R>

Returns:

Email of the WhiteSource user that issues this request.

userKey

public java.lang.String userKey()

Specified by:

userKey in interface ServiceRequest<R>

Returns:

WhiteSource user key who sent the request.

aggregateModules

public boolean aggregateModules()

Specified by:

aggregateModules in interface ServiceRequest<R>

Returns:

aggregate modules boolean property.

preserveModuleStructure

public boolean preserveModuleStructure()

Specified by:

preserveModuleStructure in interface ServiceRequest<R>

Returns:

preserve module structure boolean property.

aggregateProjectName

public java.lang.String aggregateProjectName()

Specified by:

aggregateProjectName in interface ServiceRequest<R>

Returns:

aggregate project name (name identifier).

aggregateProjectToken

public java.lang.String aggregateProjectToken()

Specified by:

aggregateProjectToken in interface ServiceRequest<R>

Returns:

aggregate project token (token identifier).

logData

public java.lang.String logData()

Specified by:

logData in interface ServiceRequest<R>

Returns:

log data.

scanComment

public java.lang.String scanComment()

Specified by:

scanComment in interface ServiceRequest<R>

Returns:

scan comment.

productToken

public java.lang.String productToken()

Specified by:

productToken in interface ServiceRequest<R>

Returns:

product token.

extraProperties

public java.util.Map<java.lang.String,java.lang.String> extraProperties()

Specified by:

extraProperties in interface ServiceRequest<R>

Returns:

extra Properties.

setAgent

public void setAgent(java.lang.String agent)

setAgentVersion

public void setAgentVersion(java.lang.String agentVersion)

setPluginVersion

public void setPluginVersion(java.lang.String pluginVersion)

setOrgToken

public void setOrgToken(java.lang.String orgToken)

setProduct

public void setProduct(java.lang.String product)

setProductVersion

public void setProductVersion(java.lang.String productVersion)

setTimeStamp

public void setTimeStamp(long timeStamp)

setRequesterEmail

public void setRequesterEmail(java.lang.String requesterEmail)

getProjects

public java.util.Collection<AgentProjectInfo> getProjects()

setProjects

public void setProjects(java.util.Collection<AgentProjectInfo> projects)

setUserKey

public void setUserKey(java.lang.String userKey)

setAggregateModules

public void setAggregateModules(boolean aggregateModules)

setPreserveModuleStructure

public void setPreserveModuleStructure(boolean preserveModuleStructure)

setAggregateProjectName

public void setAggregateProjectName(java.lang.String aggregateProjectName)

setAggregateProjectToken

public void setAggregateProjectToken(java.lang.String aggregateProjectToken)

setLogData

public void setLogData(java.lang.String logData)

setScanComment

public void setScanComment(java.lang.String scanComment)

setProductToken

public void setProductToken(java.lang.String productToken)

getExtraProperties

public java.util.Map<java.lang.String,java.lang.String> getExtraProperties()

setExtraProperties

public void setExtraProperties(java.util.Map<java.lang.String,java.lang.String> extraProperties)

getScanSummaryInfo

public ScanSummaryInfo getScanSummaryInfo()

setScanSummaryInfo

public void setScanSummaryInfo(ScanSummaryInfo scanSummaryInfo)

getContributions

public java.util.Collection<ContributionInfo> getContributions()

setContributions

public void setContributions(java.util.Collection<ContributionInfo> contributions)