Package org.openehealth.ipf.commons.audit.protocol

Interface AuditTransmissionProtocol

All Known Implementing Classes:

NettyTLSSyslogSenderImpl, NioTLSSyslogSenderImpl, ReactorNettyTLSSyslogSenderImpl, RecordingAuditMessageTransmission, TLSSyslogSenderImpl, UDPSyslogSenderImpl, VertxTLSSyslogSenderImpl, VertxUDPSyslogSenderImpl

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

Field Summary

Fields

Modifier and Type	Field	Description
static String	HTTPS_CIPHERSUITES
static String	JAVAX_NET_DEBUG
static String	JAVAX_NET_SSL_KEYSTORE
static String	JAVAX_NET_SSL_KEYSTORE_PASSWORD
static String	JAVAX_NET_SSL_KEYSTORE_TYPE
static String	JAVAX_NET_SSL_TRUSTSTORE
static String	JAVAX_NET_SSL_TRUSTSTORE_PASSWORD
static String	JAVAX_NET_SSL_TRUSTSTORE_TYPE
static String	JDK_TLS_CLIENT_PROTOCOLS

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

Field Detail

JAVAX_NET_DEBUG

static final String JAVAX_NET_DEBUG

See Also:

Constant Field Values

JAVAX_NET_SSL_TRUSTSTORE

static final String JAVAX_NET_SSL_TRUSTSTORE

See Also:

Constant Field Values

JAVAX_NET_SSL_TRUSTSTORE_TYPE

static final String JAVAX_NET_SSL_TRUSTSTORE_TYPE

See Also:

Constant Field Values

JAVAX_NET_SSL_TRUSTSTORE_PASSWORD

static final String JAVAX_NET_SSL_TRUSTSTORE_PASSWORD

See Also:

Constant Field Values

JAVAX_NET_SSL_KEYSTORE

static final String JAVAX_NET_SSL_KEYSTORE

See Also:

Constant Field Values

JAVAX_NET_SSL_KEYSTORE_TYPE

static final String JAVAX_NET_SSL_KEYSTORE_TYPE

See Also:

Constant Field Values

JAVAX_NET_SSL_KEYSTORE_PASSWORD

static final String JAVAX_NET_SSL_KEYSTORE_PASSWORD

See Also:

Constant Field Values

HTTPS_CIPHERSUITES

static final String HTTPS_CIPHERSUITES

See Also:

Constant Field Values

JDK_TLS_CLIENT_PROTOCOLS

static final String JDK_TLS_CLIENT_PROTOCOLS

See Also:

Constant Field Values

Method Detail

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