Package ca.cdr.api.camel

Interface ICamelProcessorTxLogHelper

All Known Subinterfaces:
ICdaCamelProcessorTxLogHelper, IGenericCamelProcessorTxLogHelper, IHl7V2CamelProcessorTxLogHelper
public interface ICamelProcessorTxLogHelper

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    TX_LOG_PARAM_SHOW_BODY
    Requests to include message body in the transaction log step Default value is true

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    addStepIfTxLogActive(org.apache.camel.Exchange theExchange, ITxLogStepsProvider theStepsProvider)
    If transaction logging was initiated (smile:txLogStart procedure, present before current procedure in route), adds step from provider to the transaction log
    void
    addStepIfTxLogActive(org.apache.camel.Exchange theExchange, String theProcedureName)
    If transaction logging was initiated (smile:txLogStart procedure, present before current procedure in route), adds a log step to the transaction log
    void
    addStepIfTxLogActive(org.apache.camel.Exchange theExchange, List<TransactionLogStepJson> theLogSteps)
    If transaction logging was initiated (smile:txLogStart procedure, present before current procedure in route), adds step from provider to the transaction log, adds the list of steps to the transaction log
    TransactionLogStepJson
    buildTxLogStep(org.apache.camel.Exchange theExchange, TransactionLogStepTypeEnum theLogStepType, org.apache.commons.lang3.tuple.Pair<String,TransactionLogBodyTypeEnum> theBodyAndType)
    Builds a new transaction log step from provided exchange properties and parameters.
    default TransactionLogStepJson
    buildTxLogStep(org.apache.camel.Exchange theExchange, TransactionLogStepTypeEnum theLogStepType, org.apache.commons.lang3.tuple.Pair<String,TransactionLogBodyTypeEnum> theBodyAndType, TransactionLogOutcomeEnum theOutcome)
    Deprecated.
    use buildTxLogStep(Exchange, TransactionLogStepTypeEnum, Pair) Builds a new transaction log step considering received exchange properties and parameters.
    void
    clearTxLog(org.apache.camel.Exchange theExchange)
    Discards current transaction logging and marks logging not initiated for the route
    void
    commitTxLog(org.apache.camel.Exchange theExchange)
    Commits the transaction log to configured writers
    String
    getRequestUrl(org.apache.camel.Exchange theExchange, String theProcedureName)
    Builds a string containing the received procedure name, including the module id if present in the exchange
    ITransactionLogCommonSettings
    getSettings()
    Returns the settings associated with this writer.
    boolean
    isTxLogShowBody(org.apache.camel.Exchange theExchange)
    Informs if 'showMsgBody' parameter is present
    boolean
    isTxLogStarted(org.apache.camel.Exchange theExchange)
    informs if a transaction log is active for the route
    void
    startTxLog(org.apache.camel.Exchange theExchange)
    Requests transaction log initiation for the route

  • Field Details

  • Method Details

    • addStepIfTxLogActive

      void addStepIfTxLogActive(org.apache.camel.Exchange theExchange, String theProcedureName)
      If transaction logging was initiated (smile:txLogStart procedure, present before current procedure in route), adds a log step to the transaction log
      Parameters:
      theExchange - the camel exchange
      theProcedureName - the log-producing procedure name

    • addStepIfTxLogActive

      void addStepIfTxLogActive(org.apache.camel.Exchange theExchange, ITxLogStepsProvider theStepsProvider)
      If transaction logging was initiated (smile:txLogStart procedure, present before current procedure in route), adds step from provider to the transaction log
      Parameters:
      theExchange - the camel exchange
      theStepsProvider - the provider of the corresponding transaction log steps

    • addStepIfTxLogActive

      void addStepIfTxLogActive(org.apache.camel.Exchange theExchange, List<TransactionLogStepJson> theLogSteps)
      If transaction logging was initiated (smile:txLogStart procedure, present before current procedure in route), adds step from provider to the transaction log, adds the list of steps to the transaction log
      Parameters:
      theExchange - the camel exchange
      theLogSteps - the log steps to be added to the transaction log

    • buildTxLogStep

      TransactionLogStepJson buildTxLogStep(org.apache.camel.Exchange theExchange, TransactionLogStepTypeEnum theLogStepType, org.apache.commons.lang3.tuple.Pair<String,TransactionLogBodyTypeEnum> theBodyAndType)
      Builds a new transaction log step from provided exchange properties and parameters. If theExchange.isFailed(), the step outcome is set to FAIL, otherwise SUCCESS.
      Parameters:
      theExchange - the camel exchange
      theLogStepType - the transaction log step type
      theBodyAndType - A Pair containing the body and the body type or null
      Returns:
      the built transaction log step

    • buildTxLogStep

      @Deprecated default TransactionLogStepJson buildTxLogStep(org.apache.camel.Exchange theExchange, TransactionLogStepTypeEnum theLogStepType, org.apache.commons.lang3.tuple.Pair<String,TransactionLogBodyTypeEnum> theBodyAndType, TransactionLogOutcomeEnum theOutcome)
      Deprecated.
      use buildTxLogStep(Exchange, TransactionLogStepTypeEnum, Pair) Builds a new transaction log step considering received exchange properties and parameters.
      Parameters:
      theExchange - the camel exchange
      theLogStepType - the transaction log step type
      theBodyAndType - A Pair containing the body and the body type or null
      theOutcome - Ignored.
      Returns:
      the built transaction log step

    • getRequestUrl

      String getRequestUrl(org.apache.camel.Exchange theExchange, String theProcedureName)
      Builds a string containing the received procedure name, including the module id if present in the exchange
      Parameters:
      theExchange - the camel exchange
      theProcedureName - the log-producing procedure name
      Returns:
      a string with the built executing procedure URI

    • isTxLogShowBody

      boolean isTxLogShowBody(org.apache.camel.Exchange theExchange)
      Informs if 'showMsgBody' parameter is present
      Parameters:
      theExchange - the camel exchange
      Returns:
      boolean indicating if 'showMsgBody' parameter is present

    • isTxLogStarted

      boolean isTxLogStarted(org.apache.camel.Exchange theExchange)
      informs if a transaction log is active for the route
      Parameters:
      theExchange - the camel exchange
      Returns:
      boolean indicating if transaction log is active for the route

    • startTxLog

      void startTxLog(org.apache.camel.Exchange theExchange)
      Requests transaction log initiation for the route
      Parameters:
      theExchange - the camel exchange

    • commitTxLog

      void commitTxLog(org.apache.camel.Exchange theExchange)
      Commits the transaction log to configured writers
      Parameters:
      theExchange - the camel exchange

    • clearTxLog

      void clearTxLog(org.apache.camel.Exchange theExchange)
      Discards current transaction logging and marks logging not initiated for the route
      Parameters:
      theExchange - the camel exchange

    • getSettings

      ITransactionLogCommonSettings getSettings()
      Returns the settings associated with this writer. Event sources can use this to optimize whether to include specific elements in their log entries.