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:

Serializable, ServiceRequest<R>

Direct Known Subclasses:

CheckPoliciesRequest, CheckPolicyComplianceRequest, CheckVulnerabilitiesRequest, ConfigurationRequest, GetDependencyDataRequest, SummaryScanRequest, UpdateInventoryRequest

public abstract class BaseRequest<R>
extends 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 String	agent
protected String	agentVersion
protected boolean	aggregateModules
protected String	aggregateProjectName
protected String	aggregateProjectToken
protected String	logData
protected String	orgToken
protected String	pluginVersion
protected boolean	preserveModuleStructure
protected String	product
protected String	productVersion
protected Collection<AgentProjectInfo>	projects
protected String	requesterEmail
protected long	timeStamp
protected RequestType	type
protected String	userKey

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
String	agent()
String	agentVersion()
boolean	aggregateModules()
String	aggregateProjectName()
String	aggregateProjectToken()
Collection<AgentProjectInfo>	getProjects()
String	logData()
String	orgToken()
String	pluginVersion()
boolean	preserveModuleStructure()
String	product()
String	productVersion()
String	requesterEmail()
void	setAgent(String agent)
void	setAgentVersion(String agentVersion)
void	setAggregateModules(boolean aggregateModules)
void	setAggregateProjectName(String aggregateProjectName)
void	setAggregateProjectToken(String aggregateProjectToken)
void	setLogData(String logData)
void	setOrgToken(String orgToken)
void	setPluginVersion(String pluginVersion)
void	setPreserveModuleStructure(boolean preserveModuleStructure)
void	setProduct(String product)
void	setProductVersion(String productVersion)
void	setProjects(Collection<AgentProjectInfo> projects)
void	setRequesterEmail(String requesterEmail)
void	setTimeStamp(long timeStamp)
void	setUserKey(String userKey)
long	timeStamp()
RequestType	type()
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 String agent

agentVersion

protected String agentVersion

pluginVersion

protected String pluginVersion

orgToken

protected String orgToken

userKey

protected String userKey

product

protected String product

productVersion

protected String productVersion

timeStamp

protected long timeStamp

requesterEmail

protected String requesterEmail

projects

protected Collection<AgentProjectInfo> projects

aggregateModules

protected boolean aggregateModules

preserveModuleStructure

protected boolean preserveModuleStructure

aggregateProjectName

protected String aggregateProjectName

aggregateProjectToken

protected String aggregateProjectToken

logData

protected String logData

Constructor Detail

BaseRequest

public BaseRequest(RequestType type)

Constructor

Parameters:

type - Request operation type.

BaseRequest

public BaseRequest(RequestType type,
                   String agent)

Constructor

Parameters:

type - Request operation type.

agent - Agent type identifier.

BaseRequest

public BaseRequest(RequestType type,
                   String agent,
                   String agentVersion,
                   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 String orgToken()

Specified by:

orgToken in interface ServiceRequest<R>

Returns:

WhiteSource service token of the organization to update.

agent

public String agent()

Specified by:

agent in interface ServiceRequest<R>

Returns:

Agent type identifier.

agentVersion

public String agentVersion()

Specified by:

agentVersion in interface ServiceRequest<R>

Returns:

Agent API version.

pluginVersion

public String pluginVersion()

Specified by:

pluginVersion in interface ServiceRequest<R>

Returns:

Plugin version.

product

public String product()

Specified by:

product in interface ServiceRequest<R>

Returns:

Name or WhiteSource service token of the product to update.

productVersion

public 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 String requesterEmail()

Specified by:

requesterEmail in interface ServiceRequest<R>

Returns:

Email of the WhiteSource user that issues this request.

userKey

public 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 String aggregateProjectName()

Specified by:

aggregateProjectName in interface ServiceRequest<R>

Returns:

aggregate project name (name identifier).

aggregateProjectToken

public String aggregateProjectToken()

Specified by:

aggregateProjectToken in interface ServiceRequest<R>

Returns:

aggregate project token (token identifier).

logData

public String logData()

Specified by:

logData in interface ServiceRequest<R>

setAgent

public void setAgent(String agent)

setAgentVersion

public void setAgentVersion(String agentVersion)

setPluginVersion

public void setPluginVersion(String pluginVersion)

setOrgToken

public void setOrgToken(String orgToken)

setProduct

public void setProduct(String product)

setProductVersion

public void setProductVersion(String productVersion)

setTimeStamp

public void setTimeStamp(long timeStamp)

setRequesterEmail

public void setRequesterEmail(String requesterEmail)

getProjects

public Collection<AgentProjectInfo> getProjects()

setProjects

public void setProjects(Collection<AgentProjectInfo> projects)

setUserKey

public void setUserKey(String userKey)

setAggregateModules

public void setAggregateModules(boolean aggregateModules)

setPreserveModuleStructure

public void setPreserveModuleStructure(boolean preserveModuleStructure)

setAggregateProjectName

public void setAggregateProjectName(String aggregateProjectName)

setAggregateProjectToken

public void setAggregateProjectToken(String aggregateProjectToken)

setLogData

public void setLogData(String logData)