org.apache.bookkeeper.client

Class BookKeeperAdmin

java.lang.Object

org.apache.bookkeeper.client.BookKeeperAdmin

public class BookKeeperAdmin
extends Object

Admin client for BookKeeper clusters

Constructor Summary

Constructors

Constructor and Description
BookKeeperAdmin(BookKeeper bkc) Constructor that takes in a BookKeeper instance .
BookKeeperAdmin(ClientConfiguration conf) Constructor that takes in a configuration object so we know how to connect to ZooKeeper to retrieve information about the BookKeeper cluster.
BookKeeperAdmin(String zkServers) Constructor that takes in a ZooKeeper servers connect string so we know how to connect to ZooKeeper to retrieve information about the BookKeeper cluster.

Method Summary

Methods

Modifier and Type	Method and Description
void	asyncOpenLedger(long lId, AsyncCallback.OpenCallback cb, Object ctx) Open a ledger as an administrator.
void	asyncOpenLedgerNoRecovery(long lId, AsyncCallback.OpenCallback cb, Object ctx) Open a ledger as an administrator without recovering the ledger.
void	asyncRecoverBookieData(org.apache.bookkeeper.net.BookieSocketAddress bookieSrc, org.apache.bookkeeper.net.BookieSocketAddress bookieDest, AsyncCallback.RecoverCallback cb, Object context) Async method to rebuild and recover the ledger fragments data that was stored on the source bookie.
void	close() Gracefully release resources that this client uses.
static boolean	format(ClientConfiguration conf, boolean isInteractive, boolean force) Format the BookKeeper metadata in zookeeper
Collection<org.apache.bookkeeper.net.BookieSocketAddress>	getAvailableBookies() Get a list of the available bookies.
LedgerMetadata	getLedgerMetadata(LedgerHandle lh)
Collection<org.apache.bookkeeper.net.BookieSocketAddress>	getReadOnlyBookies() Get a list of readonly bookies
Iterable<Long>	listLedgers() This method returns an iterable object for the list of ledger identifiers of the ledgers currently available.
void	notifyBookiesChanged(BookiesListener listener) Notify when the available list of bookies changes.
LedgerHandle	openLedger(long lId) Open a ledger as an administrator.
LedgerHandle	openLedgerNoRecovery(long lId) Open a ledger as an administrator without recovering the ledger.
void	recoverBookieData(org.apache.bookkeeper.net.BookieSocketAddress bookieSrc, org.apache.bookkeeper.net.BookieSocketAddress bookieDest) Synchronous method to rebuild and recover the ledger fragments data that was stored on the source bookie.
void	replicateLedgerFragment(LedgerHandle lh, LedgerFragment ledgerFragment, org.apache.bookkeeper.net.BookieSocketAddress targetBookieAddress) Replicate the Ledger fragment to target Bookie passed.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BookKeeperAdmin

public BookKeeperAdmin(String zkServers)
                throws IOException,
                       InterruptedException,
                       org.apache.zookeeper.KeeperException

Constructor that takes in a ZooKeeper servers connect string so we know how to connect to ZooKeeper to retrieve information about the BookKeeper cluster. We need this before we can do any type of admin operations on the BookKeeper cluster.

Parameters:

zkServers - Comma separated list of hostname:port pairs for the ZooKeeper servers cluster.

Throws:

IOException - throws this exception if there is an error instantiating the ZooKeeper client.

InterruptedException - Throws this exception if there is an error instantiating the BookKeeper client.

org.apache.zookeeper.KeeperException - Throws this exception if there is an error instantiating the BookKeeper client.

BookKeeperAdmin

public BookKeeperAdmin(ClientConfiguration conf)
                throws IOException,
                       InterruptedException,
                       org.apache.zookeeper.KeeperException

Constructor that takes in a configuration object so we know how to connect to ZooKeeper to retrieve information about the BookKeeper cluster. We need this before we can do any type of admin operations on the BookKeeper cluster.

Parameters:

conf - Client Configuration Object

Throws:

IOException - throws this exception if there is an error instantiating the ZooKeeper client.

InterruptedException - Throws this exception if there is an error instantiating the BookKeeper client.

org.apache.zookeeper.KeeperException - Throws this exception if there is an error instantiating the BookKeeper client.

BookKeeperAdmin

public BookKeeperAdmin(BookKeeper bkc)

Constructor that takes in a BookKeeper instance . This will be useful, when users already has bk instance ready.

Parameters:

bkc - - bookkeeper instance

Method Detail

close

public void close()
           throws InterruptedException,
                  BKException

Gracefully release resources that this client uses.

Throws:

InterruptedException - if there is an error shutting down the clients that this class uses.

BKException

getAvailableBookies

public Collection<org.apache.bookkeeper.net.BookieSocketAddress> getAvailableBookies()
                                                                              throws BKException

Get a list of the available bookies.

Returns:

a collection of bookie addresses

Throws:

BKException

getReadOnlyBookies

public Collection<org.apache.bookkeeper.net.BookieSocketAddress> getReadOnlyBookies()

Get a list of readonly bookies

Returns:

a collection of bookie addresses

notifyBookiesChanged

public void notifyBookiesChanged(BookiesListener listener)
                          throws BKException

Notify when the available list of bookies changes. This is a one-shot notification. To receive subsequent notifications the listener must be registered again.

Parameters:

listener - the listener to notify

Throws:

BKException

asyncOpenLedger

public void asyncOpenLedger(long lId,
                   AsyncCallback.OpenCallback cb,
                   Object ctx)

