io.evitadb.api.requestResponse.transaction.TransactionMutation Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of evita_api Show documentation
Module contains external API of the evitaDB.
The newest version!
/*
 *
 *                         _ _        ____  ____
 *               _____   _(_) |_ __ _|  _ \| __ )
 *              / _ \ \ / / | __/ _` | | | |  _ \
 *             |  __/\ V /| | || (_| | |_| | |_) |
 *              \___| \_/ |_|\__\__,_|____/|____/
 *
 *   Copyright (c) 2024
 *
 *   Licensed under the Business Source License, Version 1.1 (the "License");
 *   you may not use this file except in compliance with the License.
 *   You may obtain a copy of the License at
 *
 *   https://github.com/FgForrest/evitaDB/blob/master/LICENSE
 *
 *   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 io.evitadb.api.requestResponse.transaction;

import io.evitadb.api.requestResponse.cdc.CaptureContent;
import io.evitadb.api.requestResponse.cdc.ChangeCatalogCapture;
import io.evitadb.api.requestResponse.cdc.Operation;
import io.evitadb.api.requestResponse.mutation.Mutation;
import io.evitadb.api.requestResponse.mutation.MutationPredicate;
import io.evitadb.api.requestResponse.mutation.MutationPredicateContext;
import lombok.EqualsAndHashCode;
import lombok.Getter;

import javax.annotation.Nonnull;
import java.io.Serial;
import java.time.OffsetDateTime;
import java.util.UUID;
import java.util.stream.Stream;

/**
 * This transaction mutation delimits mutations of one transaction from another. It contains data that allow to recognize
 * the scope of the transaction and verify its integrity.
 *
 * @author Jan Novotný ([email protected]), FG Forrest a.s. (c) 2024
 */
@EqualsAndHashCode
public non-sealed class TransactionMutation implements Mutation {
	@Serial private static final long serialVersionUID = -8039363287149601917L;
	/**
	 * Represents the unique identifier of a transaction.
	 */
	@Getter private final UUID transactionId;
	/**
	 * Represents the catalog version the transaction is based on.
	 */
	@Getter private final long catalogVersion;
	/**
	 * Represents the number of mutations in this particular transaction.
	 */
	@Getter private final int mutationCount;
	/**
	 * Represents the size of the serialized transaction mutations that follow this mutation in bytes.
	 */
	@Getter private final long walSizeInBytes;
	/**
	 * Represents the timestamp of the commit.
	 */
	@Getter private final OffsetDateTime commitTimestamp;

	public TransactionMutation(
		@Nonnull UUID transactionId,
		long catalogVersion,
		int mutationCount,
		long walSizeInBytes,
		@Nonnull OffsetDateTime commitTimestamp
	) {
		this.transactionId = transactionId;
		this.catalogVersion = catalogVersion;
		this.mutationCount = mutationCount;
		this.walSizeInBytes = walSizeInBytes;
		this.commitTimestamp = commitTimestamp;
	}

	@Nonnull
	@Override
	public Operation operation() {
		return Operation.TRANSACTION;
	}

	@Nonnull
	@Override
	public Stream toChangeCatalogCapture(
		@Nonnull MutationPredicate predicate,
		@Nonnull CaptureContent content
	) {
		if (predicate.test(this)) {
			final MutationPredicateContext context = predicate.getContext();
			context.setVersion(this.catalogVersion, this.mutationCount);

			return Stream.of(
				ChangeCatalogCapture.infrastructureCapture(context, operation(), content == CaptureContent.BODY ? this : null)
			);
		} else {
			return Stream.empty();
		}
	}

	@Override
	public String toString() {
		return "transaction commit `" + transactionId + "` (moves catalog to version `" + catalogVersion + "`)";
	}
}