io.micronaut.transaction.reactive.ReactiveTransactionOperations Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of micronaut-data-tx Show documentation

Data Repository Support for Micronaut

There is a newer version: 4.9.3

/*
 * Copyright 2017-2020 original 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 io.micronaut.transaction.reactive;

import io.micronaut.core.annotation.NonNull;
import io.micronaut.transaction.TransactionDefinition;
import org.reactivestreams.Publisher;


/**
 * An interface fo reactive transaction management.
 *
 * @param  The connection type
 * @since 2.2.0
 */
public interface ReactiveTransactionOperations {

    /**
     * Execute the given handler with a new transaction.
     * @param definition The definition
     * @param handler The handler
     * @param  The emitted type
     * @return A publisher that emits the result type
     */
    @NonNull
     Publisher withTransaction(@NonNull TransactionDefinition definition, @NonNull TransactionalCallback handler);

    /**
     * Execute the given handler with a new transaction.
     * @param handler The handler
     * @param  The emitted type
     * @return A publisher that emits the result type
     */
    default @NonNull  Publisher withTransaction(@NonNull TransactionalCallback handler) {
        return withTransaction(TransactionDefinition.DEFAULT, handler);
    }

    /**
     * A transactional callback interface.
     *
     * @param  The connection type
     * @param  The emitted type
     */
    @FunctionalInterface
    interface TransactionalCallback {
        /**
         * Invokes the given code passing the {@link ReactiveTransactionStatus}.
         * @param status The status
         * @return A publisher that emits the return type
         */
        Publisher doInTransaction(ReactiveTransactionStatus status);
    }
}