core/store/primitives/src/main/java/org/onosproject/store/primitives/impl/DefaultTransactionContext.java

/*
 * Copyright 2016-present Open Networking Foundation
 *
 * 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 org.onosproject.store.primitives.impl;

import java.util.concurrent.CompletableFuture;
import java.util.concurrent.atomic.AtomicBoolean;

import org.onosproject.store.primitives.TransactionId;
import org.onosproject.store.service.CommitStatus;
import org.onosproject.store.service.Serializer;
import org.onosproject.store.service.TransactionContext;
import org.onosproject.store.service.TransactionalMap;
import org.onosproject.utils.MeteringAgent;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import static com.google.common.base.MoreObjects.toStringHelper;
import static com.google.common.base.Preconditions.checkState;

/**
 * Default implementation of transaction context.
 */
public class DefaultTransactionContext implements TransactionContext {
    private final Logger log = LoggerFactory.getLogger(getClass());
    private final AtomicBoolean isOpen = new AtomicBoolean(false);
    private final TransactionId transactionId;
    private final TransactionCoordinator transactionCoordinator;
    private final MeteringAgent monitor;

    public DefaultTransactionContext(TransactionId transactionId, TransactionCoordinator transactionCoordinator) {
        this.transactionId = transactionId;
        this.transactionCoordinator = transactionCoordinator;
        this.monitor = new MeteringAgent("transactionContext", "*", true);
    }

    @Override
    public String name() {
        return transactionId.toString();
    }

    @Override
    public TransactionId transactionId() {
        return transactionId;
    }

    @Override
    public boolean isOpen() {
        return isOpen.get();
    }

    @Override
    public void begin() {
        if (isOpen.compareAndSet(false, true)) {
            log.trace("Opened transaction {}", transactionId);
        } else {
            throw new IllegalStateException("TransactionContext is already open");
        }
    }

    @Override
    public CompletableFuture<CommitStatus> commit() {
        checkState(isOpen.get(), "Transaction not open");
        final MeteringAgent.Context timer = monitor.startTimer("commit");
        log.debug("Committing transaction {}", transactionId);
        return transactionCoordinator.commit().whenComplete((r, e) -> timer.stop(e));
    }

    @Override
    public void abort() {
        if (isOpen.compareAndSet(true, false)) {
            log.debug("Aborted transaction {}", transactionId);
        }
    }

    @Override
    public <K, V> TransactionalMap<K, V> getTransactionalMap(String mapName, Serializer serializer) {
        return transactionCoordinator.getTransactionalMap(mapName, serializer);
    }

    @Override
    public String toString() {
        return toStringHelper(this)
                .add("transactionId", transactionId)
                .toString();
    }
}