Package org.copperengine.core.audit

Interface AuditTrail

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      int getLevel()  
      boolean isEnabled​(int level)  
      void setLevel​(int level)  
      void synchLog​(int logLevel, java.util.Date occurrence, java.lang.String conversationId, java.lang.String context, java.lang.String instanceId, java.lang.String correlationId, java.lang.String transactionId, java.lang.String message, java.lang.String messageType)
      writes an event to the audit trail log and returns after the log message is written to the underlying storage.
      void synchLog​(AuditTrailEvent e)
      writes an event to the audit trail log and returns after the log message is written to the underlying storage.

    • Method Detail

      • isEnabled

        boolean isEnabled​(int level)

      • setLevel

        void setLevel​(int level)

      • getLevel

        int getLevel()

      • synchLog

        void synchLog​(int logLevel,
              java.util.Date occurrence,
              java.lang.String conversationId,
              java.lang.String context,
              java.lang.String instanceId,
              java.lang.String correlationId,
              java.lang.String transactionId,
              java.lang.String message,
              java.lang.String messageType)
        writes an event to the audit trail log and returns after the log message is written to the underlying storage.
        Parameters:
        logLevel - the level on that the audit trail event is recorded (might be used for filtering)
        occurrence - timestamp of the audit trail event
        conversationId - conversation id embraces all audit trail events for one business process (might be the same for a whole business transaction over a range of involved systems)
        context - the context of the audit trail event (e.g. a camel route, a workflow task, ...)
        instanceId - workflow id for a single workflow
        correlationId - correlates a request response pair (e.g. workflow calls another workflow, workflow calls a camel route, ...)
        transactionId - Same ID vor several conversations, that belongs to the same transaction. Example: ExecuteOrder (conversation 1), ChangeOrder (conversation 2) and CancelOrder (conversation 3) that all belongs to transaction 77. When transaction 77 can be deleted, all conversations for this transaction can be deleted.
        message - a message describing the audit trail event
        messageType - type of the message, e.g. XML, used for message rendering in the COPPER monitor

      • synchLog

        void synchLog​(AuditTrailEvent e)
        writes an event to the audit trail log and returns after the log message is written to the underlying storage.
        Parameters:
        e - the AuditTrailEvent to be logged