org.apache.pulsar.functions.instance.state

Interface StateStoreProvider

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

BKStateStoreProviderImpl

public interface StateStoreProvider
extends AutoCloseable

The State Store Provider provides the state stores for a function.

Field Summary

Fields

Modifier and Type	Field and Description
static StateStoreProvider	NULL The state store provider returns `null` state stores.

Method Summary

Modifier and Type	Method and Description
void	close()
<S extends StateStore> S	getStateStore(String tenant, String namespace, String name) Get the state store with the provided store name.
default void	init(Map<String,Object> config, org.apache.pulsar.functions.proto.Function.FunctionDetails functionDetails) Initialize the state store provider.

Field Detail

NULL

static final StateStoreProvider NULL

The state store provider returns `null` state stores.

Method Detail

init

default void init(Map<String,Object> config,
                  org.apache.pulsar.functions.proto.Function.FunctionDetails functionDetails)
           throws Exception

Initialize the state store provider.

Parameters:

config - the config to init the state store provider.

functionDetails - the function details.

Throws:

Exception - when failed to init the state store provider.

getStateStore

<S extends StateStore> S getStateStore(String tenant,
                                       String namespace,
                                       String name)
                                throws Exception

Get the state store with the provided store name.

Type Parameters:

S - the type of interface of the store to return

Parameters:

tenant - the tenant that owns this state store

namespace - the namespace that owns this state store

name - the state store name

Returns:

the state store instance.

Throws:

ClassCastException - if the return type isn't a type or interface of the actual returned store.

Exception

close

void close()

Specified by:

close in interface AutoCloseable