Plugin indexing interface
The plugin indexing interface provides access to read and set a range of configuration options that apply during indexing. This includes:
xml index settings
To interact with indexing, you will need to implement the IndexingConfigProvider interface.
IndexingConfigProvider interface provides several methods that can be implemented independently.
Each of these methods will be given a
IndexConfigProviderContext which provides the configuration for the collection being updated.
Metadata mappings can be defined using:
void metadataMappings(IndexConfigProviderContext context, MetadataMappingConsumer consumer)
metadataMappings for an example on how to use the consumer to provide a new metadata mapping. This page also has an explanation on how conflicts are resolved.
External metadata can be set using:
void externalMetadata(IndexConfigProviderContext context, ExternalMetadataConsumer consumer)
externalMetadata for an example on how to use the consumer to provide new external metadata mappings. This page also has an explanation on how conflicts are resolved.
Gscopes can be set by implementing one of two methods:
void supplyGscopesByQuery(IndexConfigProviderContext context, GscopeByQueryConsumer consumer) void supplyGscopesByRegex(IndexConfigProviderContext context, GscopeByRegexConsumer consumer)
void killByExactMatch(IndexConfigProviderContext context, KillByExactMatchConsumer consumer) void killByPartialMatch(IndexConfigProviderContext context, KillByPartialMatchConsumer consumer)
Configuration for XML indexing can be supplied by implementing:
XmlIndexingConfig xmlIndexingConfig(IndexConfigProviderContext context)
Auto-completion CSV can be set per-profile, with one for each profile that this plugin is enabled on.
Once the plugin is enabled on a collection, the implemented plugin methods will be executed during the next collection update.
As the plugin will be run during a collection update, logging from above methods will appear in the collection’s indexer logs.