EventUtilitiesConfig (Wikimedia Event Platform Utilities 1.4.3-SNAPSHOT API)

java.lang.Object
- org.wikimedia.eventutilities.core.event.EventUtilitiesConfig

All Implemented Interfaces:

Serializable
```
@Immutable
 @ParametersAreNonnullByDefault
public final class EventUtilitiesConfig
extends Object
implements Serializable
```
Configuration for Event Utilities. Default values and instances are provided to aide working with Event Streams. Those defaults should only be used for debugging and troubleshooting. If you are writing code for a production job you should properly configure your code externally with non hard-coded values. create*() methods expect the client to manage wiring by taking the collaborators of the class created as method arguments. This allows the caller to decide on sharing instances or not. And it allows this class to stay lightweight and without any mutable state.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class EventUtilitiesConfig.EventUtilitiesConfigBuilder

Nested Classes
Modifier and Type	Class and Description
`static class`	`EventUtilitiesConfig.EventUtilitiesConfigBuilder`

Field Summary

Fields
Modifier and Type	Field and Description
`static EventUtilitiesConfig`	`DEFAULT` Default values and instances to aide working with Event Streams in Wikimedia Production.
`static EventUtilitiesConfig`	`EXTERNAL_DEFAULT` Default values and instances to aide working with Event Streams in Wikimedia outside of production networks, e.g.
`static String`	`META_WIKIMEDIA_ORG`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static EventUtilitiesConfig.EventUtilitiesConfigBuilder`	`builder()`
`EventLoggingSchemaLoader`	`createEventloggingSchemaLoader(BasicHttpClient httpClient)`
`EventSchemaLoader`	`createEventSchemaLoader(BasicHttpClient httpClient)`
`EventSchemaValidator`	`createEventSchemaValidator(EventSchemaLoader eventSchemaLoader)`
`EventStreamConfig`	`createEventStreamConfig(EventStreamConfigLoader eventStreamConfigLoader)`
`EventStreamFactory`	`createEventStreamFactory(EventSchemaLoader eventSchemaLoader, EventStreamConfig eventStreamConfig)`
`BasicHttpClient`	`createHttpClient()`
`JsonEventGenerator`	`createJsonEventGenerator(EventSchemaLoader eventSchemaLoader, EventStreamConfig eventStreamConfig)`
`MediawikiEventStreamConfigLoader`	`createMediawikiEventStreamConfigLoader(BasicHttpClient httpClient)`
`boolean`	`equals(Object o)`
`SerializableClock`	`getClock()` Clock used for various time based operations and timestamp creation.
`String`	`getEventloggingSchemaBaseUri()` URI from which to get legacy EventLogging on wiki schemas.
`List<String>`	`getEventSchemaBaseUris()`
`Map<String,URI>`	`getEventServiceToUriMap()` Mapping of service to port, used to route HTTP traffic through SSL tunnels.
`String`	`getEventStreamConfigEndpoint()` In production, the mediawiki internal api endpoint needs the Host header set to the MediaWiki API that should be accessed.
`String`	`getEventStreamConfigUri()` MediaWiki EventStreamConfig API used in WMF production to use to fetch stream configs.
`int`	`hashCode()`
`String`	`toString()`
`EventUtilitiesConfig`	`withClock(SerializableClock clock)` Clock used for various time based operations and timestamp creation.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - META_WIKIMEDIA_ORG
```
public static final String META_WIKIMEDIA_ORG
```
    See Also:
    
    Constant Field Values
  - DEFAULT
```
public static final EventUtilitiesConfig DEFAULT
```
    Default values and instances to aide working with Event Streams in Wikimedia Production. You should only use this class for troubleshooting and debugging. If you are writing code for a production job you should properly configure your code externally with non hard-coded values.
  - EXTERNAL_DEFAULT
```
public static final EventUtilitiesConfig EXTERNAL_DEFAULT
```
    Default values and instances to aide working with Event Streams in Wikimedia outside of production networks, e.g. schema.wikimedia.org instead of schema.discovery.wmnet. It will not be able to use non external services like eventgate-main. You should only use this class for troubleshooting and debugging. If you are writing code for a production job you should properly configure your code externally with non hard-coded values.
- Method Detail
  - createHttpClient
```
public BasicHttpClient createHttpClient()
```
  - createEventloggingSchemaLoader
```
public EventLoggingSchemaLoader createEventloggingSchemaLoader(BasicHttpClient httpClient)
```
  - createMediawikiEventStreamConfigLoader
```
public MediawikiEventStreamConfigLoader createMediawikiEventStreamConfigLoader(BasicHttpClient httpClient)
```
  - createEventStreamConfig
```
public EventStreamConfig createEventStreamConfig(EventStreamConfigLoader eventStreamConfigLoader)
```
  - createEventSchemaLoader
```
public EventSchemaLoader createEventSchemaLoader(BasicHttpClient httpClient)
```
  - createEventStreamFactory
```
public EventStreamFactory createEventStreamFactory(EventSchemaLoader eventSchemaLoader,
                                                   EventStreamConfig eventStreamConfig)
