Package io.opentelemetry.sdk.autoconfigure.internal

Class SpiHelper

java.lang.Object

io.opentelemetry.sdk.autoconfigure.internal.SpiHelper

public final class SpiHelper
extends java.lang.Object

This class is internal and is hence not for public use. Its APIs are unstable and can change at any time.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static class	SpiHelper.ServiceLoaderComponentLoader

Field Summary

Fields

Modifier and Type	Field	Description
private ComponentLoader	componentLoader
private java.util.Set<AutoConfigureListener>	listeners

Constructor Summary

Constructors

Modifier	Constructor	Description
private	SpiHelper(ComponentLoader componentLoader)

Method Summary

Modifier and Type	Method	Description
static SpiHelper	create(ComponentLoader componentLoader)	Create a SpiHelper which loads SPIs using the componentLoader.
static SpiHelper	create(java.lang.ClassLoader classLoader)	Create a SpiHelper which loads SPIs using the classLoader.
ComponentLoader	getComponentLoader()	Return the backing underlying ComponentLoader.
java.util.Set<AutoConfigureListener>	getListeners()	Return the set of SPIs loaded which implement AutoConfigureListener.
<T> java.util.List<T>	load(java.lang.Class<T> spiClass)	Load implementations of an SPI.
<T> T	loadComponent(java.lang.Class<T> type, java.lang.String name, StructuredConfigProperties config)	Find a registered ComponentProvider with ComponentProvider.getType() matching type, ComponentProvider.getName() matching name, and call ComponentProvider.create(StructuredConfigProperties) with the given config.
<T,S> NamedSpiManager<T>	loadConfigurable(java.lang.Class<S> spiClass, java.util.function.Function<S,java.lang.String> getName, java.util.function.BiFunction<S,ConfigProperties,T> getConfigurable, ConfigProperties config)	Load implementations of an SPI which are configurable (i.e.
<T extends Ordered> java.util.List<T>	loadOrdered(java.lang.Class<T> spiClass)	Load implementations of an ordered SPI (i.e.
private void	maybeAddListener(java.lang.Object object)
static ComponentLoader	serviceComponentLoader(java.lang.ClassLoader classLoader)	Create a ComponentLoader which loads using the classLoader.

Methods inherited from class java.lang.Object

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

Field Detail

componentLoader

private final ComponentLoader componentLoader

listeners

private final java.util.Set<AutoConfigureListener> listeners

Constructor Detail

SpiHelper

private SpiHelper(ComponentLoader componentLoader)

Method Detail

create

public static SpiHelper create(java.lang.ClassLoader classLoader)

Create a SpiHelper which loads SPIs using the classLoader.

create

public static SpiHelper create(ComponentLoader componentLoader)

Create a SpiHelper which loads SPIs using the componentLoader.

serviceComponentLoader

public static ComponentLoader serviceComponentLoader(java.lang.ClassLoader classLoader)

Create a ComponentLoader which loads using the classLoader.

getComponentLoader

public ComponentLoader getComponentLoader()

Return the backing underlying ComponentLoader.

loadConfigurable

public <T,S> NamedSpiManager<T> loadConfigurable(java.lang.Class<S> spiClass,
                                                       java.util.function.Function<S,java.lang.String> getName,
                                                       java.util.function.BiFunction<S,ConfigProperties,T> getConfigurable,
                                                       ConfigProperties config)

Load implementations of an SPI which are configurable (i.e. they accept ConfigProperties.

Type Parameters:

T - the configurable type

S - the SPI type

Parameters:

spiClass - the SPI class

getName - function returning the name of an SPI implementation

getConfigurable - function returning a configured instance

config - the configuration to pass to invocations of #getConfigurable

Returns:

a NamedSpiManager used to access configured instances of the SPI by name

loadComponent

public <T> T loadComponent(java.lang.Class<T> type,
                           java.lang.String name,
                           StructuredConfigProperties config)

Find a registered ComponentProvider with ComponentProvider.getType() matching type, ComponentProvider.getName() matching name, and call ComponentProvider.create(StructuredConfigProperties) with the given config.

Throws:

ConfigurationException - if no matching providers are found, or if multiple are found (i.e. conflict), or if ComponentProvider.create(StructuredConfigProperties) throws

loadOrdered

public <T extends Ordered> java.util.List<T> loadOrdered(java.lang.Class<T> spiClass)

Load implementations of an ordered SPI (i.e. implements Ordered).

Type Parameters:

T - the SPI type

Parameters:

spiClass - the SPI class

Returns:

list of SPI implementations, in order

load

public <T> java.util.List<T> load(java.lang.Class<T> spiClass)

Load implementations of an SPI.

Type Parameters:

T - the SPI type

Parameters:

spiClass - the SPI class

Returns:

list of SPI implementations

maybeAddListener

private void maybeAddListener(java.lang.Object object)

getListeners

public java.util.Set<AutoConfigureListener> getListeners()

Return the set of SPIs loaded which implement AutoConfigureListener.