Interface ISecurityEventLogger

All Known Subinterfaces:
IAppSessionGyro, IClientSessionGyro
All Known Implementing Classes:
AppSessionGyro, ClientSessionGyro

public interface ISecurityEventLogger
Logs a security event of a client session or an application session (CC-SIGNIN-RECORDS-AND-SECURITY-LOG, order 556): the API an application's Java code and the server's own code use to record something serious that happened in a session - a sign-in refused, a second factor that failed, a recovery code used, a policy changed. The session fills in who and where: its user, application, device, client address and the place the server knows for it. Every event goes to the server log through ILog at the level of its severity, and is kept in the table IZS.SECURITY_EVENTS for ServerAdmin, purged with the sign-in records ($signIn.signInRecordDays). A failure to keep an event never fails the caller.

Implemented by IClientSessionGyro and IAppSessionGyro. Example, from an application's event handler:

event.getClientSessionGyro().logSecurityEvent(SecuritySeverity.WARNING,SecurityEventKind.OTHER,"Export of every patient record requested");

Author:
Christopher Mindus
  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    The most characters of the text that are kept; a longer text is cut.
  • Method Summary

    Modifier and Type
    Method
    Description
    void
    Logs a security event of this session.
  • Field Details

    • MAX_TEXT_LENGTH

      static final int MAX_TEXT_LENGTH
      The most characters of the text that are kept; a longer text is cut.
      See Also:
  • Method Details

    • logSecurityEvent

      void logSecurityEvent(SecuritySeverity severity, SecurityEventKind kind, String text)
      Logs a security event of this session. Never throws; nothing here is secret-safe for the caller: never put a password, a token or a code in the text.
      Parameters:
      severity - The severity.
      kind - The kind; SecurityEventKind.OTHER for an application's own.
      text - What happened, in plain words, English; null for the kind's name alone. Cut to MAX_TEXT_LENGTH characters.
      Throws:
      NullPointerException - If severity or kind is null.