org.apache.bookkeeper.mledger

Interface LedgerOffloaderFactory<T extends LedgerOffloader>

@InterfaceAudience.LimitedPrivate
 @InterfaceStability.Evolving
public interface LedgerOffloaderFactory<T extends LedgerOffloader>

Factory to create LedgerOffloader to offload ledgers into long-term storage.

Method Summary

Modifier and Type	Method and Description
T	create(OffloadPolicies offloadPolicies, Map<String,String> userMetadata, org.apache.bookkeeper.common.util.OrderedScheduler scheduler) Create a ledger offloader with the provided configuration, user-metadata and scheduler.
default T	create(OffloadPolicies offloadPolicies, Map<String,String> userMetadata, SchemaStorage schemaStorage, org.apache.bookkeeper.common.util.OrderedScheduler scheduler) Create a ledger offloader with the provided configuration, user-metadata, schema storage and scheduler.
boolean	isDriverSupported(String driverName) Check whether the provided driver driverName is supported.

Method Detail

isDriverSupported

boolean isDriverSupported(String driverName)

Check whether the provided driver driverName is supported.

Parameters:

driverName - offloader driver name

Returns:

true if the driver is supported, otherwise false.

create

T create(OffloadPolicies offloadPolicies,
         Map<String,String> userMetadata,
         org.apache.bookkeeper.common.util.OrderedScheduler scheduler)
  throws IOException

Create a ledger offloader with the provided configuration, user-metadata and scheduler.

Parameters:

offloadPolicies - offload policies

userMetadata - user metadata

scheduler - scheduler

Returns:

the offloader instance

Throws:

IOException - when fail to create an offloader

create

default T create(OffloadPolicies offloadPolicies,
                 Map<String,String> userMetadata,
                 SchemaStorage schemaStorage,
                 org.apache.bookkeeper.common.util.OrderedScheduler scheduler)
          throws IOException

Create a ledger offloader with the provided configuration, user-metadata, schema storage and scheduler.

Parameters:

offloadPolicies - offload policies

userMetadata - user metadata

schemaStorage - used for schema lookup in offloader

scheduler - scheduler

Returns:

the offloader instance

Throws:

IOException - when fail to create an offloader