org.whitesource.agent.api.dispatch

Interface ServiceRequest<R>

Type Parameters:

R - Result type

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

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

public interface ServiceRequest<R>
extends java.io.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
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.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()
long	timeStamp()
RequestType	type()
java.lang.String	userKey()

Method Detail

type

RequestType type()

Returns:

Request type.

agent

java.lang.String agent()

Returns:

Agent type identifier.

agentVersion

java.lang.String agentVersion()

Returns:

Agent API version.

orgToken

java.lang.String orgToken()

Returns:

WhiteSource service token of the organization to update.

product

java.lang.String product()

Returns:

Name or WhiteSource service token of the product to update.

productVersion

java.lang.String productVersion()

Returns:

Version of the product to update.

timeStamp

long timeStamp()

Returns:

Time stamp when the request created (client side)

requesterEmail

java.lang.String requesterEmail()

Returns:

Email of the WhiteSource user that issues this request.

pluginVersion

java.lang.String pluginVersion()

Returns:

Plugin version.

userKey

java.lang.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

java.lang.String aggregateProjectName()

Returns:

aggregate project name (name identifier).

aggregateProjectToken

java.lang.String aggregateProjectToken()

Returns:

aggregate project token (token identifier).

logData

java.lang.String logData()

Returns:

log data.

scanComment

java.lang.String scanComment()

Returns:

scan comment.

productToken

java.lang.String productToken()

Returns:

product token.

extraProperties

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

Returns:

extra Properties.