com.hp.octane.integrations.services.queueing.QueueingServiceImpl Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of integrations-sdk Show documentation
The newest version!
/*
 * Copyright 2017-2025 Open Text
 *
 * OpenText is a trademark of 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.hp.octane.integrations.OctaneSDK;
import com.hp.octane.integrations.utils.CIPluginSDKUtils;
import com.squareup.tape.FileObjectQueue;
import com.squareup.tape.InMemoryObjectQueue;
import com.squareup.tape.ObjectQueue;
import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;

import java.io.File;
import java.io.IOException;
import java.io.OutputStream;
import java.util.LinkedList;
import java.util.List;

/**
 * Queue Service provides a common queue infrastructure, initialization and maintenance
 */

final class QueueingServiceImpl implements QueueingService {
	private static final Logger logger = LogManager.getLogger(QueueingServiceImpl.class);
	private final File storageDirectory;
	private final List fileObjectQueues = new LinkedList<>();
	private boolean isShutdown;

	QueueingServiceImpl(OctaneSDK.SDKServicesConfigurer configurer) {
		if (configurer == null) {
			throw new IllegalArgumentException("invalid configurer");
		}

		//  check persistence availability
		if (configurer.pluginServices.getAllowedOctaneStorage() != null) {
			storageDirectory = new File(configurer.pluginServices.getAllowedOctaneStorage(), "nga" + File.separator + configurer.octaneConfiguration.getInstanceId());
			if (!storageDirectory.mkdirs()) {
				logger.info(configurer.octaneConfiguration.getLocationForLog() + "storage directories structure assumed to be present");
			}
			logger.info(configurer.octaneConfiguration.getLocationForLog() + "hosting plugin PROVIDE available storage, queues persistence enabled");
		} else {
			storageDirectory = null;
			logger.info(configurer.octaneConfiguration.getLocationForLog() + "hosting plugin DO NOT PROVIDE available storage, queues persistence disabled");
		}
	}

	@Override
	public boolean isPersistenceEnabled() {
		return storageDirectory != null;
	}

	@Override
	public  ObjectQueue initMemoQueue() {
		return new InMemoryObjectQueue<>();
	}

	@Override
	public  ObjectQueue initFileQueue(String queueFileName, Class targetType) {
		ObjectQueue result;
		try {
			File queueFile = new File(storageDirectory, queueFileName);
			FileObjectQueue tmp = new FileObjectQueue<>(queueFile, new GenericOctaneQueueItemConverter<>(targetType));
			fileObjectQueues.add(tmp);
			result = tmp;
		} catch (Exception e) {
			logger.error("failed to create file based queue, falling back to memory based one", e);
			result = initMemoQueue();
		}
		return result;
	}

	@Override
	public void shutdown() {
		isShutdown = true;
		fileObjectQueues.forEach(fileObjectQueue -> {
			try {
				fileObjectQueue.close();
			} catch (Exception e) {
				logger.error("failed to close " + fileObjectQueue, e);
			}
		});
	}

	@Override
	public boolean isShutdown() {
		return isShutdown;
	}

	private static final class GenericOctaneQueueItemConverter implements FileObjectQueue.Converter {
		private final Class targetType;

		private GenericOctaneQueueItemConverter(Class targetType) {
			this.targetType = targetType;
		}

		@Override
		public T from(byte[] bytes) throws IOException {
			return CIPluginSDKUtils.getObjectMapper().readValue(bytes, targetType);
		}

		@Override
		public void toStream(T t, OutputStream outputStream) throws IOException {
			CIPluginSDKUtils.getObjectMapper().writeValue(outputStream, t);
		}
	}
}