Package org.apache.tika.pipes.core.fetcher

Class FetcherManager

java.lang.Object

org.apache.tika.pipes.core.AbstractComponentManager<Fetcher,FetcherFactory>

org.apache.tika.pipes.core.fetcher.FetcherManager

public class FetcherManager
extends AbstractComponentManager<Fetcher,FetcherFactory>

Utility class to hold multiple fetchers.

This forbids multiple fetchers with the same pluginId. Fetchers 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	deleteFetcher(String fetcherId)	Deletes a fetcher configuration by ID.
protected String	getComponentName()	Returns the component name for error messages (e.g., "fetcher", "emitter").
ExtensionConfig	getConfig(String fetcherId)	Gets the configuration for a specific fetcher by ID.
protected String	getConfigKey()	Returns the JSON configuration key for this component type (e.g., "fetchers", "emitters").
protected Class<FetcherFactory>	getFactoryClass()	Returns the factory class for this component type.
Fetcher	getFetcher()	Convenience method that returns a fetcher if only one fetcher is configured.
Fetcher	getFetcher(String id)	Gets a fetcher by ID, lazily instantiating it if needed.
static FetcherManager	load(org.pf4j.PluginManager pluginManager, TikaJsonConfig tikaJsonConfig)	Loads a FetcherManager without allowing runtime modifications.
static FetcherManager	load(org.pf4j.PluginManager pluginManager, TikaJsonConfig tikaJsonConfig, boolean allowRuntimeModifications)	Loads a FetcherManager with optional support for runtime modifications.
static FetcherManager	load(org.pf4j.PluginManager pluginManager, TikaJsonConfig tikaJsonConfig, boolean allowRuntimeModifications, ConfigStore configStore)	Loads a FetcherManager with optional support for runtime modifications and a custom config store.
void	saveFetcher(ExtensionConfig config)	Dynamically adds or updates a fetcher 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 FetcherManager load(org.pf4j.PluginManager pluginManager,
 TikaJsonConfig tikaJsonConfig)
                           throws TikaConfigException,
IOException

Loads a FetcherManager without allowing runtime modifications. Use load(PluginManager, TikaJsonConfig, boolean) to enable runtime fetcher additions.

Parameters:

pluginManager - the plugin manager

tikaJsonConfig - the configuration

Returns:

a FetcherManager that does not allow runtime modifications

Throws:

TikaConfigException

IOException

load

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

Loads a FetcherManager with optional support for runtime modifications.

Parameters:

pluginManager - the plugin manager

tikaJsonConfig - the configuration

allowRuntimeModifications - if true, allows calling saveFetcher(ExtensionConfig) to add fetchers at runtime

Returns:

a FetcherManager

Throws:

TikaConfigException

IOException

load

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

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

Parameters:

pluginManager - the plugin manager

tikaJsonConfig - the configuration

allowRuntimeModifications - if true, allows calling saveFetcher(ExtensionConfig) to add fetchers at runtime

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

Returns:

a FetcherManager

Throws:

TikaConfigException

IOException

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<Fetcher,FetcherFactory>

getFactoryClass

protected Class<FetcherFactory> getFactoryClass()

Description copied from class: AbstractComponentManager

Returns the factory class for this component type.

Specified by:

getFactoryClass in class AbstractComponentManager<Fetcher,FetcherFactory>

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<Fetcher,FetcherFactory>

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<Fetcher,FetcherFactory>

getFetcher

public Fetcher getFetcher(String id)
                   throws IOException,
TikaException

Gets a fetcher by ID, lazily instantiating it if needed.

Parameters:

id - the fetcher ID

Returns:

the fetcher

Throws:

FetcherNotFoundException - if no fetcher with the given ID exists

IOException - if there's an error building the fetcher

TikaException - if there's a configuration error

getFetcher

public Fetcher getFetcher()
                   throws IOException,
TikaException

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

Returns:

the single configured fetcher

Throws:

IOException - if there's an error building the fetcher

TikaException - if there's a configuration error

saveFetcher

public void saveFetcher(ExtensionConfig config)
                 throws TikaConfigException,
IOException

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

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

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

Parameters:

config - the extension configuration for the fetcher

Throws:

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

IOException - if there is an error accessing the plugin manager

deleteFetcher

public void deleteFetcher(String fetcherId)
                   throws TikaConfigException

Deletes a fetcher configuration by ID.

Parameters:

fetcherId - the fetcher ID to delete

Throws:

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

getConfig

public ExtensionConfig getConfig(String fetcherId)

Gets the configuration for a specific fetcher by ID.

Parameters:

fetcherId - the fetcher ID

Returns:

the fetcher configuration, or null if not found