Class AuditEvent

  • All Implemented Interfaces:
    Serializable

    public final class AuditEvent
    extends EventObject
    Raw event for audit.

    I'm not very satisfied about the design of this event since there are optional methods that will return null in most of the case. This will need some work to clean it up especially if we want to introduce a more sequential reporting action rather than a packet reporting. This will allow for example to follow the process quickly in an interface or a servlet (yep, that's cool to run a check via a web interface in a source repository ;-)

    See Also:
    AuditListener, Serialized Form
    • Constructor Detail

      • AuditEvent

        public AuditEvent​(Object source)
        Creates a new instance.
        Parameters:
        source - the object that created the event
      • AuditEvent

        public AuditEvent​(Object src,
                          String fileName)
        Creates a new AuditEvent instance.
        Parameters:
        src - source of the event
        fileName - file associated with the event
      • AuditEvent

        public AuditEvent​(Object src,
                          String fileName,
                          Violation violation)
        Creates a new AuditEvent instance.
        Parameters:
        src - source of the event
        fileName - file associated with the event
        violation - the actual violation
    • Method Detail

      • getFileName

        public String getFileName()
        Returns name of file being audited.
        Returns:
        the file name currently being audited or null if there is no relation to a file.
      • getLine

        public int getLine()
        Return the line number on the source file where the event occurred. This may be 0 if there is no relation to a file content.
        Returns:
        an integer representing the line number in the file source code.
      • getMessage

        public String getMessage()
        Return the violation associated to the event.
        Returns:
        the event violation
      • getColumn

        public int getColumn()
        Gets the column associated with the violation.
        Returns:
        the column associated with the violation
      • getModuleId

        public String getModuleId()
        Returns id of module.
        Returns:
        the identifier of the module that generated the event. Can return null.
      • getSourceName

        public String getSourceName()
        Gets the name of the source for the violation.
        Returns:
        the name of the source for the violation