com.epam.reportportal.utils.ClientIdProvider Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of client-java Show documentation
Asynchronous client for Java-based agents
There is a newer version: 5.2.21
/*
 *  Copyright 2023 EPAM Systems
 *
 *  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.epam.reportportal.utils;

import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import java.io.IOException;
import java.nio.file.Files;
import java.nio.file.Path;
import java.nio.file.Paths;
import java.nio.file.StandardOpenOption;
import java.util.Properties;
import java.util.UUID;

/**
 * A static class which contains methods to get current Client ID.
 */
public class ClientIdProvider {
	private ClientIdProvider() {
		throw new IllegalStateException("Static only class");
	}


	private static final String CLIENT_ID_PROPERTY = "client.id";
	public static final Path RP_PROPERTIES_FILE_PATH = Paths.get(System.getProperty("user.home"), ".rp", "rp.properties");

	@Nullable
	private static String readClientId() {
		Properties properties = new Properties();
		if (Files.exists(RP_PROPERTIES_FILE_PATH)) {
			try {
				properties.load(Files.newInputStream(RP_PROPERTIES_FILE_PATH, StandardOpenOption.READ));
			} catch (IOException ignore) {
				// do nothing on read error, client ID will be always new
			}
			return properties.getProperty(CLIENT_ID_PROPERTY);
		}
		return null;
	}

	private static void storeClientId(@Nonnull String clientId) {
		Path folder = RP_PROPERTIES_FILE_PATH.getParent();
		try {
			if (!Files.exists(folder)) {
				Files.createDirectories(folder);
			}
			Properties properties = new Properties();
			if (Files.exists(RP_PROPERTIES_FILE_PATH)) {
				properties.load(Files.newInputStream(RP_PROPERTIES_FILE_PATH, StandardOpenOption.READ));
			}
			properties.put(CLIENT_ID_PROPERTY, clientId);
			properties.store(Files.newOutputStream(RP_PROPERTIES_FILE_PATH, StandardOpenOption.CREATE), null);
		} catch (IOException ignore) {
			// do nothing on saving error, client ID will be always new
		}
	}

	/**
	 * Return current Client ID, generate new in case of errors.
	 *
	 * @return Client ID String
	 */
	@Nonnull
	public static String getClientId() {
		String clientId = readClientId();
		if (clientId == null) {
			clientId = UUID.randomUUID().toString();
			storeClientId(clientId);
		}
		return clientId;
	}
}