| /* |
| * 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.bookkeeper.mledger.impl; |
| |
| import java.util.List; |
| import java.util.Map; |
| import java.util.concurrent.CompletableFuture; |
| import org.apache.bookkeeper.mledger.ManagedLedgerException.MetaStoreException; |
| import org.apache.bookkeeper.mledger.proto.MLDataFormats.ManagedCursorInfo; |
| import org.apache.bookkeeper.mledger.proto.MLDataFormats.ManagedLedgerInfo; |
| import org.apache.pulsar.metadata.api.Stat; |
| |
| /** |
| * Interface that describes the operations that the ManagedLedger need to do on the metadata store. |
| */ |
| public interface MetaStore { |
| |
| @SuppressWarnings("checkstyle:javadoctype") |
| interface UpdateLedgersIdsCallback { |
| void updateLedgersIdsComplete(MetaStoreException status, Stat stat); |
| } |
| |
| @SuppressWarnings("checkstyle:javadoctype") |
| interface MetaStoreCallback<T> { |
| void operationComplete(T result, Stat stat); |
| |
| void operationFailed(MetaStoreException e); |
| } |
| |
| interface UpdateCallback<T> { |
| void onUpdate(T result, Stat stat); |
| } |
| |
| /** |
| * Get the metadata used by the ManagedLedger. |
| * |
| * @param ledgerName |
| * the name of the ManagedLedger |
| * @param createIfMissing |
| * whether the managed ledger metadata should be created if it doesn't exist already |
| * @throws MetaStoreException |
| */ |
| default void getManagedLedgerInfo(String ledgerName, boolean createIfMissing, |
| MetaStoreCallback<ManagedLedgerInfo> callback) { |
| getManagedLedgerInfo(ledgerName, createIfMissing, null, callback); |
| } |
| |
| /** |
| * Get the metadata used by the ManagedLedger. |
| * |
| * @param ledgerName |
| * the name of the ManagedLedger |
| * @param createIfMissing |
| * whether the managed ledger metadata should be created if it doesn't exist already |
| * @param properties |
| * ledger properties |
| * @throws MetaStoreException |
| */ |
| void getManagedLedgerInfo(String ledgerName, boolean createIfMissing, Map<String, String> properties, |
| MetaStoreCallback<ManagedLedgerInfo> callback); |
| |
| /** |
| * Watch the metadata used by the ManagedLedger. |
| * @param ledgerName |
| * @param callback |
| */ |
| void watchManagedLedgerInfo(String ledgerName, UpdateCallback<ManagedLedgerInfo> callback); |
| |
| /** |
| * Unwatch the metadata changes for ledgerName. |
| * @param ledgerName |
| */ |
| void unwatchManagedLedgerInfo(String ledgerName); |
| |
| /** |
| * |
| * @param ledgerName |
| * the name of the ManagedLedger |
| * @param mlInfo |
| * managed ledger info |
| * @param stat |
| * version object associated with current state |
| * @param callback |
| * callback object |
| */ |
| void asyncUpdateLedgerIds(String ledgerName, ManagedLedgerInfo mlInfo, Stat stat, |
| MetaStoreCallback<Void> callback); |
| |
| /** |
| * Get the list of cursors registered on a ManagedLedger. |
| * |
| * @param ledgerName |
| * the name of the ManagedLedger |
| */ |
| void getCursors(String ledgerName, MetaStoreCallback<List<String>> callback); |
| |
| /** |
| * Get the ledger id associated with a cursor. |
| * |
| * <p/>This ledger id will contains the mark-deleted position for the cursor. |
| * |
| * @param ledgerName |
| * @param cursorName |
| * @param callback |
| */ |
| void asyncGetCursorInfo(String ledgerName, String cursorName, MetaStoreCallback<ManagedCursorInfo> callback); |
| |
| /** |
| * Update the persisted position of a cursor. |
| * |
| * @param ledgerName |
| * the name of the ManagedLedger |
| * @param cursorName |
| * @param info |
| * @param stat |
| * @param callback |
| * the callback |
| * @throws MetaStoreException |
| */ |
| void asyncUpdateCursorInfo(String ledgerName, String cursorName, ManagedCursorInfo info, Stat stat, |
| MetaStoreCallback<Void> callback); |
| |
| /** |
| * Drop the persistent state of a consumer from the metadata store. |
| * |
| * @param ledgerName |
| * the name of the ManagedLedger |
| * @param cursorName |
| * the cursor name |
| * @param callback |
| * callback object |
| */ |
| void asyncRemoveCursor(String ledgerName, String cursorName, MetaStoreCallback<Void> callback); |
| |
| /** |
| * Drop the persistent state for the ManagedLedger and all its associated consumers. |
| * |
| * @param ledgerName |
| * the name of the ManagedLedger |
| * @param callback |
| * callback object |
| */ |
| void removeManagedLedger(String ledgerName, MetaStoreCallback<Void> callback); |
| |
| /** |
| * Get a list of all the managed ledgers in the system. |
| * |
| * @return an Iterable of the names of the managed ledgers |
| * @throws MetaStoreException |
| */ |
| Iterable<String> getManagedLedgers() throws MetaStoreException; |
| |
| /** |
| * Check ledger exists. |
| * |
| * @param ledgerName {@link String} |
| * @return a future represents the result of the operation. |
| * an instance of {@link Boolean} is returned |
| * if the operation succeeds. |
| */ |
| CompletableFuture<Boolean> asyncExists(String ledgerName); |
| |
| |
| /** |
| * Get managed ledger properties from meta store. |
| * |
| * @param name ledgerName |
| * @return a future represents the result of the operation. |
| */ |
| CompletableFuture<Map<String, String>> getManagedLedgerPropertiesAsync(String name); |
| } |