org.whitesource.agent.api.dispatch

Interface ServiceRequest<R>

Type Parameters:

R - Result type

All Superinterfaces:

Serializable

All Known Implementing Classes:

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

public interface ServiceRequest<R>
extends Serializable

The interface describe the functionality to be exposed by any request to the WhiteSource service.

Author:

Edo.Shor

Method Summary

Modifier and Type	Method and Description
String	agent()
String	agentVersion()
boolean	aggregateModules()
String	aggregateProjectName()
String	aggregateProjectToken()
Map<String,String>	extraProperties()
String	logData()
String	orgToken()
String	pluginVersion()
boolean	preserveModuleStructure()
String	product()
String	productToken()
String	productVersion()
String	requesterEmail()
String	scanComment()
long	timeStamp()
RequestType	type()
String	userKey()

Method Detail

type

RequestType type()

Returns:

Request type.

agent

String agent()

Returns:

Agent type identifier.

agentVersion

String agentVersion()

Returns:

Agent API version.

orgToken

String orgToken()

Returns:

WhiteSource service token of the organization to update.

product

String product()

Returns:

Name or WhiteSource service token of the product to update.

productVersion

String productVersion()

Returns:

Version of the product to update.

timeStamp

long timeStamp()

Returns:

Time stamp when the request created (client side)

requesterEmail

String requesterEmail()

Returns:

Email of the WhiteSource user that issues this request.

pluginVersion

String pluginVersion()

Returns:

Plugin version.

userKey

String userKey()

Returns:

WhiteSource user key who sent the request.

aggregateModules

boolean aggregateModules()

Returns:

aggregate modules boolean property.

preserveModuleStructure

boolean preserveModuleStructure()

Returns:

preserve module structure boolean property.

aggregateProjectName

String aggregateProjectName()

Returns:

aggregate project name (name identifier).

aggregateProjectToken

String aggregateProjectToken()

Returns:

aggregate project token (token identifier).

logData

String logData()

Returns:

log data.

scanComment

String scanComment()

Returns:

scan comment.

productToken

String productToken()

Returns:

product token.

extraProperties

Map<String,String> extraProperties()

Returns:

extra Properties.