Table of Contents

Interface IElasticsearchSecurityAuditorReporting

Namespace
Excalibur.Data.ElasticSearch.Security
Assembly
Excalibur.Data.ElasticSearch.dll

Extends IElasticsearchSecurityAuditor with reporting and compliance query capabilities.

public interface IElasticsearchSecurityAuditorReporting

Remarks

Consumers check for this capability via pattern matching:

if (auditor is IElasticsearchSecurityAuditorReporting reporting) { ... }

Methods

GenerateAuditReportAsync(AuditReportRequest, CancellationToken)

Generates a comprehensive security audit report for the specified time period.

Task<SecurityAuditReport> GenerateAuditReportAsync(AuditReportRequest reportRequest, CancellationToken cancellationToken)

Parameters

reportRequest AuditReportRequest

The audit report generation request with filters and parameters.

cancellationToken CancellationToken

The cancellation token to monitor for cancellation requests.

Returns

Task<SecurityAuditReport>

A task that represents the asynchronous operation. The task result contains the generated audit report with security events and compliance information.

Exceptions

SecurityException

Thrown when report generation fails due to security constraints.

ArgumentNullException

Thrown when the report request is null.

GenerateComplianceReportAsync(ComplianceReportRequest, CancellationToken)

Generates a compliance report for specific regulatory frameworks.

Task<ComplianceReport> GenerateComplianceReportAsync(ComplianceReportRequest complianceRequest, CancellationToken cancellationToken)

Parameters

complianceRequest ComplianceReportRequest

The compliance report generation request with framework specifications.

cancellationToken CancellationToken

The cancellation token to monitor for cancellation requests.

Returns

Task<ComplianceReport>

A task that represents the asynchronous operation. The task result contains the generated compliance report formatted according to the specified regulatory requirements.

Exceptions

SecurityException

Thrown when compliance report generation fails due to security constraints.

ArgumentNullException

Thrown when the compliance request is null.

SearchAuditEventsAsync(AuditSearchRequest, CancellationToken)

Searches audit events based on specified criteria for investigation and analysis.

Task<AuditSearchResult> SearchAuditEventsAsync(AuditSearchRequest searchRequest, CancellationToken cancellationToken)

Parameters

searchRequest AuditSearchRequest

The audit search request with filters and criteria.

cancellationToken CancellationToken

The cancellation token to monitor for cancellation requests.

Returns

Task<AuditSearchResult>

A task that represents the asynchronous operation. The task result contains the matching audit events and search result metadata.

Exceptions

SecurityException

Thrown when audit search fails due to security constraints.

ArgumentNullException

Thrown when the search request is null.