com.kdgregory.log4j.aws.internal.sns

Class SNSLogWriter

java.lang.Object

com.kdgregory.log4j.aws.internal.shared.AbstractLogWriter

com.kdgregory.log4j.aws.internal.sns.SNSLogWriter

All Implemented Interfaces:

LogWriter, Runnable

public class SNSLogWriter
extends AbstractLogWriter

Field Summary

Fields

Modifier and Type	Field and Description
protected com.amazonaws.services.sns.AmazonSNS	client
protected SNSWriterConfig	config
protected String	topicArn

Constructor Summary

Constructors

Constructor and Description
SNSLogWriter(SNSWriterConfig config, SNSAppenderStatistics stats)

Method Summary

Modifier and Type	Method and Description
protected void	createAWSClient() Creates the appropriate AWS client.
protected int	effectiveSize(LogMessage message) Calculates the effective size of the message.
protected boolean	ensureDestinationAvailable() Verifies that the logging destination is available, including creating it if not.
protected List<LogMessage>	processBatch(List<LogMessage> currentBatch) Processes a batch of messages.
protected boolean	withinServiceLimits(int batchBytes, int numMessages) Determines whether the provided batch size or number of messages would exceed the service's limits.

Methods inherited from class com.kdgregory.log4j.aws.internal.shared.AbstractLogWriter

addMessage, buildBatch, getBatchCount, getBatchDelay, getClientFactoryUsed, initializationFailure, isInitializationComplete, run, setBatchDelay, setDiscardAction, setDiscardThreshold, stop, tryClientFactory, tryConfigureEndpointOrRegion

Methods inherited from class java.lang.Object

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

Field Detail

config

protected SNSWriterConfig config

client

protected com.amazonaws.services.sns.AmazonSNS client

topicArn

protected String topicArn

Constructor Detail

SNSLogWriter

public SNSLogWriter(SNSWriterConfig config,
                    SNSAppenderStatistics stats)

Method Detail

createAWSClient

protected void createAWSClient()

Description copied from class: AbstractLogWriter

Creates the appropriate AWS client. This is called as the first thing in the run() method (because, for some reason calling it in the ctor was failing).

Specified by:

createAWSClient in class AbstractLogWriter

ensureDestinationAvailable

protected boolean ensureDestinationAvailable()

Description copied from class: AbstractLogWriter

Verifies that the logging destination is available, including creating it if not. Return true if successful, false if not (which will cause the appender to stop running).

Specified by:

ensureDestinationAvailable in class AbstractLogWriter

processBatch

protected List<LogMessage> processBatch(List<LogMessage> currentBatch)

Description copied from class: AbstractLogWriter

Processes a batch of messages. The subclass is responsible for returning any messages that weren't sent, in order, so that they can be requeued.

Specified by:

processBatch in class AbstractLogWriter

effectiveSize

protected int effectiveSize(LogMessage message)

Description copied from class: AbstractLogWriter

Calculates the effective size of the message. This includes the message bytes plus any overhead.

Specified by:

effectiveSize in class AbstractLogWriter

withinServiceLimits

protected boolean withinServiceLimits(int batchBytes,
                                      int numMessages)

Description copied from class: AbstractLogWriter

Determines whether the provided batch size or number of messages would exceed the service's limits.

Specified by:

withinServiceLimits in class AbstractLogWriter