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

Defines the canonical export fields for each index.

This registry backs both the Fields panel and document filtering. Fields marked required in the reference documentation always remain enabled; toggleable fields map to the optional checkboxes shown in the UI.

Field Summary

Fields

Modifier and Type	Field	Description
static final List<String>	INDEX_ORDER	Index short names in internal display order.
static final List<String>	INDEX_ORDER_FOR_FIELDS_PANEL	Index order shown in the Fields panel.

Method Summary

Modifier and Type	Method	Description
static Set<String>	getAllowedKeys(String indexShortName, Set<String> enabledToggleable)	Returns the field keys allowed for documents written to the index.
static List<String>	getRequiredFields(String indexShortName)	Returns the required top-level field keys for the index as an unmodifiable list.
static List<String>	getToggleableFields(String indexShortName)	Returns the toggleable field keys for the index as an unmodifiable list.

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 internal display order.

INDEX_ORDER_FOR_FIELDS_PANEL

public static final List<String> INDEX_ORDER_FOR_FIELDS_PANEL

Index order shown in the Fields panel.

Method Details

getToggleableFields

public static List<String> getToggleableFields(String indexShortName)

Returns the toggleable field keys for the index as an unmodifiable list.

getRequiredFields

public static List<String> getRequiredFields(String indexShortName)

Returns the required top-level field keys for the index as an unmodifiable list.

getAllowedKeys

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

Returns the field keys allowed for documents written to the index.

The result always contains the required keys. When enabledToggleable is null or empty, all toggleable keys are included. Otherwise only the selected toggleable keys are added.