dev.openfeature.sdk

Class EventProvider

java.lang.Object

dev.openfeature.sdk.EventProvider

All Implemented Interfaces:

FeatureProvider

Direct Known Subclasses:

InMemoryProvider

public abstract class EventProvider
extends Object
implements FeatureProvider

Abstract EventProvider. Providers must extend this class to support events. Emit events with emit(ProviderEvent, ProviderEventDetails). Please note that the SDK will automatically emit ProviderEvent.PROVIDER_READY or ProviderEvent.PROVIDER_ERROR accordingly when FeatureProvider.initialize(EvaluationContext) completes successfully or with error, so these events need not be emitted manually during initialization.

See Also:

FeatureProvider

Constructor Summary

Constructors

Constructor and Description
EventProvider()

Method Summary

Modifier and Type	Method and Description
void	emit(ProviderEvent event, ProviderEventDetails details) Emit the specified ProviderEvent.
void	emitProviderConfigurationChanged(ProviderEventDetails details) Emit a ProviderEvent.PROVIDER_CONFIGURATION_CHANGED event.
void	emitProviderError(ProviderEventDetails details) Emit a ProviderEvent.PROVIDER_ERROR event.
void	emitProviderReady(ProviderEventDetails details) Emit a ProviderEvent.PROVIDER_READY event.
void	emitProviderStale(ProviderEventDetails details) Emit a ProviderEvent.PROVIDER_STALE event.
abstract ProviderState	getState() Returns a representation of the current readiness of the provider.

Methods inherited from class java.lang.Object

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

Methods inherited from interface dev.openfeature.sdk.FeatureProvider

getBooleanEvaluation, getDoubleEvaluation, getIntegerEvaluation, getMetadata, getObjectEvaluation, getProviderHooks, getStringEvaluation, initialize, shutdown

Constructor Detail

EventProvider

public EventProvider()

Method Detail

getState

public abstract ProviderState getState()

Returns a representation of the current readiness of the provider. If the provider needs to be initialized, it should return ProviderState.NOT_READY. If the provider is in an error state, it should return ProviderState.ERROR. If the provider is functioning normally, it should return ProviderState.READY.

Providers which do not implement this method are assumed to be ready immediately.

Specified by:

getState in interface FeatureProvider

Returns:

ProviderState

emit

public void emit(ProviderEvent event,
                 ProviderEventDetails details)

Emit the specified ProviderEvent.

Parameters:

event - The event type

details - The details of the event

emitProviderReady

public void emitProviderReady(ProviderEventDetails details)

Emit a ProviderEvent.PROVIDER_READY event. Shorthand for emit(ProviderEvent, ProviderEventDetails)

Parameters:

details - The details of the event

emitProviderConfigurationChanged

public void emitProviderConfigurationChanged(ProviderEventDetails details)

Emit a ProviderEvent.PROVIDER_CONFIGURATION_CHANGED event. Shorthand for emit(ProviderEvent, ProviderEventDetails)

Parameters:

details - The details of the event

emitProviderStale

public void emitProviderStale(ProviderEventDetails details)

Emit a ProviderEvent.PROVIDER_STALE event. Shorthand for emit(ProviderEvent, ProviderEventDetails)

Parameters:

details - The details of the event

emitProviderError

public void emitProviderError(ProviderEventDetails details)

Emit a ProviderEvent.PROVIDER_ERROR event. Shorthand for emit(ProviderEvent, ProviderEventDetails)

Parameters:

details - The details of the event