Module dev.openfeature.sdk

Package dev.openfeature.sdk

Interface EventBus<T>

All Known Subinterfaces:

Client

All Known Implementing Classes:

OpenFeatureAPI, OpenFeatureClient

public interface EventBus<T>

Interface for attaching event handlers.

Method Summary

Modifier and Type	Method	Description
T	on(ProviderEvent event, Consumer<EventDetails> handler)	Add a handler for the specified ProviderEvent.
T	onProviderConfigurationChanged(Consumer<EventDetails> handler)	Add a handler for the ProviderEvent.PROVIDER_CONFIGURATION_CHANGED event.
T	onProviderError(Consumer<EventDetails> handler)	Add a handler for the ProviderEvent.PROVIDER_STALE event.
T	onProviderReady(Consumer<EventDetails> handler)	Add a handler for the ProviderEvent.PROVIDER_READY event.
T	onProviderStale(Consumer<EventDetails> handler)	Add a handler for the ProviderEvent.PROVIDER_ERROR event.
T	removeHandler(ProviderEvent event, Consumer<EventDetails> handler)	Remove the previously attached handler by reference.

Method Details

onProviderReady

T onProviderReady(Consumer<EventDetails> handler)

Add a handler for the ProviderEvent.PROVIDER_READY event. Shorthand for on(ProviderEvent, Consumer)

Parameters:

handler - behavior to add with this event

Returns:

this

onProviderConfigurationChanged

T onProviderConfigurationChanged(Consumer<EventDetails> handler)

Add a handler for the ProviderEvent.PROVIDER_CONFIGURATION_CHANGED event. Shorthand for on(ProviderEvent, Consumer)

Parameters:

handler - behavior to add with this event

Returns:

this

onProviderError

T onProviderError(Consumer<EventDetails> handler)

Add a handler for the ProviderEvent.PROVIDER_STALE event. Shorthand for on(ProviderEvent, Consumer)

Parameters:

handler - behavior to add with this event

Returns:

this

onProviderStale

T onProviderStale(Consumer<EventDetails> handler)

Add a handler for the ProviderEvent.PROVIDER_ERROR event. Shorthand for on(ProviderEvent, Consumer)

Parameters:

handler - behavior to add with this event

Returns:

this

on

T on(ProviderEvent event,
 Consumer<EventDetails> handler)

Add a handler for the specified ProviderEvent.

Parameters:

event - event type

handler - behavior to add with this event

Returns:

this

removeHandler

T removeHandler(ProviderEvent event,
 Consumer<EventDetails> handler)

Remove the previously attached handler by reference. If the handler doesn't exists, no-op.

Parameters:

event - event type

handler - to be removed

Returns:

this