org.wikimedia.eventutilities.core.event

Class EventStreamFactory

java.lang.Object

org.wikimedia.eventutilities.core.event.EventStreamFactory

public class EventStreamFactory
extends Object

Class to aide in constructing EventStream instances and working with groups of event streams using EventStreamConfig and EventSchemaLoader. Use EventStreamFactory.builder() or one of the EventStreamFactory.from() methods to construct an EventStreamFactory. Example using builder():

  EventStreamFactory f = EventStreamFactory.builder()
      .setEventSchemaLoader(Arrays.asList("file:///path/to/schema/repo"))
      // MW Stream Config URL, will use MediawikiEventStreamConfigLoader
      .setEventStreamConfig(
          "https://meta.wikimedia.org/w/api.php",
      )
       // in prod networks, we need special routing for MW API, optional.
      .setHttpRoute("https://meta.wikimedia.org", "https://api-ro.wikimedia.org")
      // event service to URI map config file, optional.
      .setEventServiceToUriMap(
          "file:///path/to/event_service_map.yaml"
       )
      .build()
 

Example using from():

     EventStreamFactory f = EventStreamFactory.from(
          Arrays.asList(
              "https://schema.wikimedia.org/repositories/primary",
              "https://schema.wikimedia.org/repositories/secondary",
          ),
          "https://meta.wikimedia.org/w/api.php/",
     );
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	EventStreamFactory.Builder Builder builder pattern to construct EventStreamFactory instance.

Field Summary

Fields

Modifier and Type	Field and Description
protected EventSchemaLoader	eventSchemaLoader EventSchemaLoader instance used when constructing EventStreams.
protected EventStreamConfig	eventStreamConfig EventStreamConfig instance used when constructing EventStreams and looking up stream configs.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	EventStreamFactory(EventSchemaLoader eventSchemaLoader, EventStreamConfig eventStreamConfig) Constructs a new instance of EventStreamFactory.

Method Summary

Modifier and Type	Method and Description
static EventStreamFactory.Builder	builder()
List<EventStream>	createAllCachedEventStreams() Creates EventStreams for all streams in our EventStreamConfig's cache.
EventStream	createEventStream(String streamName) Returns a new EventStream for this streamName using eventSchemaLoader and eventStreamConfig.
List<EventStream>	createEventStreams(Collection<String> streamNames) Returns a List of new EventStreams using eventSchemaLoader and eventStreamConfig.
List<EventStream>	createEventStreamsMatchingSettings(Collection<String> streamNames, Map<String,String> settingsFilters) Creates EventStreams for the list of specified streams with settings that match the provided settingsFilters.
static EventStreamFactory	from(List<String> eventSchemaBaseUris, String eventStreamConfigUri) Helper function to quickly instantiate EventStreamFactory.
static EventStreamFactory	from(List<String> eventSchemaBaseUris, String eventStreamConfigUri, Map<String,String> httpRoutes) Helper function to quickly instantiate EventStreamFactory.
static EventStreamFactory	from(List<String> eventSchemaBaseUris, String eventStreamConfigUri, Map<String,String> httpRoutes, String eventServiceToUriMapUrl) Helper function to quickly instantiate EventStreamFactory.
EventSchemaLoader	getEventSchemaLoader() Returns the EventSchemaLoader instance this EventStreamFactory is using.
EventStreamConfig	getEventStreamConfig() Returns the EventStreamConfig instance this EventStreamFactory is using.

Methods inherited from class java.lang.Object

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

Field Detail

eventSchemaLoader

protected final EventSchemaLoader eventSchemaLoader

EventSchemaLoader instance used when constructing EventStreams.

eventStreamConfig

protected EventStreamConfig eventStreamConfig

EventStreamConfig instance used when constructing EventStreams and looking up stream configs.

Constructor Detail

EventStreamFactory

protected EventStreamFactory(EventSchemaLoader eventSchemaLoader,
                             EventStreamConfig eventStreamConfig)

Constructs a new instance of EventStreamFactory. This is protected; use EventStreamFactory.builder() or one of the EventStreamFactory.of(...) factories. to create your EventStreamFactory instance.

Method Detail

from

public static EventStreamFactory from(List<String> eventSchemaBaseUris,
                                      String eventStreamConfigUri)

Helper function to quickly instantiate EventStreamFactory.

from

public static EventStreamFactory from(List<String> eventSchemaBaseUris,
                                      String eventStreamConfigUri,
                                      Map<String,String> httpRoutes)

Helper function to quickly instantiate EventStreamFactory.

from

public static EventStreamFactory from(List<String> eventSchemaBaseUris,
                                      String eventStreamConfigUri,
                                      Map<String,String> httpRoutes,
                                      String eventServiceToUriMapUrl)

Helper function to quickly instantiate EventStreamFactory.

builder

public static EventStreamFactory.Builder builder()

createAllCachedEventStreams

public List<EventStream> createAllCachedEventStreams()

Creates EventStreams for all streams in our EventStreamConfig's cache. This will exclude any stream name that looks like a regex in the config, as it doesn't make sense to construct an EventStream without a concrete stream name.

createEventStream

public EventStream createEventStream(String streamName)

Returns a new EventStream for this streamName using eventSchemaLoader and eventStreamConfig.

createEventStreams

public List<EventStream> createEventStreams(Collection<String> streamNames)

Returns a List of new EventStreams using eventSchemaLoader and eventStreamConfig.

createEventStreamsMatchingSettings

public List<EventStream> createEventStreamsMatchingSettings(Collection<String> streamNames,
                                                            Map<String,String> settingsFilters)

Creates EventStreams for the list of specified streams with settings that match the provided settingsFilters. If streamNames is null, it is assumed you don't want to match on stream names, and only setttingsFilters will be considered. Since settingsFilters must all be strings, this only allows filtering on string stream config settings, or at least ones for which JsonNode.asText() returns something sane (which is true for most primitive types).

getEventStreamConfig

public EventStreamConfig getEventStreamConfig()

Returns the EventStreamConfig instance this EventStreamFactory is using.

getEventSchemaLoader

public EventSchemaLoader getEventSchemaLoader()

Returns the EventSchemaLoader instance this EventStreamFactory is using.