Package com.avoka.tm.svc

Class ErrorLogger

  • public class ErrorLogger
extends java.lang.Object

    Provides an Error Logger service which will log errors to the Transact error log database table.

    Examples

    Please find the email service examples about sending and queuing below.

    Create Error Log Record For Transaction

    The example below creates a Error Log record associated with the specified transaction record. 

     new ErrorLogger()
      .setTxnId(txnId)
      .setError(error)
      .log()

    Create 'Form Delivery' Log Record For Transaction

    The example below creates a 'Form Delivery' type error log record associated with the specified transaction record. 

     new ErrorLogger()
      .setError(error)
      .setType("Form Delivery")
      .setTxn(txn)
      .log()
    Since:
    5.0.0

    • Constructor Summary

      Constructors 
      Constructor Description
      ErrorLogger()  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.Long log()
      Log the error creating an error log database record and return the error log record id.
      ErrorLogger setError​(java.lang.Throwable error)
      The error to log.
      ErrorLogger setTxn​(Txn txn)
      Set the transaction to associate with the error log.
      ErrorLogger setTxnId​(java.lang.Long txnId)
      Set the transaction record id to associate with the error log.
      ErrorLogger setType​(java.lang.String type)
      Set the error log type property use to classify the error log record.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • ErrorLogger

        public ErrorLogger()

    • Method Detail

      • setError

        public ErrorLogger setError​(java.lang.Throwable error)
        The error to log.
        Parameters:
        error - the exception to log
        Returns:
        the error logger;

      • setType

        public ErrorLogger setType​(java.lang.String type)
        Set the error log type property use to classify the error log record.
        • Collaboration Job
        • Email
        • Form Delivery
        • Form Dynamic Data
        • Form Render
        • Form Submission
        • LiveCycle
        • Management
        • Payment Gateway
        • Receipt Render
        • REST SOAP API
        • Scheduled Job
        • Security Manager
        • T.Field Sync
        • Unclassified
        Parameters:
        type - the error log record type (required)
        Returns:
        the error logger

      • setTxn

        public ErrorLogger setTxn​(Txn txn)
        Set the transaction to associate with the error log.
        Parameters:
        txn - the transaction to associate with the error log
        Returns:
        the error logger

      • setTxnId

        public ErrorLogger setTxnId​(java.lang.Long txnId)
        Set the transaction record id to associate with the error log.
        Parameters:
        txnId - the transaction record id to associate with the error log
        Returns:
        the error logger

      • log

        public java.lang.Long log()
        Log the error creating an error log database record and return the error log record id.
        Returns:
        the new error log record id