fineract-core/src/main/java/org/apache/fineract/infrastructure/core/domain/BatchRequestContextHolder.java

/**
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements. See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership. The ASF licenses this file
 * to you 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 org.apache.fineract.infrastructure.core.domain;

import java.util.Map;
import java.util.Optional;
import org.springframework.core.NamedThreadLocal;
import org.springframework.transaction.TransactionStatus;

public final class BatchRequestContextHolder {

    private BatchRequestContextHolder() {}

    private static final ThreadLocal<Map<String, Object>> batchAttributes = new NamedThreadLocal<>("batchAttributes");

    private static final ThreadLocal<Optional<TransactionStatus>> batchTransaction = new NamedThreadLocal<>("batchTransaction") {

        @Override
        protected Optional<TransactionStatus> initialValue() {
            return Optional.empty();
        }
    };
    private static final ThreadLocal<Boolean> isEnclosingTransaction = new NamedThreadLocal<>("isEnclosingTransaction");

    /**
     * True if the batch attributes are set
     *
     * @return true if the batch attributes are set
     */
    public static boolean isBatchRequest() {
        return batchAttributes.get() != null;
    }

    /**
     * Returns the batch attributes for the current thread.
     *
     * @return the batch attributes for the current thread, cna be null
     */
    public static Map<String, Object> getRequestAttributes() {
        return batchAttributes.get();
    }

    /**
     * Set the batch attributes for the current thread.
     *
     * @param requestAttributes
     *            the new batch attributes
     */
    public static void setRequestAttributes(Map<String, Object> requestAttributes) {
        batchAttributes.set(requestAttributes);
    }

    /**
     * Reset the batch attributes for the current thread.
     */
    public static void resetRequestAttributes() {
        batchAttributes.remove();
    }

    /**
     * True if the batch attributes are set and the enclosing transaction is set to true
     *
     * @return
     */
    public static boolean isEnclosingTransaction() {
        return Boolean.TRUE.equals(isEnclosingTransaction.get());
    }

    /**
     * Set the isEnclosingTransaction flag for the current thread.
     *
     * @param isEnclosingTransaction
     */
    public static void setIsEnclosingTransaction(boolean isEnclosingTransaction) {
        BatchRequestContextHolder.isEnclosingTransaction.set(isEnclosingTransaction);
    }

    public static void resetIsEnclosingTransaction() {
        isEnclosingTransaction.remove();
    }

    /**
     * Return the transaction
     *
     * @return
     */
    public static Optional<TransactionStatus> getTransaction() {
        return batchTransaction.get();
    }

    /**
     * Return the enclosing transaction
     *
     * @return
     */
    public static Optional<TransactionStatus> getEnclosingTransaction() {
        return isEnclosingTransaction() ? getTransaction() : Optional.empty();
    }

    /**
     * Set the transaction for the current thread.
     *
     * @param enclosingTransaction
     */
    public static void setTransaction(TransactionStatus enclosingTransaction) {
        batchTransaction.set(Optional.ofNullable(enclosingTransaction));
    }

    /**
     * Set the enclosing transaction for the current thread.
     *
     * @param enclosingTransaction
     */
    public static void setEnclosingTransaction(TransactionStatus enclosingTransaction) {
        if (isEnclosingTransaction()) {
            setTransaction(enclosingTransaction);
        }
    }

    public static void resetTransaction() {
        batchTransaction.set(Optional.empty());
    }
}