Package com.inductiveautomation.ignition.gateway.storeforward.serialization.util

Class AuditSerializerHelper

java.lang.Object

com.inductiveautomation.ignition.gateway.storeforward.serialization.util.AuditSerializerHelper

public final class AuditSerializerHelper
extends Object

Method Summary

Modifier and Type	Method	Description
static AuditRecordProto.AuditRecordPB	fromAuditRecordToProto(PersistentAuditRecord auditRecord)	Converts a PersistentAuditRecord object to a AuditRecordProto.AuditRecordPB protocol buffer representation.
static AuditRecordProto.AuditRecordPB	fromAuditRecordToProto(PersistentAuditRecord auditRecord, String sourceSystem)	Converts a PersistentAuditRecord instance into a AuditRecordProto.AuditRecordPB protocol buffer object.
static PersistentAuditRecord	fromProtoToAuditRecord(AuditRecordProto.AuditRecordPB auditRecordPB)	Converts an AuditRecordProto.AuditRecordPB protocol buffer object into a PersistentAuditRecord object.

Methods inherited from class java.lang.Object

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

Method Details

fromAuditRecordToProto

public static AuditRecordProto.AuditRecordPB fromAuditRecordToProto(PersistentAuditRecord auditRecord)

Converts a PersistentAuditRecord object to a AuditRecordProto.AuditRecordPB protocol buffer representation.

Parameters:

auditRecord - the persistent audit record object to be converted; must not be null

Returns:

a protocol buffer representation of the given audit record

fromAuditRecordToProto

public static AuditRecordProto.AuditRecordPB fromAuditRecordToProto(PersistentAuditRecord auditRecord,
 @Nullable
 String sourceSystem)

Converts a PersistentAuditRecord instance into a AuditRecordProto.AuditRecordPB protocol buffer object.

Parameters:

auditRecord - the audit record to be converted; it contains the details of the audit-related event, such as the action performed, actor information, and context.

sourceSystem - an optional string that represents the source system; if provided, it will be prepended to the originating system of the audit record.

Returns:

the corresponding AuditRecordProto.AuditRecordPB protocol buffer object with the converted audit record details.

fromProtoToAuditRecord

public static PersistentAuditRecord fromProtoToAuditRecord(AuditRecordProto.AuditRecordPB auditRecordPB)

Converts an AuditRecordProto.AuditRecordPB protocol buffer object into a PersistentAuditRecord object.

Parameters:

auditRecordPB - the protocol buffer representation of an audit record to be converted.

Returns:

a PersistentAuditRecord object constructed from the given protocol buffer.