org.whitesource.agent.client

Class WssServiceClientImpl

java.lang.Object

org.whitesource.agent.client.WssServiceClientImpl

All Implemented Interfaces:

WssServiceClient

public class WssServiceClientImpl
extends Object
implements WssServiceClient

Default Implementation of the interface using Apache's HttpClient.

Author:

tom.shapira, Edo.Shor

Field Summary

Fields

Modifier and Type	Field and Description
protected int	connectionTimeout
protected com.google.gson.Gson	gson
protected org.apache.http.impl.client.CloseableHttpClient	httpClient
protected String	serviceUrl
static String	SOME_PASSWORD

Constructor Summary

Constructors

Constructor and Description
WssServiceClientImpl() Default constructor
WssServiceClientImpl(String serviceUrl) Constructor
WssServiceClientImpl(String serviceUrl, boolean setProxy) Constructor
WssServiceClientImpl(String serviceUrl, boolean setProxy, int connectionTimeoutMinutes)
WssServiceClientImpl(String serviceUrl, boolean setProxy, int connectionTimeoutMinutes, boolean ignoreCertificateCheck) Constructor

Method Summary

Modifier and Type	Method and Description
CheckPoliciesResult	checkPolicies(CheckPoliciesRequest request) The method call the White Source service for checking policies application.
CheckPolicyComplianceResult	checkPolicyCompliance(CheckPolicyComplianceRequest request) The method call the White Source service for checking policies application.
CheckVulnerabilitiesResult	checkVulnerabilities(CheckVulnerabilitiesRequest request) The method calls the White Source service for check vulnerabilities.
protected <R> org.apache.http.client.methods.HttpRequestBase	createHttpRequest(ServiceRequest<R> request) The method create the HTTP post request to be sent to the remote service.
protected String	extractResultData(String response) The method extract the data from the given ResultEnvelope.
int	getConnectionTimeout()
GetDependencyDataResult	getDependencyData(GetDependencyDataRequest request) The method call the White Source service for getting additional dependency data.
org.apache.http.client.HttpClient	getHttpClient()
String	getServiceUrl()
protected <R> R	service(ServiceRequest<R> request) The method service the given request.
void	setConnectionTimeout(int timeout) The method adjust the connection timeout limit to White Source servers.
void	setProxy(String host, int port, String username, String password) The method configure the client to use a proxy specified by the given parameters.
void	shutdown()
SummaryScanResult	summaryScan(SummaryScanRequest request) The method calls the White Source service for inventory update.
UpdateInventoryResult	updateInventory(UpdateInventoryRequest request) The method calls the White Source service for inventory update.

Methods inherited from class java.lang.Object

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

Field Detail

SOME_PASSWORD

public static final String SOME_PASSWORD

See Also:

Constant Field Values

serviceUrl

protected String serviceUrl

httpClient

protected org.apache.http.impl.client.CloseableHttpClient httpClient

gson

protected com.google.gson.Gson gson

connectionTimeout

protected int connectionTimeout

Constructor Detail

WssServiceClientImpl

public WssServiceClientImpl()

Default constructor

WssServiceClientImpl

public WssServiceClientImpl(String serviceUrl)

Constructor

Parameters:

serviceUrl - WhiteSource service URL to use.

WssServiceClientImpl

public WssServiceClientImpl(String serviceUrl,
                            boolean setProxy)

Constructor

Parameters:

serviceUrl - WhiteSource service URL to use.

setProxy - WhiteSource set proxy, whether the proxy settings defined or not.

WssServiceClientImpl

public WssServiceClientImpl(String serviceUrl,
                            boolean setProxy,
                            int connectionTimeoutMinutes)

WssServiceClientImpl

public WssServiceClientImpl(String serviceUrl,
                            boolean setProxy,
                            int connectionTimeoutMinutes,
                            boolean ignoreCertificateCheck)

Constructor

Parameters:

serviceUrl - WhiteSource service URL to use.

setProxy - WhiteSource set proxy, whether the proxy settings is defined or not.

connectionTimeoutMinutes - WhiteSource connection timeout, whether the connection timeout is defined or not (default to 60 minutes).

Method Detail

updateInventory

public UpdateInventoryResult updateInventory(UpdateInventoryRequest request)
                                      throws WssServiceException

