Package ca.cdr.api.util

Class TransactionLogRequestDetailsAccess

java.lang.Object

ca.cdr.api.util.TransactionLogRequestDetailsAccess

public class TransactionLogRequestDetailsAccess
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
static final String	REQUEST_SUBTYPE_KEY
static final String	STEPS_LIST_KEY

Constructor Summary

Constructors

Constructor	Description
TransactionLogRequestDetailsAccess()

Method Summary

Modifier and Type	Method	Description
static void	addAdditionalJsonProperty(RequestDetails theRequestDetails, String theKey, Object theObject)	Utility method to add key/value pairs to a transactionLog.
static void	addMessageToRequest(RequestDetails theDetails, MappingMessage theMessage)
static Map<String,Object>	getAdditionalJsonPropertiesMap(RequestDetails theRequestDetails)
static List<MappingMessage>	getMessagesOnRequest(RequestDetails theDetails)
static List<TransactionLogStepJson>	getTransactionLogStepsFromRequest(ServletRequestDetails theRequestDetails)

Methods inherited from class java.lang.Object

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

Field Details

STEPS_LIST_KEY

public static final String STEPS_LIST_KEY

REQUEST_SUBTYPE_KEY

public static final String REQUEST_SUBTYPE_KEY

Constructor Details

TransactionLogRequestDetailsAccess

public TransactionLogRequestDetailsAccess()

Method Details

addMessageToRequest

public static void addMessageToRequest(RequestDetails theDetails,
 MappingMessage theMessage)

getMessagesOnRequest

public static List<MappingMessage> getMessagesOnRequest(RequestDetails theDetails)

getTransactionLogStepsFromRequest

@Nullable
public static List<TransactionLogStepJson> getTransactionLogStepsFromRequest(ServletRequestDetails theRequestDetails)

addAdditionalJsonProperty

public static void addAdditionalJsonProperty(RequestDetails theRequestDetails,
 String theKey,
 Object theObject)

Utility method to add key/value pairs to a transactionLog. The provided value object needs to be serializable with Jackson since pairs are accumulated and subsequently formatted in an inline Json string. IllegalArgumentException is thrown if theObject is not Json serializable with Jackson or null.

Parameters:

theRequestDetails - The request details where the pairs will be stored

theKey - The key for referencing to theObject. Keys are transformed into json properties when serializing a pair.

theObject - The value needing storage. Values are transformed into json values when serializing a pair.

getAdditionalJsonPropertiesMap

public static Map<String,Object> getAdditionalJsonPropertiesMap(RequestDetails theRequestDetails)