com.kdgregory.log4j.aws

Class SNSAppender

java.lang.Object

org.apache.log4j.AppenderSkeleton

com.kdgregory.log4j.aws.internal.shared.AbstractAppender<SNSWriterConfig,SNSAppenderStatistics,SNSAppenderStatisticsMXBean>

com.kdgregory.log4j.aws.SNSAppender

All Implemented Interfaces:

org.apache.log4j.Appender, org.apache.log4j.spi.OptionHandler

public class SNSAppender
extends AbstractAppender<SNSWriterConfig,SNSAppenderStatistics,SNSAppenderStatisticsMXBean>

Writes messages to Amazon's Simple Notification Service.

Field Summary

Fields inherited from class com.kdgregory.log4j.aws.internal.shared.AbstractAppender

appenderStats, batchDelay, clientEndpoint, clientFactory, discardAction, discardThreshold, lastRotationCount, lastRotationTimestamp, rotationInterval, rotationMode, sequence, threadFactory, writer, writerFactory

Fields inherited from class org.apache.log4j.AppenderSkeleton

errorHandler, headFilter, layout, name, tailFilter, threshold

Constructor Summary

Constructors

Constructor and Description
SNSAppender()

Method Summary

Modifier and Type	Method and Description
protected SNSWriterConfig	generateWriterConfig() Called just before a writer is created, so that the subclass can perform substitutions on the configuration.
boolean	getAutoCreate() Returns the auto-create flag.
String	getSubject() Returns the current subject value, as set.
String	getTopicArn() Returns the configured topic ARN, without substitutions applied.
String	getTopicName() Returns the configured topic name, without substitutions applied.
protected boolean	isMessageTooLarge(LogMessage message) Called AbstractAppender.append(org.apache.log4j.spi.LoggingEvent) to ensure that we don't have a single message that violates AWS batching rules.
void	setAutoCreate(boolean value) Sets the auto-create flag: if the topic is specified by name and does not already exist, the writer will attempt to create it.
void	setBatchDelay(long value) Any configured batch delay will be ignored; the appender attempts to send all messages as soon as they are appended.
void	setSubject(String value) Sets the subject that will be applied to messages; blank disables subjects.
void	setTopicArn(String value) Specifies the destination topic by ARN; the topic must already exist.
void	setTopicName(String value) Sets the topic name.

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

append, close, getAppenderStatistics, getBatchDelay, getClientEndpoint, getClientFactory, getDiscardAction, getDiscardThreshold, getRotationInterval, getRotationMode, getSequence, registerStatisticsBean, requiresLayout, rotate, setClientEndpoint, setClientFactory, setDiscardAction, setDiscardThreshold, setRotationInterval, setRotationMode, setSequence, unregisterStatisticsBean

Methods inherited from class org.apache.log4j.AppenderSkeleton

activateOptions, addFilter, clearFilters, doAppend, finalize, getErrorHandler, getFilter, getFirstFilter, getLayout, getName, getThreshold, isAsSevereAsThreshold, setErrorHandler, setLayout, setName, setThreshold

Methods inherited from class java.lang.Object

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

Constructor Detail

SNSAppender

public SNSAppender()

Method Detail

setTopicName

public void setTopicName(String value)

Sets the topic name. The list of existing topics will be searched for this name (picking one arbitrarily if there are topics with the same name in multiple regions). If no topic exists with the specified name one will be created.

Supports substitution values.

If you specify both topic name and topic ARN, the latter takes precedence. If no topic exists that matches the ARN, one will not be created.

getTopicName

public String getTopicName()

Returns the configured topic name, without substitutions applied. Returns null if the topic has been configured by ARN.

setTopicArn

public void setTopicArn(String value)

Specifies the destination topic by ARN; the topic must already exist.

Supports substitution values.

If you specify both topic name and topic ARN, the latter takes precedence.

getTopicArn

public String getTopicArn()

Returns the configured topic ARN, without substitutions applied. Returns null if the topic has been configured by name.

setBatchDelay

public void setBatchDelay(long value)

Any configured batch delay will be ignored; the appender attempts to send all messages as soon as they are appended.

Overrides:

setBatchDelay in class AbstractAppender<SNSWriterConfig,SNSAppenderStatistics,SNSAppenderStatisticsMXBean>

setSubject

public void setSubject(String value)

Sets the subject that will be applied to messages; blank disables subjects. At present this may only be configured at appender start.

getSubject

public String getSubject()

Returns the current subject value, as set.

setAutoCreate

public void setAutoCreate(boolean value)

Sets the auto-create flag: if the topic is specified by name and does not already exist, the writer will attempt to create it.

getAutoCreate

public boolean getAutoCreate()

Returns the auto-create flag.

generateWriterConfig

protected SNSWriterConfig generateWriterConfig()

Description copied from class: AbstractAppender

Called just before a writer is created, so that the subclass can perform substitutions on the configuration.

Specified by:

generateWriterConfig in class AbstractAppender<SNSWriterConfig,SNSAppenderStatistics,SNSAppenderStatisticsMXBean>

isMessageTooLarge

protected boolean isMessageTooLarge(LogMessage message)

Description copied from class: AbstractAppender

Called AbstractAppender.append(org.apache.log4j.spi.LoggingEvent) to ensure that we don't have a single message that violates AWS batching rules.

Specified by:

isMessageTooLarge in class AbstractAppender<SNSWriterConfig,SNSAppenderStatistics,SNSAppenderStatisticsMXBean>