io.jaegertracing.baggage

Class RemoteBaggageRestrictionManager.Builder

java.lang.Object

io.jaegertracing.baggage.RemoteBaggageRestrictionManager.Builder

Enclosing class:

RemoteBaggageRestrictionManager

public static class RemoteBaggageRestrictionManager.Builder
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
Builder(java.lang.String serviceName)

Method Summary

Modifier and Type	Method and Description
RemoteBaggageRestrictionManager	build() Creates a RemoteBaggageRestrictionManager that fetches BaggageRestrictionResponse from a remote agent and keeps track of Restriction for a service.
RemoteBaggageRestrictionManager.Builder	withDenyBaggageInitializationFailure(boolean denyBaggageOnInitializationFailure) If denyBaggageOnInitializationFailure is true, RemoteBaggageRestrictionManager will not allow any baggage to be written until baggage restrictions have been retrieved from agent.
RemoteBaggageRestrictionManager.Builder	withInitialDelayMs(int initialDelayMs) initialDelayMs is only exposed for testing purposes so users can determine when the first call to remote agent is made.
RemoteBaggageRestrictionManager.Builder	withMetrics(Metrics metrics)
RemoteBaggageRestrictionManager.Builder	withProxy(BaggageRestrictionManagerProxy proxy)
RemoteBaggageRestrictionManager.Builder	withRefreshIntervalMs(int refreshIntervalMs)

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder(java.lang.String serviceName)

Parameters:

serviceName - restrictions for this service are kept track of.

Method Detail

withProxy

public RemoteBaggageRestrictionManager.Builder withProxy(BaggageRestrictionManagerProxy proxy)

Parameters:

proxy - proxy to remote agent.

withMetrics

public RemoteBaggageRestrictionManager.Builder withMetrics(Metrics metrics)

withDenyBaggageInitializationFailure

public RemoteBaggageRestrictionManager.Builder withDenyBaggageInitializationFailure(boolean denyBaggageOnInitializationFailure)

If denyBaggageOnInitializationFailure is true, RemoteBaggageRestrictionManager will not allow any baggage to be written until baggage restrictions have been retrieved from agent. If denyBaggageOnInitializationFailure is false, RemoteBaggageRestrictionManager will allow any baggage to be written until baggage restrictions have been retrieved from agent.

Parameters:

denyBaggageOnInitializationFailure - determines the startup failure mode of RemoteBaggageRestrictionManager

withRefreshIntervalMs

public RemoteBaggageRestrictionManager.Builder withRefreshIntervalMs(int refreshIntervalMs)

Parameters:

refreshIntervalMs - how often restriction are fetched from remote agent.

withInitialDelayMs

public RemoteBaggageRestrictionManager.Builder withInitialDelayMs(int initialDelayMs)

initialDelayMs is only exposed for testing purposes so users can determine when the first call to remote agent is made. Under normal operations, this RemoteBaggageRestrictionManager will start up and asynchronously fetch restrictions. If the user wants to know if restrictions are ready, they can check via RemoteBaggageRestrictionManager.isReady().

Parameters:

initialDelayMs - delay before first fetch of restrictions.

build

public RemoteBaggageRestrictionManager build()

Creates a RemoteBaggageRestrictionManager that fetches BaggageRestrictionResponse from a remote agent and keeps track of Restriction for a service.