Class SensitiveContentScannerUnavailableException

Namespace

MailFathom.Application.SensitiveContent.Detection

Assembly

MailFathom.Application.dll

The failure raised when a scanner an operator switched on could not establish what a text carries.

public sealed class SensitiveContentScannerUnavailableException : MailFathomException, ISerializable

Inheritance

object

Exception

MailFathomException

SensitiveContentScannerUnavailableException

Implements

ISerializable

Inherited Members

Exception.GetBaseException()

Exception.GetType()

Exception.ToString()

Exception.Data

Exception.HelpLink

Exception.HResult

Exception.InnerException

Exception.Message

Exception.Source

Exception.StackTrace

Exception.TargetSite

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.ReferenceEquals(object, object)

Remarks

This is the whole of the fail-closed contract. An opt-in that degraded to handing the text on under load would be worse than no switch at all, because the operator would believe the protection was in force, so a detector that is unreachable, slow past its budget, or broken blocks the operation it guards rather than letting it through.

The message names the scanner and, where a budget was spent, how much of one. It names no text, no finding, and no endpoint: none of them is something the caller can act on, and the content the scan was about is exactly what must not appear in a failure written to a log.

Properties

ErrorCode

Gets the stable code identifying this failure to a boundary that must report it without naming a type.

Scanner

Gets which scanner could not answer.

Methods

DidNotAnswerInTime(SensitiveContentScannerKind, TimeSpan)

Refuses an operation whose scanner did not answer inside the configured budget.

Failed(SensitiveContentScannerKind, Exception)

Refuses an operation whose scanner failed.

NotRegistered(SensitiveContentScannerKind)

Refuses an operation whose scanner is switched on and absent from the running deployment.