org.springframework.data.cassandra.core.mapping.event.ReactiveBeforeSaveCallback Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of spring-data-cassandra Show documentation

Cassandra support for Spring Data

There is a newer version: 4.3.2

Show newest version

/*
 * Copyright 2019-2024 the original author or authors.
 *
 * 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
 *
 *      https://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 org.springframework.data.cassandra.core.mapping.event;

import org.reactivestreams.Publisher;
import org.springframework.data.mapping.callback.EntityCallback;

import com.datastax.oss.driver.api.core.CqlIdentifier;
import com.datastax.oss.driver.api.core.cql.Statement;

/**
 * Entity callback invoked before inserting or updating a row in the database. Before save is invoked after
 * {@link BeforeConvertCallback converting the entity} into a {@link Statement}. This is useful to let the mapping layer
 * derive values into the statement while the save callback can either update the domain object without reflecting the
 * changes in the statement. Another use is to inspect the {@link Statement}.
 *
 * @author Mark Paluch
 * @since 2.2
 * @see org.springframework.data.mapping.callback.ReactiveEntityCallbacks
 * @see ReactiveBeforeConvertCallback
 */
@FunctionalInterface
public interface ReactiveBeforeSaveCallback extends EntityCallback {
	// TODO: Mutable statements
	/**
	 * Entity callback method invoked before save. That is, before running the {@code INSERT}/{@code UPDATE}
	 * {@link Statement} derived from the intent to save an object. Can return either the same of a modified instance of
	 * the domain object and can inspect the {@link Statement} contents. This method is called after converting the
	 * {@code entity} to {@link Statement} so effectively the entity is propagated as outcome of invoking this callback.
	 *
	 * @param entity the domain object to save.
	 * @param tableName name of the table.
	 * @param statement {@link Statement} representing the {@code entity} operation.
	 * @return a {@link Publisher} emitting the domain object to be persisted.
	 */
	Publisher onBeforeSave(T entity, CqlIdentifier tableName, Statement statement);
}