Package ai.attackframework.tools.burp.utils.config

Class ExportFieldRegistry

java.lang.Object

ai.attackframework.tools.burp.utils.config.ExportFieldRegistry

public final class ExportFieldRegistry
extends Object

Canonical list of export fields per index for the Fields panel and document filtering. "Is required" column: toggleable = No or No*, required = Yes. Keep this class as the single source of truth when adding or changing index fields.

Field Summary

Fields

Modifier and Type	Field	Description
static final List<String>	INDEX_ORDER	Index short names in display order (tool, traffic, settings, sitemap, findings).
static final List<String>	INDEX_ORDER_FOR_FIELDS_PANEL	Indexes shown in the Fields panel (excludes tool, which is administrative and not user-toggleable).

Method Summary

Modifier and Type	Method	Description
static Set<String>	getAllowedKeys(String indexShortName, Set<String> enabledToggleable)	Returns the set of field keys that may be included in documents for this index: required + (enabledToggleable if provided, else all toggleable).
static List<String>	getRequiredFields(String indexShortName)	Returns an unmodifiable list of required top-level keys for the index (Yes in REFERENCE).
static List<String>	getToggleableFields(String indexShortName)	Returns an unmodifiable list of toggleable field keys for the index (No / No* in REFERENCE).

Methods inherited from class java.lang.Object

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

Field Details

INDEX_ORDER

public static final List<String> INDEX_ORDER

Index short names in display order (tool, traffic, settings, sitemap, findings).

INDEX_ORDER_FOR_FIELDS_PANEL

public static final List<String> INDEX_ORDER_FOR_FIELDS_PANEL

Indexes shown in the Fields panel (excludes tool, which is administrative and not user-toggleable). Order matches ConfigSourcesPanel: Settings, Sitemap, Findings, Traffic.

Method Details

getToggleableFields

public static List<String> getToggleableFields(String indexShortName)

Returns an unmodifiable list of toggleable field keys for the index (No / No* in REFERENCE).

getRequiredFields

public static List<String> getRequiredFields(String indexShortName)

Returns an unmodifiable list of required top-level keys for the index (Yes in REFERENCE).

getAllowedKeys

public static Set<String> getAllowedKeys(String indexShortName,
 Set<String> enabledToggleable)

Returns the set of field keys that may be included in documents for this index: required + (enabledToggleable if provided, else all toggleable). Used for document filtering (which fields to include in pushed documents).