com.palantir.atlasdb.spi.TransactionKeyValueServiceManagerFactory Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of atlasdb-api Show documentation

Palantir open source project

There is a newer version: 0.1152.0

/*
 * (c) Copyright 2024 Palantir Technologies Inc. All rights reserved.
 *
 * 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 com.palantir.atlasdb.spi;

import com.palantir.atlasdb.cell.api.TransactionKeyValueServiceManager;
import com.palantir.atlasdb.coordination.CoordinationService;
import com.palantir.atlasdb.util.MetricsManager;
import com.palantir.dialogue.clients.DialogueClients;
import com.palantir.refreshable.Refreshable;

/**
 * Factory for creating {@link TransactionKeyValueServiceManager} instances.
 *
 * Implementations have access to the coordination service to be able query their internal state at a particular
 * timestamp, as well as schedule changes to it at a future timestamp.
 *
 * AtlasDb will ensure that transactions that span state changes do not succeed and non-transactional workflows
 * are also retried.
 *
 * @param  type used for the coordination state. Should be a jackson-compatible POJO.
 */
public interface TransactionKeyValueServiceManagerFactory {

    String getType();

    Class coordinationValueClass();

    TransactionKeyValueServiceManager create(
            String namespace,
            DialogueClients.ReloadingFactory reloadingFactory,
            MetricsManager metricsManager,
            CoordinationService coordinationService,
            KeyValueServiceManager keyValueServiceManager,
            TransactionKeyValueServiceConfig install,
            Refreshable runtime,
            boolean initializeAsync);
}