Open a ledger as an administrator. This means that no digest password checks are done. Otherwise, the call is identical to BookKeeper#asyncOpenLedger

Parameters:

lId - ledger identifier

cb - Callback which will receive a LedgerHandle object

ctx - optional context object, to be passwd to the callback (can be null)

See Also:

BookKeeper.asyncOpenLedger(long, org.apache.bookkeeper.client.BookKeeper.DigestType, byte[], org.apache.bookkeeper.client.AsyncCallback.OpenCallback, java.lang.Object)

openLedger

public LedgerHandle openLedger(long lId)
                        throws InterruptedException,
                               BKException

Open a ledger as an administrator. This means that no digest password checks are done. Otherwise, the call is identical to BookKeeper#openLedger

Parameters:

lId - - ledger identifier

Throws:

InterruptedException

BKException

See Also:

BookKeeper.openLedger(long, org.apache.bookkeeper.client.BookKeeper.DigestType, byte[])

asyncOpenLedgerNoRecovery

public void asyncOpenLedgerNoRecovery(long lId,
                             AsyncCallback.OpenCallback cb,
                             Object ctx)

Open a ledger as an administrator without recovering the ledger. This means that no digest password checks are done. Otherwise, the call is identical to BookKeeper#asyncOpenLedgerNoRecovery

Parameters:

lId - ledger identifier

cb - Callback which will receive a LedgerHandle object

ctx - optional context object, to be passwd to the callback (can be null)

See Also:

BookKeeper.asyncOpenLedgerNoRecovery(long, org.apache.bookkeeper.client.BookKeeper.DigestType, byte[], org.apache.bookkeeper.client.AsyncCallback.OpenCallback, java.lang.Object)

openLedgerNoRecovery

public LedgerHandle openLedgerNoRecovery(long lId)
                                  throws InterruptedException,
                                         BKException

Open a ledger as an administrator without recovering the ledger. This means that no digest password checks are done. Otherwise, the call is identical to BookKeeper#openLedgerNoRecovery

Parameters:

lId - ledger identifier

Throws:

InterruptedException

BKException

See Also:

BookKeeper.openLedgerNoRecovery(long, org.apache.bookkeeper.client.BookKeeper.DigestType, byte[])

recoverBookieData

public void recoverBookieData(org.apache.bookkeeper.net.BookieSocketAddress bookieSrc,
                     org.apache.bookkeeper.net.BookieSocketAddress bookieDest)
                       throws InterruptedException,
                              BKException

Synchronous method to rebuild and recover the ledger fragments data that was stored on the source bookie. That bookie could have failed completely and now the ledger data that was stored on it is under replicated. An optional destination bookie server could be given if we want to copy all of the ledger fragments data on the failed source bookie to it. Otherwise, we will just randomly distribute the ledger fragments to the active set of bookies, perhaps based on load. All ZooKeeper ledger metadata will be updated to point to the new bookie(s) that contain the replicated ledger fragments.

Parameters:

bookieSrc - Source bookie that had a failure. We want to replicate the ledger fragments that were stored there.

bookieDest - Optional destination bookie that if passed, we will copy all of the ledger fragments from the source bookie over to it.

Throws:

InterruptedException

BKException

asyncRecoverBookieData

public void asyncRecoverBookieData(org.apache.bookkeeper.net.BookieSocketAddress bookieSrc,
                          org.apache.bookkeeper.net.BookieSocketAddress bookieDest,
                          AsyncCallback.RecoverCallback cb,
                          Object context)

Async method to rebuild and recover the ledger fragments data that was stored on the source bookie. That bookie could have failed completely and now the ledger data that was stored on it is under replicated. An optional destination bookie server could be given if we want to copy all of the ledger fragments data on the failed source bookie to it. Otherwise, we will just randomly distribute the ledger fragments to the active set of bookies, perhaps based on load. All ZooKeeper ledger metadata will be updated to point to the new bookie(s) that contain the replicated ledger fragments.

Parameters:

bookieSrc - Source bookie that had a failure. We want to replicate the ledger fragments that were stored there.

bookieDest - Optional destination bookie that if passed, we will copy all of the ledger fragments from the source bookie over to it.

cb - RecoverCallback to invoke once all of the data on the dead bookie has been recovered and replicated.

context - Context for the RecoverCallback to call.

replicateLedgerFragment

public void replicateLedgerFragment(LedgerHandle lh,
                           LedgerFragment ledgerFragment,
                           org.apache.bookkeeper.net.BookieSocketAddress targetBookieAddress)
                             throws InterruptedException,
                                    BKException

Replicate the Ledger fragment to target Bookie passed.

Parameters:

lh - - ledgerHandle

ledgerFragment - - LedgerFragment to replicate

targetBookieAddress - - target Bookie, to where entries should be replicated.

Throws:

InterruptedException

BKException

format

public static boolean format(ClientConfiguration conf,
             boolean isInteractive,
             boolean force)
                      throws Exception

Format the BookKeeper metadata in zookeeper

Parameters:

isInteractive - Whether format should ask prompt for confirmation if old data exists or not.

force - If non interactive and force is true, then old data will be removed without prompt.

Returns:

Returns true if format succeeds else false.

Throws:

Exception

listLedgers

public Iterable<Long> listLedgers()
                           throws IOException

This method returns an iterable object for the list of ledger identifiers of the ledgers currently available.

Returns:

an iterable object for the list of ledger identifiers

Throws:

IOException - if the list of ledger identifiers cannot be read from the metadata store

getLedgerMetadata

public LedgerMetadata getLedgerMetadata(LedgerHandle lh)

Returns:

the metadata for the passed ledger handle