Class FieldAccessHelper

java.lang.Object

com.kingsrook.qqq.backend.core.actions.permissions.fieldaccess.FieldAccessHelper

public final class FieldAccessHelper
extends Object

Single entry point for field policy, enforcement, masking and audit notifications.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	FieldAccessHelper.PendingExactMatch	Per-invocation exact searches, completed only by the action that enforced them.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CACHE_KEY

Method Summary

Modifier and Type	Method	Description
static void	applyToAuditDetails(String tableName, List<QRecord> auditDetails)	Mask historical values without honoring reveal grants.
static void	applyToProcessRecords(String processName, String fallbackTable, List<QRecord> records)	Process records can belong to different tables, independently of the process.
static void	applyToRecords(String tableName, List<QueryJoin> joins, List<QRecord> records, String actionName)	Mask once, recursively, and emit one value-free view event per table.
static QTableMetaData	applyToTable(QTableMetaData table)	Clone only when restricting metadata; do not expose restricted defaults.
static FieldAccessHelper.PendingExactMatch	assertCriteriaAllowed(String tableName, List<QueryJoin> joins, QQueryFilter filter, Collection<String> sortGroupAggregateFieldNames)	Check filters and ordering before querying; successful exact searches are audited once per table.
static FieldAccessHelper.PendingExactMatch	assertCriteriaAllowed(String tableName, List<QueryJoin> joins, QQueryFilter filter, Collection<String> sortGroupAggregateFieldNames, boolean checkExactMatch)	Criteria-only mode has no fingerprints, guardrail callbacks or audit events.
static void	assertSelectedFieldsAllowed(String tableName, List<QueryJoin> joins, Collection<String> names)	Selecting masks is allowed; explicit selection of a HIDDEN field retains the legacy denial.
static void	assertWritesAllowed(QTableMetaData table, List<QRecord> records)	Refuse supplied values, including explicit null, for non-FULL fields.
static boolean	canFilter(QTableMetaData table, String fieldName, QCriteriaOperator operator)	Whether the policy permits this filter operator, including enumeration restrictions.
static String	getAccessFingerprint()	Stable fingerprint of the resolver, channel and effective restrictions.
static FieldAccessDecision	getDecision(QTableMetaData table, QFieldMetaData field)	Combine locks, cached resolver decisions and the channel ceiling.
static FieldAccessTier	getLockTier(QFieldMetaData field)	Evaluate the legacy override flip and all-access keys.
static FieldAccessTier	getTier(QTableMetaData table, String fieldName)	Effective access for a real or virtual field.
static Map<String,FieldAccessTier>	getTiers(QTableMetaData table)	Access for real and virtual fields, in metadata order.
static boolean	isRecordLabelFullAccess(QTableMetaData table)	Labels must contain only fields that are fully readable.

Methods inherited from class java.lang.Object

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

Field Details

CACHE_KEY

public static final String CACHE_KEY

Method Details

getTier

public static FieldAccessTier getTier(QTableMetaData table,
 String fieldName)

Effective access for a real or virtual field.

getDecision

public static FieldAccessDecision getDecision(QTableMetaData table,
 QFieldMetaData field)

Combine locks, cached resolver decisions and the channel ceiling. Never cache reveal grants. Primary keys are exempt from every policy ceiling.

getLockTier

public static FieldAccessTier getLockTier(QFieldMetaData field)

Evaluate the legacy override flip and all-access keys.

getTiers

public static Map<String,FieldAccessTier> getTiers(QTableMetaData table)

Access for real and virtual fields, in metadata order.

getAccessFingerprint

public static String getAccessFingerprint()

Stable fingerprint of the resolver, channel and effective restrictions.

assertCriteriaAllowed

public static FieldAccessHelper.PendingExactMatch assertCriteriaAllowed(String tableName,
 List<QueryJoin> joins,
 QQueryFilter filter,
 Collection<String> sortGroupAggregateFieldNames)
                                                                 throws QPermissionDeniedException

Check filters and ordering before querying; successful exact searches are audited once per table.

Throws:

QPermissionDeniedException

assertCriteriaAllowed

public static FieldAccessHelper.PendingExactMatch assertCriteriaAllowed(String tableName,
 List<QueryJoin> joins,
 QQueryFilter filter,
 Collection<String> sortGroupAggregateFieldNames,
 boolean checkExactMatch)
                                                                 throws QPermissionDeniedException

Criteria-only mode has no fingerprints, guardrail callbacks or audit events.

Throws:

QPermissionDeniedException

applyToTable

public static QTableMetaData applyToTable(QTableMetaData table)

Clone only when restricting metadata; do not expose restricted defaults.

assertWritesAllowed

public static void assertWritesAllowed(QTableMetaData table,
 List<QRecord> records)
                                throws QPermissionDeniedException

Refuse supplied values, including explicit null, for non-FULL fields.

Throws:

QPermissionDeniedException

applyToRecords

public static void applyToRecords(String tableName,
 List<QueryJoin> joins,
 List<QRecord> records,
 String actionName)

Mask once, recursively, and emit one value-free view event per table.

applyToProcessRecords

public static void applyToProcessRecords(String processName,
 String fallbackTable,
 List<QRecord> records)

Process records can belong to different tables, independently of the process. Unknown ownership cannot safely inherit another table's field policy.

assertSelectedFieldsAllowed

public static void assertSelectedFieldsAllowed(String tableName,
 List<QueryJoin> joins,
 Collection<String> names)
                                        throws QPermissionDeniedException

Selecting masks is allowed; explicit selection of a HIDDEN field retains the legacy denial.

Throws:

QPermissionDeniedException

canFilter

public static boolean canFilter(QTableMetaData table,
 String fieldName,
 QCriteriaOperator operator)

Whether the policy permits this filter operator, including enumeration restrictions.

isRecordLabelFullAccess

public static boolean isRecordLabelFullAccess(QTableMetaData table)

Labels must contain only fields that are fully readable.

applyToAuditDetails

public static void applyToAuditDetails(String tableName,
 List<QRecord> auditDetails)

Mask historical values without honoring reveal grants. Supports joined audit detail rows.