| /* |
| * |
| * 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; |
| |
| import static org.apache.bookkeeper.client.BookKeeper.DigestType.fromApiDigestType; |
| |
| import java.security.GeneralSecurityException; |
| import java.util.Arrays; |
| import java.util.concurrent.CompletableFuture; |
| import java.util.concurrent.TimeUnit; |
| import java.util.concurrent.locks.ReentrantReadWriteLock; |
| |
| import org.apache.bookkeeper.client.AsyncCallback.OpenCallback; |
| import org.apache.bookkeeper.client.AsyncCallback.ReadLastConfirmedCallback; |
| import org.apache.bookkeeper.client.BookKeeper.DigestType; |
| import org.apache.bookkeeper.client.SyncCallbackUtils.SyncOpenCallback; |
| import org.apache.bookkeeper.client.api.BKException.Code; |
| import org.apache.bookkeeper.client.api.LedgerMetadata; |
| import org.apache.bookkeeper.client.api.ReadHandle; |
| import org.apache.bookkeeper.client.impl.OpenBuilderBase; |
| import org.apache.bookkeeper.stats.OpStatsLogger; |
| import org.apache.bookkeeper.util.MathUtils; |
| import org.apache.bookkeeper.util.OrderedGenericCallback; |
| import org.apache.bookkeeper.versioning.Versioned; |
| import org.slf4j.Logger; |
| import org.slf4j.LoggerFactory; |
| |
| /** |
| * Encapsulates the ledger open operation. |
| * |
| */ |
| class LedgerOpenOp { |
| static final Logger LOG = LoggerFactory.getLogger(LedgerOpenOp.class); |
| |
| final BookKeeper bk; |
| final long ledgerId; |
| final OpenCallback cb; |
| final Object ctx; |
| ReadOnlyLedgerHandle lh; |
| final byte[] passwd; |
| boolean doRecovery = true; |
| boolean administrativeOpen = false; |
| long startTime; |
| final OpStatsLogger openOpLogger; |
| |
| final DigestType suggestedDigestType; |
| final boolean enableDigestAutodetection; |
| |
| /** |
| * Constructor. |
| * |
| * @param bk |
| * @param ledgerId |
| * @param digestType. Ignored if conf.getEnableDigestTypeAutodetection() is true |
| * @param passwd |
| * @param cb |
| * @param ctx |
| */ |
| public LedgerOpenOp(BookKeeper bk, BookKeeperClientStats clientStats, |
| long ledgerId, DigestType digestType, byte[] passwd, |
| OpenCallback cb, Object ctx) { |
| this.bk = bk; |
| this.ledgerId = ledgerId; |
| this.passwd = passwd; |
| this.cb = cb; |
| this.ctx = ctx; |
| this.enableDigestAutodetection = bk.getConf().getEnableDigestTypeAutodetection(); |
| this.suggestedDigestType = digestType; |
| this.openOpLogger = clientStats.getOpenOpLogger(); |
| } |
| |
| public LedgerOpenOp(BookKeeper bk, BookKeeperClientStats clientStats, |
| long ledgerId, OpenCallback cb, Object ctx) { |
| this.bk = bk; |
| this.ledgerId = ledgerId; |
| this.cb = cb; |
| this.ctx = ctx; |
| |
| this.passwd = bk.getConf().getBookieRecoveryPasswd(); |
| this.administrativeOpen = true; |
| this.enableDigestAutodetection = false; |
| this.suggestedDigestType = bk.conf.getBookieRecoveryDigestType(); |
| this.openOpLogger = clientStats.getOpenOpLogger(); |
| } |
| |
| /** |
| * Inititates the ledger open operation. |
| */ |
| public void initiate() { |
| startTime = MathUtils.nowInNano(); |
| |
| /** |
| * Asynchronously read the ledger metadata node. |
| */ |
| bk.getLedgerManager().readLedgerMetadata(ledgerId) |
| .whenComplete((metadata, exception) -> { |
| if (exception != null) { |
| openComplete(BKException.getExceptionCode(exception), null); |
| } else { |
| openWithMetadata(metadata); |
| } |
| }); |
| } |
| |
| /** |
| * Inititates the ledger open operation without recovery. |
| */ |
| public void initiateWithoutRecovery() { |
| this.doRecovery = false; |
| initiate(); |
| } |
| |
| private void closeLedgerHandle() { |
| try { |
| if (lh != null) { |
| lh.close(); |
| } |
| } catch (InterruptedException e) { |
| Thread.currentThread().interrupt(); |
| LOG.info("InterruptedException while closing ledger {}", ledgerId, e); |
| } catch (BKException e) { |
| LOG.warn("BKException while closing ledger {} ", ledgerId, e); |
| } |
| } |
| |
| private void openWithMetadata(Versioned<LedgerMetadata> versionedMetadata) { |
| LedgerMetadata metadata = versionedMetadata.getValue(); |
| |
| final byte[] passwd; |
| |
| // we should use digest type from metadata *ONLY* when: |
| // 1) digest type is stored in metadata |
| // 2) `autodetection` is enabled |
| DigestType digestType; |
| if (enableDigestAutodetection && metadata.hasPassword()) { |
| digestType = fromApiDigestType(metadata.getDigestType()); |
| } else { |
| digestType = suggestedDigestType; |
| } |
| |
| /* For an administrative open, the default passwords |
| * are read from the configuration, but if the metadata |
| * already contains passwords, use these instead. */ |
| if (administrativeOpen && metadata.hasPassword()) { |
| passwd = metadata.getPassword(); |
| digestType = fromApiDigestType(metadata.getDigestType()); |
| } else { |
| passwd = this.passwd; |
| |
| if (metadata.hasPassword()) { |
| if (!Arrays.equals(passwd, metadata.getPassword())) { |
| LOG.error("Provided passwd does not match that in metadata"); |
| openComplete(BKException.Code.UnauthorizedAccessException, null); |
| return; |
| } |
| // if `digest auto detection` is enabled, ignore the suggested digest type, this allows digest type |
| // changes. e.g. moving from `crc32` to `crc32c`. |
| if (suggestedDigestType != fromApiDigestType(metadata.getDigestType()) && !enableDigestAutodetection) { |
| LOG.error("Provided digest does not match that in metadata"); |
| openComplete(BKException.Code.DigestMatchException, null); |
| return; |
| } |
| } |
| } |
| |
| // get the ledger metadata back |
| try { |
| lh = new ReadOnlyLedgerHandle(bk.getClientCtx(), ledgerId, versionedMetadata, digestType, |
| passwd, !doRecovery); |
| } catch (GeneralSecurityException e) { |
| LOG.error("Security exception while opening ledger: " + ledgerId, e); |
| openComplete(BKException.Code.DigestNotInitializedException, null); |
| return; |
| } catch (NumberFormatException e) { |
| LOG.error("Incorrectly entered parameter throttle: " + bk.getConf().getThrottleValue(), e); |
| openComplete(BKException.Code.IncorrectParameterException, null); |
| return; |
| } |
| |
| if (metadata.isClosed()) { |
| // Ledger was closed properly |
| openComplete(BKException.Code.OK, lh); |
| return; |
| } |
| |
| if (doRecovery) { |
| lh.recover(new OrderedGenericCallback<Void>(bk.getMainWorkerPool(), ledgerId) { |
| @Override |
| public void safeOperationComplete(int rc, Void result) { |
| if (rc == BKException.Code.OK) { |
| openComplete(BKException.Code.OK, lh); |
| } else if (rc == BKException.Code.UnauthorizedAccessException) { |
| closeLedgerHandle(); |
| openComplete(BKException.Code.UnauthorizedAccessException, null); |
| } else { |
| closeLedgerHandle(); |
| openComplete(bk.getReturnRc(BKException.Code.LedgerRecoveryException), null); |
| } |
| } |
| @Override |
| public String toString() { |
| return String.format("Recover(%d)", ledgerId); |
| } |
| }); |
| } else { |
| lh.asyncReadLastConfirmed(new ReadLastConfirmedCallback() { |
| @Override |
| public void readLastConfirmedComplete(int rc, |
| long lastConfirmed, Object ctx) { |
| if (rc != BKException.Code.OK) { |
| closeLedgerHandle(); |
| openComplete(bk.getReturnRc(BKException.Code.ReadException), null); |
| } else { |
| lh.lastAddConfirmed = lh.lastAddPushed = lastConfirmed; |
| openComplete(BKException.Code.OK, lh); |
| } |
| } |
| }, null); |
| |
| } |
| } |
| |
| void openComplete(int rc, LedgerHandle lh) { |
| if (BKException.Code.OK != rc) { |
| openOpLogger.registerFailedEvent(MathUtils.elapsedNanos(startTime), TimeUnit.NANOSECONDS); |
| } else { |
| openOpLogger.registerSuccessfulEvent(MathUtils.elapsedNanos(startTime), TimeUnit.NANOSECONDS); |
| } |
| cb.openComplete(rc, lh, ctx); |
| } |
| |
| static final class OpenBuilderImpl extends OpenBuilderBase { |
| |
| private final BookKeeper bk; |
| |
| OpenBuilderImpl(BookKeeper bookkeeper) { |
| this.bk = bookkeeper; |
| } |
| |
| @Override |
| public CompletableFuture<ReadHandle> execute() { |
| CompletableFuture<ReadHandle> future = new CompletableFuture<>(); |
| SyncOpenCallback callback = new SyncOpenCallback(future); |
| open(callback); |
| return future; |
| } |
| |
| private void open(OpenCallback cb) { |
| final int validateRc = validate(); |
| if (Code.OK != validateRc) { |
| cb.openComplete(validateRc, null, null); |
| return; |
| } |
| |
| LedgerOpenOp op = new LedgerOpenOp(bk, bk.getClientCtx().getClientStats(), |
| ledgerId, fromApiDigestType(digestType), |
| password, cb, null); |
| ReentrantReadWriteLock closeLock = bk.getCloseLock(); |
| closeLock.readLock().lock(); |
| try { |
| if (bk.isClosed()) { |
| cb.openComplete(BKException.Code.ClientClosedException, null, null); |
| return; |
| } |
| if (recovery) { |
| op.initiate(); |
| } else { |
| op.initiateWithoutRecovery(); |
| } |
| } finally { |
| closeLock.readLock().unlock(); |
| } |
| } |
| } |
| |
| } |
