org.apache.bookkeeper.client.api.BookKeeper Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of bookkeeper-server
There is a newer version: 4.17.1
/*
 *
 * 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.client.api;

import java.util.concurrent.CompletableFuture;
import org.apache.bookkeeper.client.impl.BookKeeperBuilderImpl;
import org.apache.bookkeeper.common.annotation.InterfaceAudience.Public;
import org.apache.bookkeeper.common.annotation.InterfaceStability.Unstable;
import org.apache.bookkeeper.conf.ClientConfiguration;

/**
 * This is the entry point for BookKeeper client side API.
 *
 * @since 4.6
 */
@Public
@Unstable
public interface BookKeeper extends AutoCloseable {

    /**
     * Create a new builder which can be used to boot a new BookKeeper client.
     *
     * @param clientConfiguration the configuration for the client
     * @return a builder
     */
    static BookKeeperBuilder newBuilder(final ClientConfiguration clientConfiguration) {
        return new BookKeeperBuilderImpl(clientConfiguration);
    }

    /**
     * Start the creation of a new ledger.
     *
     * @return a builder for the new ledger
     */
    CreateBuilder newCreateLedgerOp();

    /**
     * Open an existing ledger.
     *
     * @return a builder useful to create a readable handler for an existing ledger
     */
    OpenBuilder newOpenLedgerOp();

    /**
     * Delete an existing ledger.
     *
     * @return a builder useful to delete an existing ledger
     */
    DeleteBuilder newDeleteLedgerOp();

    /**
     * List ledgers.
     *
     * @return a builder useful to list ledgers.
     */
    ListLedgersResultBuilder newListLedgersOp();

    /**
     * Get ledger metadata of a given ledger id.
     *
     * @param ledgerId id of the ledger.
     * @return a CompletableFuture instance containing ledger metadata.
     */
    CompletableFuture getLedgerMetadata(long ledgerId);

    /**
     * Close the client and release every resource.
     *
     * @throws BKException
     * @throws InterruptedException
     */
    @Override
    void close() throws BKException, InterruptedException;

}