com.hp.octane.integrations.services.tasking.TasksProcessor 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.tasking;
import com.hp.octane.integrations.OctaneSDK;
import com.hp.octane.integrations.dto.connectivity.OctaneResultAbridged;
import com.hp.octane.integrations.dto.connectivity.OctaneTaskAbridged;
import com.hp.octane.integrations.services.ClosableService;
import com.hp.octane.integrations.services.HasMetrics;
import com.hp.octane.integrations.services.configuration.ConfigurationService;
import java.util.concurrent.Future;
/**
* Tasks Processor handles ALM Octane tasks, both coming from abridged logic as well as plugin's REST call delegation.
* Generally Tasks Processor assumed to be implemented as a singleton, and in any case it should be fully thread safe.
*/
public interface TasksProcessor extends ClosableService, HasMetrics {
/**
* Service instance producer - for internal usage only (protected by inaccessible configurer)
*
* @param configurer SDK services configurer object
* @param configurationService configurationService
* @return initialized service
*/
static TasksProcessor newInstance(OctaneSDK.SDKServicesConfigurer configurer, ConfigurationService configurationService) {
return new TasksProcessorImpl(configurer, configurationService);
}
/**
* Initiates execution of Octane logic oriented task
* @param task task
* @return OctaneResultAbridged
*/
OctaneResultAbridged execute(OctaneTaskAbridged task);
/**
* Clear caches of getJobList
* @return future of result. True if cache is updated. False if there was exception, or content is returned as null or cache is not allowed.
*/
Future resetJobListCache();
}