Interface AuditTransmissionProtocol

All Known Implementing Classes:

AbstractFhirRestTLSAuditRecordSender, Apache5FhirRestTLSAuditRecordSender, MethanolFhirRestTLSAuditRecordSender, NettyTLSSyslogSenderImpl, NioTLSSyslogSenderImpl, ReactorNettyTLSSyslogSenderImpl, RecordingAuditMessageTransmission, TLSSyslogSenderImpl, UDPSyslogSenderImpl

public interface AuditTransmissionProtocol

Implementations of this interface transmit the serialized AuditMessage to an AuditRepository using IP protocols like TCP or UDP, usually wrapped into a carrier protocol (such as SYSLOG).

Since:

3.5

Author:

Christian Ohr

Method Summary

Modifier and Type	Method	Description
String	getTransportName()
default void	send(AuditContext auditContext, String auditMessage)	Transmits the message
void	send(AuditContext auditContext, AuditMetadataProvider auditMetadataProvider, String auditMessage)	Transmits the message
void	shutdown()	May be implemented to clean up instances on shut down

Method Details

send

default void send(AuditContext auditContext,
 String auditMessage)
           throws Exception

Transmits the message

Parameters:

auditContext - audit context that e.g. contains the destination

auditMessage - audit message

Throws:

Exception - thrown if sending the messages has failed

send

void send(AuditContext auditContext,
 AuditMetadataProvider auditMetadataProvider,
 String auditMessage)
   throws Exception

Transmits the message

Parameters:

auditContext - audit context that e.g. contains the destination

auditMetadataProvider - dedicated (message-specific) audit metadata

auditMessage - audit message strings

Throws:

Exception - thrown if sending the messages has failed

shutdown

void shutdown()

May be implemented to clean up instances on shut down

getTransportName

String getTransportName()

Returns:

name of the AuditTransmissionProtocol