```
  - createEventSchemaValidator
```
public EventSchemaValidator createEventSchemaValidator(EventSchemaLoader eventSchemaLoader)
```
  - createJsonEventGenerator
```
public JsonEventGenerator createJsonEventGenerator(EventSchemaLoader eventSchemaLoader,
                                                   EventStreamConfig eventStreamConfig)
```
  - builder
```
public static EventUtilitiesConfig.EventUtilitiesConfigBuilder builder()
```
  - getEventSchemaBaseUris
```
@Nonnull
public List<String> getEventSchemaBaseUris()
```
  - getEventloggingSchemaBaseUri
```
@Nonnull
public String getEventloggingSchemaBaseUri()
```
    URI from which to get legacy EventLogging on wiki schemas.
  - getEventServiceToUriMap
```
@Nonnull
public Map<String,URI> getEventServiceToUriMap()
```
    Mapping of service to port, used to route HTTP traffic through SSL tunnels. See also https://wikitech.wikimedia.org/wiki/Service_ports.
  - getEventStreamConfigEndpoint
```
@Nullable
public String getEventStreamConfigEndpoint()
```
    In production, the mediawiki internal api endpoint needs the Host header set to the MediaWiki API that should be accessed.
  - getEventStreamConfigUri
```
@Nonnull
public String getEventStreamConfigUri()
```
    MediaWiki EventStreamConfig API used in WMF production to use to fetch stream configs.
  - getClock
```
@Nonnull
public SerializableClock getClock()
```
    Clock used for various time based operations and timestamp creation. Overriding the default can be used in tests to create predictable timestamps. A default configuration can be used as a starting point, overriding only the clock: EventUtilitiesConfig config = EventUtilitiesConfig.DEFAULT.withClock(SerializableClock.frozenClock(Instant.EPOCH));
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - withClock
```
public EventUtilitiesConfig withClock(@Nonnull
                                      SerializableClock clock)
```
    Clock used for various time based operations and timestamp creation. Overriding the default can be used in tests to create predictable timestamps. A default configuration can be used as a starting point, overriding only the clock: EventUtilitiesConfig config = EventUtilitiesConfig.DEFAULT.withClock(SerializableClock.frozenClock(Instant.EPOCH));
    
    Returns:
    
    a clone of this object, except with this updated property (returns this if an identical value is passed).

Class EventUtilitiesConfig

Nested Class Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

META_WIKIMEDIA_ORG

DEFAULT

EXTERNAL_DEFAULT

Method Detail

createHttpClient

createEventloggingSchemaLoader

createMediawikiEventStreamConfigLoader

createEventStreamConfig

createEventSchemaLoader

createEventStreamFactory

createEventSchemaValidator

createJsonEventGenerator

builder

getEventSchemaBaseUris

getEventloggingSchemaBaseUri

getEventServiceToUriMap

getEventStreamConfigEndpoint

getEventStreamConfigUri

getClock

equals

hashCode

toString

withClock