Package org.apache.tika.pipes.core.emitter

Class EmitterManager

java.lang.Object

org.apache.tika.pipes.core.AbstractComponentManager<Emitter,EmitterFactory>

org.apache.tika.pipes.core.emitter.EmitterManager

public class EmitterManager
extends AbstractComponentManager<Emitter,EmitterFactory>

Utility class that will apply the appropriate emitter to the emitterString based on the prefix.

This does not allow multiple emitters supporting the same prefix. Emitters are instantiated lazily on first use.

Field Summary

Fields inherited from class org.apache.tika.pipes.core.AbstractComponentManager

pluginManager

Method Summary

Modifier and Type	Method	Description
protected TikaException	createNotFoundException(String message)	Creates a not-found exception for this component type.
void	deleteEmitter(String emitterId)	Deletes an emitter configuration by ID.
protected String	getComponentName()	Returns the component name for error messages (e.g., "fetcher", "emitter").
ExtensionConfig	getConfig(String emitterId)	Gets the configuration for a specific emitter by ID.
protected String	getConfigKey()	Returns the JSON configuration key for this component type (e.g., "fetchers", "emitters").
Emitter	getEmitter()	Convenience method that returns an emitter if only one emitter is configured.
Emitter	getEmitter(String emitterName)	Gets an emitter by ID, lazily instantiating it if needed.
protected Class<EmitterFactory>	getFactoryClass()	Returns the factory class for this component type.
static EmitterManager	load(org.pf4j.PluginManager pluginManager, TikaJsonConfig tikaJsonConfig)	Loads an EmitterManager without allowing runtime modifications.
static EmitterManager	load(org.pf4j.PluginManager pluginManager, TikaJsonConfig tikaJsonConfig, boolean allowRuntimeModifications)	Loads an EmitterManager with optional support for runtime modifications.
static EmitterManager	load(org.pf4j.PluginManager pluginManager, TikaJsonConfig tikaJsonConfig, boolean allowRuntimeModifications, ConfigStore configStore)	Loads an EmitterManager with optional support for runtime modifications and a custom config store.
void	saveEmitter(ExtensionConfig config)	Dynamically adds or updates an emitter configuration at runtime.

Methods inherited from class org.apache.tika.pipes.core.AbstractComponentManager

deleteComponent, getComponent, getComponent, getComponentConfig, getConfigStore, getFactories, getSupported, saveComponent, validateAndCollectConfigs

Methods inherited from class java.lang.Object

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

Method Details

load

public static EmitterManager load(org.pf4j.PluginManager pluginManager,
 TikaJsonConfig tikaJsonConfig)
                           throws IOException,
TikaConfigException

Loads an EmitterManager without allowing runtime modifications. Use load(PluginManager, TikaJsonConfig, boolean) to enable runtime emitter additions.

Parameters:

pluginManager - the plugin manager

tikaJsonConfig - the configuration

Returns:

an EmitterManager that does not allow runtime modifications

Throws:

IOException

TikaConfigException

load

public static EmitterManager load(org.pf4j.PluginManager pluginManager,
 TikaJsonConfig tikaJsonConfig,
 boolean allowRuntimeModifications)
                           throws IOException,
TikaConfigException

Loads an EmitterManager with optional support for runtime modifications.

Parameters:

pluginManager - the plugin manager

tikaJsonConfig - the configuration

allowRuntimeModifications - if true, allows calling saveEmitter(ExtensionConfig) to add emitters at runtime

Returns:

an EmitterManager

Throws:

IOException

TikaConfigException

load

public static EmitterManager load(org.pf4j.PluginManager pluginManager,
 TikaJsonConfig tikaJsonConfig,
 boolean allowRuntimeModifications,
 ConfigStore configStore)
                           throws IOException,
TikaConfigException

Loads an EmitterManager with optional support for runtime modifications and a custom config store.

Parameters:

pluginManager - the plugin manager

tikaJsonConfig - the configuration

allowRuntimeModifications - if true, allows calling saveEmitter(ExtensionConfig) to add emitters at runtime

configStore - custom config store implementation, or null to use default in-memory store

Returns:

an EmitterManager

Throws:

IOException

TikaConfigException

getConfigKey

protected String getConfigKey()

Description copied from class: AbstractComponentManager

Returns the JSON configuration key for this component type (e.g., "fetchers", "emitters").

Specified by:

getConfigKey in class AbstractComponentManager<Emitter,EmitterFactory>

getFactoryClass

protected Class<EmitterFactory> getFactoryClass()

Description copied from class: AbstractComponentManager

Returns the factory class for this component type.

Specified by:

getFactoryClass in class AbstractComponentManager<Emitter,EmitterFactory>

getComponentName

protected String getComponentName()

Description copied from class: AbstractComponentManager

Returns the component name for error messages (e.g., "fetcher", "emitter").

Specified by:

getComponentName in class AbstractComponentManager<Emitter,EmitterFactory>

createNotFoundException

protected TikaException createNotFoundException(String message)

Description copied from class: AbstractComponentManager

Creates a not-found exception for this component type.

Specified by:

createNotFoundException in class AbstractComponentManager<Emitter,EmitterFactory>

getEmitter

public Emitter getEmitter(String emitterName)
                   throws IOException,
TikaException

Gets an emitter by ID, lazily instantiating it if needed.

Parameters:

emitterName - the emitter ID

Returns:

the emitter

Throws:

EmitterNotFoundException - if no emitter with the given ID exists

IOException - if there's an error building the emitter

TikaException - if there's a configuration error

getEmitter

public Emitter getEmitter()
                   throws IOException,
TikaException

Convenience method that returns an emitter if only one emitter is configured. If 0 or > 1 emitters are configured, this throws an IllegalArgumentException.

Returns:

the single configured emitter

Throws:

IOException - if there's an error building the emitter

TikaException - if there's a configuration error

saveEmitter

public void saveEmitter(ExtensionConfig config)
                 throws TikaConfigException,
IOException

Dynamically adds or updates an emitter configuration at runtime. The emitter will not be instantiated until it is first requested via getEmitter(String). This allows for dynamic configuration without the overhead of immediate instantiation. If an emitter with the same ID already exists, it will be replaced and the cached instance cleared.

This method is only available if the EmitterManager was loaded with load(PluginManager, TikaJsonConfig, boolean) with allowRuntimeModifications=true.

Only authorized/authenticated users should be allowed to modify emitters. BE CAREFUL.

Parameters:

config - the extension configuration for the emitter

Throws:

TikaConfigException - if the emitter type is unknown or if runtime modifications are not allowed

IOException - if there is an error accessing the plugin manager

deleteEmitter

public void deleteEmitter(String emitterId)
                   throws TikaConfigException

Deletes an emitter configuration by ID.

Parameters:

emitterId - the emitter ID to delete

Throws:

TikaConfigException - if runtime modifications are not allowed or emitter not found

getConfig

public ExtensionConfig getConfig(String emitterId)

Gets the configuration for a specific emitter by ID.

Parameters:

emitterId - the emitter ID

Returns:

the emitter configuration, or null if not found