com.hp.octane.integrations.services.queueing.QueueingService 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.queueing;
import com.fasterxml.jackson.annotation.JsonAutoDetect;
import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
import com.hp.octane.integrations.OctaneSDK;
import com.hp.octane.integrations.services.ClosableService;
import com.squareup.tape.ObjectQueue;
public interface QueueingService extends ClosableService {
/**
* Service instance producer - for internal usage only (protected by inaccessible configurer)
*
* @param configurer SDK services configurer object
* @return initialized service
*/
static QueueingService newInstance(OctaneSDK.SDKServicesConfigurer configurer) {
return new QueueingServiceImpl(configurer);
}
/**
* Checks if the persistence of the queues is enabled in this system (hosting plugin provided storage etc)
*
* @return boolean result
*/
boolean isPersistenceEnabled();
/**
* Initializes memory based queue
*
* @param type of an item of the queue
* @return initialized queue
*/
ObjectQueue initMemoQueue();
/**
* Initializes file based queue
* If the initialization fails for some reason, falls back to memory based queue and write log about this
*
* @param queueFileName file name to store the queue items in; service will attempt to create the file in the allowed storage folder
* @param targetType type of an item of the queue in explicit way (for initialization needs)
* @param type of an item of the queue
* @return initialized queue
*/
ObjectQueue initFileQueue(String queueFileName, Class targetType);
@JsonAutoDetect(fieldVisibility = JsonAutoDetect.Visibility.ANY)
@JsonIgnoreProperties(ignoreUnknown = true)
interface QueueItem {
}
}