2 * Copyright (c) 2016 Cisco Systems, Inc. and others. All rights reserved.
4 * This program and the accompanying materials are made available under the
5 * terms of the Eclipse Public License v1.0 which accompanies this distribution,
6 * and is available at http://www.eclipse.org/legal/epl-v10.html
8 package org.opendaylight.controller.cluster.databroker.actors.dds;
10 import com.google.common.annotations.Beta;
11 import javax.annotation.Nonnull;
12 import org.opendaylight.controller.cluster.access.concepts.ClientIdentifier;
13 import org.opendaylight.yangtools.concepts.Identifiable;
16 * Client interface for interacting with the frontend actor. This interface is the primary access point through
17 * which the DistributedDataStore frontend interacts with backend Shards.
20 * Keep this interface as clean as possible, as it needs to be implemented in thread-safe and highly-efficient manner.
22 * @author Robert Varga
25 public interface DataStoreClient extends Identifiable<ClientIdentifier>, AutoCloseable {
27 @Nonnull ClientIdentifier getIdentifier();
33 * Create a new local history. ClientLocalHistory represents the interface exposed to the client.
35 * @return Client history handle
37 @Nonnull ClientLocalHistory createLocalHistory();
40 * Create a new free-standing snapshot.
42 * @return Client snapshot handle
44 @Nonnull ClientSnapshot createSnapshot();
47 * Create a new free-standing transaction.
49 * @return Client transaction handle
51 @Nonnull ClientTransaction createTransaction();