Description copied from interface: WssServiceClient

The method calls the White Source service for inventory update.

Specified by:

updateInventory in interface WssServiceClient

Parameters:

request - Inventory update request.

Returns:

Inventory update result.

Throws:

WssServiceException - In case an error occurred during the call to White Source server.

checkPolicies

public CheckPoliciesResult checkPolicies(CheckPoliciesRequest request)
                                  throws WssServiceException

Description copied from interface: WssServiceClient

The method call the White Source service for checking policies application.

Specified by:

checkPolicies in interface WssServiceClient

Parameters:

request - Check Policies request.

Returns:

Check Policies result.

Throws:

WssServiceException - In case an error occurred during the call to White Source server.

checkPolicyCompliance

public CheckPolicyComplianceResult checkPolicyCompliance(CheckPolicyComplianceRequest request)
                                                  throws WssServiceException

Description copied from interface: WssServiceClient

The method call the White Source service for checking policies application.

Specified by:

checkPolicyCompliance in interface WssServiceClient

Parameters:

request - Check Policies request.

Returns:

Check Policies result.

Throws:

WssServiceException - In case an error occurred during the call to White Source server.

getDependencyData

public GetDependencyDataResult getDependencyData(GetDependencyDataRequest request)
                                          throws WssServiceException

Description copied from interface: WssServiceClient

The method call the White Source service for getting additional dependency data.

Specified by:

getDependencyData in interface WssServiceClient

Parameters:

request - Get Dependency Data request.

Returns:

Get Dependency Data result.

Throws:

WssServiceException - In case an error occurred during the call to White Source server.

summaryScan

public SummaryScanResult summaryScan(SummaryScanRequest request)
                              throws WssServiceException

Description copied from interface: WssServiceClient

The method calls the White Source service for inventory update.

Specified by:

summaryScan in interface WssServiceClient

Parameters:

request - Inventory update request.

Returns:

Inventory update result.

Throws:

WssServiceException - In case an error occurred during the call to White Source server.

checkVulnerabilities

public CheckVulnerabilitiesResult checkVulnerabilities(CheckVulnerabilitiesRequest request)
                                                throws WssServiceException

Description copied from interface: WssServiceClient

The method calls the White Source service for check vulnerabilities.

Specified by:

checkVulnerabilities in interface WssServiceClient

Parameters:

request - Check vulnerabilities request.

Returns:

Vulnerabilities report result.

Throws:

WssServiceException - In case an error occurred during the call to White Source server.

shutdown

public void shutdown()

Specified by:

shutdown in interface WssServiceClient

setProxy

public void setProxy(String host,
                     int port,
                     String username,
                     String password)

Description copied from interface: WssServiceClient

The method configure the client to use a proxy specified by the given parameters.

Specified by:

setProxy in interface WssServiceClient

Parameters:

host - Proxy host address.

port - Proxy port.

username - Optional. Proxy username.

password - Optional. Proxy password.

setConnectionTimeout

public void setConnectionTimeout(int timeout)

Description copied from interface: WssServiceClient

The method adjust the connection timeout limit to White Source servers.

Specified by:

setConnectionTimeout in interface WssServiceClient

Parameters:

timeout - In milliseconds.

service

protected <R> R service(ServiceRequest<R> request)
                 throws WssServiceException

The method service the given request.

Parameters:

request - Request to serve.

Returns:

Result from WhiteSource service.

Throws:

WssServiceException - In case of errors while serving the request.

createHttpRequest

protected <R> org.apache.http.client.methods.HttpRequestBase createHttpRequest(ServiceRequest<R> request)
                                                                        throws IOException

The method create the HTTP post request to be sent to the remote service.

Parameters:

request - Request to service.

Returns:

Newly created HTTP post request.

Throws:

IOException - In case of error creating the request.

extractResultData

protected String extractResultData(String response)
                            throws IOException,
                                   WssServiceException

The method extract the data from the given ResultEnvelope.

Parameters:

response - HTTP response as string.

Returns:

String with logical result in JSON format.

Throws:

IOException

WssServiceException

getServiceUrl

public String getServiceUrl()

getHttpClient

public org.apache.http.client.HttpClient getHttpClient()

getConnectionTimeout

public int getConnectionTimeout()