Package ca.cdr.api.transactionlog

Interface ITransactionLogStoringSvc

public interface ITransactionLogStoringSvc

This class is the ingestion point for all Transaction Logs generated in Smile CDR. This class is capable of routing all incoming Transaction Logs to every Module which implements a transaction log writer. If you are looking to create and store a Transaction Log, this is the class to use.

Method Summary

Modifier and Type	Method	Description
void	deleteEvent(Long theId)	Given an event, delete it by ID.
boolean	isEnabled()	Indicates whether Transaction Logging is enabled anywhere on the system, either in the cluster manager, or any modules which implement a transaction log writer.
default TransactionLogIdentifiers	persistNewLog(TransactionLogEventTypeEnum theType, TransactionLogEventSubTypeEnum theSubType, TransactionLogStepJson theInitialStep, String theTransactionId, String theModuleId)	Deprecated.
default TransactionLogIdentifiers	persistNewLog(TransactionLogEventTypeEnum theType, TransactionLogEventSubTypeEnum theSubType, TransactionLogStepJson theInitialStep, String theTransactionId, String theTransactionGuid, String theModuleId)	Deprecated.
default TransactionLogIdentifiers	persistNewLog(TransactionLogEventTypeEnum theType, TransactionLogEventSubTypeEnum theSubType, List<TransactionLogStepJson> theInitialSteps, String theTransactionId, String theModuleId)	Deprecated.
default TransactionLogIdentifiers	persistNewLog(TransactionLogEventTypeEnum theType, TransactionLogEventSubTypeEnum theSubType, List<TransactionLogStepJson> theInitialSteps, String theTransactionId, String theTransactionGuid, String theModuleId)	Deprecated.
TransactionLogIdentifiers	persistNewLog(IncomingTransactionLog theIncomingTransactionLog)	Creates a new Transaction Log.
void	persistNewStep(TransactionLogIdentifiers theTransactionPidMap, TransactionLogStepJson theStep)	This method adds new steps to existing parent Transaction Logs.
void	persistNewStep(String theTransactionGuid, TransactionLogStepJson theStep)	This is an alternative to persistNewStep(TransactionLogIdentifiers, TransactionLogStepJson).

Method Details

persistNewLog

TransactionLogIdentifiers persistNewLog(IncomingTransactionLog theIncomingTransactionLog)

Creates a new Transaction Log. This method will persist the transaction log to all modules which implement a transaction log writer.

Parameters:

theIncomingTransactionLog - parameter object encapsulating the properties required to persist a TransactionLogEventsJson.TransactionLogEventJson

Returns:

Returns a TransactionLogIdentifiers indicating the underlying PID of the transaction log, for each module that was able to persist the log and its initial steps.

persistNewLog

@Deprecated
default TransactionLogIdentifiers persistNewLog(TransactionLogEventTypeEnum theType,
 TransactionLogEventSubTypeEnum theSubType,
 List<TransactionLogStepJson> theInitialSteps,
 String theTransactionId,
 String theTransactionGuid,
 String theModuleId)

Deprecated.

persistNewLog

@Deprecated
default TransactionLogIdentifiers persistNewLog(TransactionLogEventTypeEnum theType,
 TransactionLogEventSubTypeEnum theSubType,
 TransactionLogStepJson theInitialStep,
 String theTransactionId,
 String theTransactionGuid,
 String theModuleId)

Deprecated.

persistNewLog

@Deprecated
default TransactionLogIdentifiers persistNewLog(TransactionLogEventTypeEnum theType,
 TransactionLogEventSubTypeEnum theSubType,
 List<TransactionLogStepJson> theInitialSteps,
 String theTransactionId,
 String theModuleId)

Deprecated.

persistNewLog

@Deprecated
default TransactionLogIdentifiers persistNewLog(TransactionLogEventTypeEnum theType,
 TransactionLogEventSubTypeEnum theSubType,
 TransactionLogStepJson theInitialStep,
 String theTransactionId,
 String theModuleId)

Deprecated.

persistNewStep

void persistNewStep(TransactionLogIdentifiers theTransactionPidMap,
 TransactionLogStepJson theStep)

This method adds new steps to existing parent Transaction Logs.

Parameters:

theTransactionPidMap - the TransactionLogIdentifiers entity containing the mappings of writer to pid.

theStep - the TransactionLogStepJson to add to this parent transaction log.

persistNewStep

void persistNewStep(String theTransactionGuid,
 TransactionLogStepJson theStep)

This is an alternative to persistNewStep(TransactionLogIdentifiers, TransactionLogStepJson). Since the GUID is manually set on create, it is guaranteed to be identical across all the possible TX Log writers, and as such we need no map for lookup. This will add a new step to the existing parent transcation log, identified by GUID.

Parameters:

theTransactionGuid - the GUID of the parent transaction log.

theStep - the TransactionLogStepJson to add to this parent transaction log.

deleteEvent

void deleteEvent(Long theId)

Given an event, delete it by ID.

Parameters:

theId - the ID of the event to delete.

isEnabled

boolean isEnabled()

Indicates whether Transaction Logging is enabled anywhere on the system, either in the cluster manager, or any modules which implement a transaction log writer.

Returns:

true if transaction logging is enabled anywhere on the system.