org.apache.bookkeeper.client

Class BookKeeper.Builder

java.lang.Object

org.apache.bookkeeper.client.BookKeeper.Builder

Enclosing class:

BookKeeper

public static class BookKeeper.Builder
extends java.lang.Object

BookKeeper Client Builder to build client instances.

See Also:

BookKeeperBuilder

Field Summary

Fields

Modifier and Type	Field and Description
(package private) io.netty.buffer.ByteBufAllocator	allocator
(package private) ClientConfiguration	conf
(package private) org.apache.bookkeeper.net.DNSToSwitchMapping	dnsResolver
(package private) io.netty.channel.EventLoopGroup	eventLoopGroup
(package private) FeatureProvider	featureProvider
(package private) io.netty.util.HashedWheelTimer	requestTimer
(package private) org.apache.bookkeeper.stats.StatsLogger	statsLogger
(package private) org.apache.zookeeper.ZooKeeper	zk

Constructor Summary

Constructors

Constructor and Description
Builder(ClientConfiguration conf)

Method Summary

Modifier and Type	Method and Description
BookKeeper.Builder	allocator(io.netty.buffer.ByteBufAllocator allocator) Configure the bookkeeper client with a provided ByteBufAllocator.
BookKeeper	build()
BookKeeper.Builder	dnsResolver(org.apache.bookkeeper.net.DNSToSwitchMapping dnsResolver) Configure the bookkeeper client to use the provided dns resolver DNSToSwitchMapping.
BookKeeper.Builder	eventLoopGroup(io.netty.channel.EventLoopGroup f) Configure the bookkeeper client with a provided EventLoopGroup.
BookKeeper.Builder	featureProvider(FeatureProvider featureProvider) Feature Provider.
BookKeeper.Builder	requestTimer(io.netty.util.HashedWheelTimer requestTimer) Configure the bookkeeper client to use a provided HashedWheelTimer.
BookKeeper.Builder	setEventLoopGroup(io.netty.channel.EventLoopGroup f) Deprecated. since 4.5, use eventLoopGroup(EventLoopGroup)
BookKeeper.Builder	setStatsLogger(org.apache.bookkeeper.stats.StatsLogger statsLogger) Deprecated. since 4.5, use statsLogger(StatsLogger)
BookKeeper.Builder	setZookeeper(org.apache.zookeeper.ZooKeeper zk) Deprecated. since 4.5, use zk(ZooKeeper)
BookKeeper.Builder	statsLogger(org.apache.bookkeeper.stats.StatsLogger statsLogger) Configure the bookkeeper client with a provided StatsLogger.
BookKeeper.Builder	zk(org.apache.zookeeper.ZooKeeper zk) Deprecated.

Methods inherited from class java.lang.Object

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

Field Detail

conf

final ClientConfiguration conf

zk

org.apache.zookeeper.ZooKeeper zk

eventLoopGroup

io.netty.channel.EventLoopGroup eventLoopGroup

allocator

io.netty.buffer.ByteBufAllocator allocator

statsLogger

org.apache.bookkeeper.stats.StatsLogger statsLogger

dnsResolver

org.apache.bookkeeper.net.DNSToSwitchMapping dnsResolver

requestTimer

io.netty.util.HashedWheelTimer requestTimer

featureProvider

FeatureProvider featureProvider

Constructor Detail

Builder

Builder(ClientConfiguration conf)

Method Detail

setEventLoopGroup

@Deprecated
public BookKeeper.Builder setEventLoopGroup(io.netty.channel.EventLoopGroup f)

Deprecated. since 4.5, use eventLoopGroup(EventLoopGroup)

Configure the bookkeeper client with a provided EventLoopGroup.

Parameters:

f - an external EventLoopGroup to use by the bookkeeper client.

Returns:

client builder.

See Also:

eventLoopGroup(EventLoopGroup)

setZookeeper

@Deprecated
public BookKeeper.Builder setZookeeper(org.apache.zookeeper.ZooKeeper zk)

Deprecated. since 4.5, use zk(ZooKeeper)

Configure the bookkeeper client with a provided ZooKeeper client.

Parameters:

zk - an external ZooKeeper client to use by the bookkeeper client.

Returns:

client builder.

See Also:

zk(ZooKeeper)

setStatsLogger

@Deprecated
public BookKeeper.Builder setStatsLogger(org.apache.bookkeeper.stats.StatsLogger statsLogger)

Deprecated. since 4.5, use statsLogger(StatsLogger)

Configure the bookkeeper client with a provided StatsLogger.

Parameters:

statsLogger - an StatsLogger to use by the bookkeeper client to collect stats generated by the client.

Returns:

client builder.

See Also:

statsLogger(StatsLogger)

eventLoopGroup

public BookKeeper.Builder eventLoopGroup(io.netty.channel.EventLoopGroup f)

Configure the bookkeeper client with a provided EventLoopGroup.

Parameters:

f - an external EventLoopGroup to use by the bookkeeper client.

Returns:

client builder.

Since:

4.5

allocator

public BookKeeper.Builder allocator(io.netty.buffer.ByteBufAllocator allocator)

Configure the bookkeeper client with a provided ByteBufAllocator.

Parameters:

allocator - an external ByteBufAllocator to use by the bookkeeper client.

Returns:

client builder.

Since:

4.9

zk

@Deprecated
public BookKeeper.Builder zk(org.apache.zookeeper.ZooKeeper zk)

Deprecated.

Configure the bookkeeper client with a provided ZooKeeper client.

Parameters:

zk - an external ZooKeeper client to use by the bookkeeper client.

Returns:

client builder.

Since:

4.5

statsLogger

public BookKeeper.Builder statsLogger(org.apache.bookkeeper.stats.StatsLogger statsLogger)

Configure the bookkeeper client with a provided StatsLogger.

Parameters:

statsLogger - an StatsLogger to use by the bookkeeper client to collect stats generated by the client.

Returns:

client builder.

Since:

4.5

dnsResolver

public BookKeeper.Builder dnsResolver(org.apache.bookkeeper.net.DNSToSwitchMapping dnsResolver)

Configure the bookkeeper client to use the provided dns resolver DNSToSwitchMapping.

Parameters:

dnsResolver - dns resolver for placement policy to use for resolving network locations.

Returns:

client builder

Since:

4.5

requestTimer

public BookKeeper.Builder requestTimer(io.netty.util.HashedWheelTimer requestTimer)

Configure the bookkeeper client to use a provided HashedWheelTimer.

Parameters:

requestTimer - request timer for client to manage timer related tasks.

Returns:

client builder

Since:

4.5

featureProvider

public BookKeeper.Builder featureProvider(FeatureProvider featureProvider)

Feature Provider.

Parameters:

featureProvider -

Returns:

build

public BookKeeper build()
                 throws java.io.IOException,
                        java.lang.InterruptedException,
                        BKException

Throws:

java.io.IOException

java.lang.InterruptedException

BKException