com.hp.octane.integrations.services.vulnerabilities.VulnerabilitiesToolService Maven / Gradle / Ivy
/**
* Copyright 2017-2023 Open Text
*
* The only warranties for products and services of Open Text and
* its affiliates and licensors (“Open Text”) are as may be set forth
* in the express warranty statements accompanying such products and services.
* Nothing herein should be construed as constituting an additional warranty.
* Open Text shall not be liable for technical or editorial errors or
* omissions contained herein. The information contained herein is subject
* to change without notice.
*
* Except as specifically indicated otherwise, this document contains
* confidential information and a valid license is required for possession,
* use or copying. If this work is provided to the U.S. Government,
* consistent with FAR 12.211 and 12.212, Commercial Computer Software,
* Computer Software Documentation, and Technical Data for Commercial Items are
* licensed to the U.S. Government under vendor's standard commercial license.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.hp.octane.integrations.services.vulnerabilities;
import com.hp.octane.integrations.OctaneSDK;
import com.hp.octane.integrations.services.rest.RestService;
import java.io.IOException;
import java.io.InputStream;
import java.util.List;
/**
* represent service handling specific vulnerabilities Tool (e.g sonarqube, ssc) date fetching, and logic.
*/
public interface VulnerabilitiesToolService {
String getVulnerabilitiesToolKey();
/**
* get Vulnerabilities from external tool
* @param queueItem queueItem
* @return input stream of json with issues from the vulnerabilities tool rest API
* @throws IOException IOException
*/
InputStream getVulnerabilitiesScanResultStream(VulnerabilitiesQueueItem queueItem) throws IOException;
/**
* clean up of data retrieved by the vulnerability tool (usallly from cache)
* @param queueItem queueItem
* @return true is cleaned
*/
boolean vulnerabilitiesQueueItemCleanUp(VulnerabilitiesQueueItem queueItem);
RestService getRestService();
OctaneSDK.SDKServicesConfigurer getConfigurer();
default List getRemoteIdsOfExistIssuesFromOctane(VulnerabilitiesQueueItem vulnerabilitiesQueueItem, String remoteTag) throws IOException {
ExistingIssuesInOctane existingIssuesInOctane = new ExistingIssuesInOctane(
getRestService().obtainOctaneRestClient(),
getConfigurer().octaneConfiguration);
return existingIssuesInOctane.getRemoteIdsOpenVulnsFromOctane(vulnerabilitiesQueueItem.getJobId(),
vulnerabilitiesQueueItem.getBuildId(),
remoteTag);
}
}