unleash-client-clojure.builder — unleash-client-clojure 0.2.1

Create and configure builders that build instances of UnleashConfig.

app-name clj

(app-name name)

Expects an application name. Returns a function that expects an UnleashConfig$Builder, and sets the appName property of the builder.

backup-file clj

(backup-file backup-file)

Expects a backup file path, into which the Unleash client would backup its state to be used when the Unleash server is unavailable. By defeault this would be unleash-repo.json in the directory set by the JVM property java.io.tmpdir. Returns a function that expects an UnleashConfig$Builder, and sets the backupFile property of the builder.

build clj

(build & builder-param-setters)

Expects to be applied with a variadic number of arguments, each of which is a function that expects an UnleashConfig$Builder instance. Returns an instance of UnleashConfig that had all of its parameters set by said functions.

Using this building pattern allows users to manipulate the builder instance in ways that aren't implemented in this library by passing a function that expects an UnleashConfig$Builder.

Example: (build (app-name "test-app") (unleash-api "http://example.unleash.com/api"))

custom-http-header clj

(custom-http-header header-name header-value)

Expects an HTTP header name and value. Returns a function that expects an UnleashConfig$Builder, and adds the relevant HTTP header name and value to the headers used by the builder. These headers would be added to outgoing HTTP requests sent by the Unleash client to the Unleash server.

Can be used multiple times to set multiple headers.

Example: (build [(unleash-api "http://example.unleash.com/api") (custom-http-header "X-AF-HEADER-1" "a") (custom-http-header "X-AF-HEADER-2" "b") (custom-http-header "X-AF-HEADER-3" "c")])

custom-http-header-provider clj

(custom-http-header-provider provider)

Expects an instance of CustomHttpHeadersProvider, which adds headers to outgoing HTTP requests that are sent to the Unleash server, based on the contents of the request itself. Returns a function that expects an UnleashConfig$Builder, and sets the custom-http-headers-provider property of the builder.

enable-proxy-authentication-by-jvm-properties clj

(enable-proxy-authentication-by-jvm-properties)

Expects a boolean that controls if authentication against an HTTP proxy would use the JVM settings http.proxyUser and http.proxyPassword. Returns a function that expects an UnleashConfig$Builder, and sets the isProxyAuthenticationByJvmProperties property of the builder.

environment clj

(environment environment)

Expects an application environment. Returns a function that expects an UnleashConfig$Builder, and sets the environment property of the builder.

fetch-toggles-interval clj

(fetch-toggles-interval interval-seconds)

Expects a long that marks the interval (in seconds) of fetching toggles' states from the Unleash server. Returns a function that expects an UnleashConfig$Builder, and sets the fetchTogglesInterval property of the builder.

instance-id clj

(instance-id id)

Expects an instance ID. Returns a function that expects an UnleashConfig$Builder, and sets the instanceId property of the builder.

scheduled-executor clj

(scheduled-executor executor)

Expects an instance of UnleashScheduledExecutor, which would be used to periodically send usage metrics. The interval of sending those metrics can be set with 'send-metrics-interval'. Returns a function that expects an UnleashConfig$Builder, and sets the scheduledExecutor property of the builder.

send-metrics-interval clj

(send-metrics-interval interval-seconds)

Expects a long that marks the interval (in seconds) of sending metrics. Returns a function that expects an UnleashConfig$Builder, and sets the sendMetricsInterval property of the builder.

subscriber clj

(subscriber subscriber)

Expects an instance of UnleashSubscriber, which would be notified when the Unleash client's internal state changes. Returns a function that expects an UnleashConfig$Builder, and sets the subscriber property of the builder.

synchronous-fetch-on-initialisation clj

(synchronous-fetch-on-initialisation enable?)

Expects a boolean that controls if toggles are fetched synchronously when the Unleash client is initialised. Returns a function that expects an UnleashConfig$Builder, and sets the synchronousFetchOnInitialisation property of the builder.

unleash-api clj

(unleash-api api)

Expects a URL for an Unleash server. Returns a function that expects an UnleashConfig$Builder, and sets the unleashAPI property of the builder.

unleash-context-provider clj

(unleash-context-provider provider)

Expects an instance of UnleashContextProvider, which would provide the context for calls of enabled? instead of having it provided as an arguments in the call site. Returns a function that expects an UnleashConfig$Builder, and sets the contextProvider property of the builder.