AbstractAppender (Logback Appenders 3.2.0 API)

java.lang.Object
- ch.qos.logback.core.spi.ContextAwareBase
- - ch.qos.logback.core.UnsynchronizedAppenderBase<LogbackEventType>
  - - com.kdgregory.logback.aws.internal.AbstractAppender<WriterConfigType,AppenderStatsType,AppenderStatsMXBeanType,LogbackEventType>

All Implemented Interfaces:

ch.qos.logback.core.Appender<LogbackEventType>, ch.qos.logback.core.spi.ContextAware, ch.qos.logback.core.spi.FilterAttachable<LogbackEventType>, ch.qos.logback.core.spi.LifeCycle

Direct Known Subclasses:

CloudWatchAppender, KinesisAppender, SNSAppender
```
public abstract class AbstractAppender<WriterConfigType extends AbstractWriterConfig<WriterConfigType>,AppenderStatsType extends AbstractWriterStatistics,AppenderStatsMXBeanType,LogbackEventType>
extends ch.qos.logback.core.UnsynchronizedAppenderBase<LogbackEventType>
```
Common implementation code that's shared between appenders.
For the most part, appenders have the same behavior: they initialize, transform log messages, and shut down. Most of the code to do that lives here, with a few hooks that are implemented in the appender proper.
Most of the member variables defined by this class are protected. This is intended to support testing. If you decide to subclass and access those variables, remember that this is an internal class: they may go away.
Note: this appender is built on UnsynchronizedAppenderBase, which is perhaps unnecessary (if you're worried about contention you shouldn't be doing a lot of logging). However, there are some critical sections within append(LogbackEventType), and these are protected by internal lock objects.

Field Summary

Fields
Modifier and Type	Field and Description
`protected WriterConfigType`	`appenderConfig`
`protected AppenderStatsType`	`appenderStats`
`protected InternalLogger`	`internalLogger`
`protected ch.qos.logback.core.Layout<LogbackEventType>`	`layout`
`protected ThreadFactory`	`threadFactory`
`protected LogWriter`	`writer`
`protected WriterFactory<WriterConfigType,AppenderStatsType>`	`writerFactory`

Fields inherited from class ch.qos.logback.core.UnsynchronizedAppenderBase
name, started

Fields inherited from class ch.qos.logback.core.spi.ContextAwareBase
context

Constructor Summary

Constructors
Constructor and Description
`AbstractAppender(WriterConfigType appenderConfig, ThreadFactory threadFactory, WriterFactory<WriterConfigType,AppenderStatsType> writerFactory, AppenderStatsType appenderStats, Class<AppenderStatsMXBeanType> appenderStatsMXBeanClass)`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`append(LogbackEventType event)`
`protected abstract WriterConfigType`	`generateWriterConfig()` Called as part of initialization.
`AppenderStatsType`	`getAppenderStatistics()` Returns the appender statistics object.
`String`	`getAssumedRole()` Returns the `assumedRole` configuration property.
`long`	`getBatchDelay()` Returns the `batchDelay` configuration property.
`String`	`getClientEndpoint()` Returns the `clientEndpoint` configuration property.
`String`	`getClientFactory()` Returns the `clientFactory` configuration property.
`String`	`getClientRegion()` Returns the `clientRegion` configuration property.
`String`	`getDiscardAction()` Returns the `discardAction` configuration property.
`int`	`getDiscardThreshold()` Returns the `discardThreshold` configuration property.
`boolean`	`getEnableBatchLogging()` Returns the `enableBatchLogging` configuration property.
`long`	`getInitializationTimeout()` Returns the `initializationTimeout` configuration property.
`boolean`	`getSynchronous()` Returns the `synchronous` configuration property.
`boolean`	`getTruncateOversizeMessages()` Returns the `truncateOversizeMessages` configuration property.
`boolean`	`getUseShutdownHook()` Returns the `useShutdownHook` configuration property.
`protected void`	`registerStatisticsBean()` Registers the appender statistics with JMX.
`void`	`setAssumedRole(String value)` Sets the `assumedRole` configuration property.
`void`	`setBatchDelay(long value)` Sets the `batchDelay` configuration property.
`void`	`setClientEndpoint(String value)` Sets the `clientEndpoint` configuration property.
`void`	`setClientFactory(String value)` Sets the `discardAction` configuration property.
`void`	`setClientRegion(String value)` Sets the `clientRegion` configuration property.
`void`	`setDiscardAction(String value)` Sets the `discardAction` configuration property.
`void`	`setDiscardThreshold(int value)` Sets the `discardThreshold` configuration property.
`void`	`setEnableBatchLogging(boolean value)` Sets the `enableBatchLogging` configuration property.
`void`	`setInitializationTimeout(long value)` Sets the `initializationTimeout` configuration property.
`void`	`setLayout(ch.qos.logback.core.Layout<LogbackEventType> layout)` Sets the layout manager for this appender.
`void`	`setName(String name)`
`void`	`setSynchronous(boolean value)` Sets the `synchronous` configuration property.
`void`	`setTruncateOversizeMessages(boolean value)` Sets the `truncateOversizeMessages` configuration property.
`void`	`setUseShutdownHook(boolean value)` Sets the `useShutdownHook` configuration property.
`void`	`start()`
`void`	`stop()`
`protected void`	`unregisterStatisticsBean()` Unregisters the appender statistics from JMX.

Methods inherited from class ch.qos.logback.core.UnsynchronizedAppenderBase
addFilter, clearAllFilters, doAppend, getCopyOfAttachedFiltersList, getFilterChainDecision, getName, isStarted, toString

Methods inherited from class ch.qos.logback.core.spi.ContextAwareBase
addError, addError, addInfo, addInfo, addStatus, addWarn, addWarn, getContext, getDeclaredOrigin, getStatusManager, setContext

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface ch.qos.logback.core.spi.ContextAware
addError, addError, addInfo, addInfo, addStatus, addWarn, addWarn, getContext, setContext

- Field Detail
  - threadFactory
```
protected ThreadFactory threadFactory
```
  - writerFactory
```
protected WriterFactory<WriterConfigType extends AbstractWriterConfig<WriterConfigType>,AppenderStatsType extends AbstractWriterStatistics> writerFactory
```
  - internalLogger
```
protected InternalLogger internalLogger
```
  - appenderStats
```
protected AppenderStatsType extends AbstractWriterStatistics appenderStats
```
  - writer
```
protected volatile LogWriter writer
```
  - layout
```
protected ch.qos.logback.core.Layout<LogbackEventType> layout
```
  - appenderConfig
```
protected WriterConfigType extends AbstractWriterConfig<WriterConfigType> appenderConfig
```
- Constructor Detail
  - AbstractAppender
```
public AbstractAppender(WriterConfigType appenderConfig,
                        ThreadFactory threadFactory,
                        WriterFactory<WriterConfigType,AppenderStatsType> writerFactory,
                        AppenderStatsType appenderStats,
                        Class<AppenderStatsMXBeanType> appenderStatsMXBeanClass)
```
- Method Detail
  - setName
```
public void setName(String name)
```
    Specified by:
    
    setName in interface ch.qos.logback.core.Appender<LogbackEventType>
    
    Overrides:
    
    setName in class ch.qos.logback.core.UnsynchronizedAppenderBase<LogbackEventType>
  - setLayout
```
public void setLayout(ch.qos.logback.core.Layout<LogbackEventType> layout)
```
    Sets the layout manager for this appender. Note that we do not use an Encoder; it is a knob that doesn't need to be turned.
  - setSynchronous
```
public void setSynchronous(boolean value)
```
    Sets the synchronous configuration property. This can only be done at the time of configuration, not once the appender is operating.
  - getSynchronous
```
public boolean getSynchronous()
```
    Returns the synchronous configuration property.
  - setBatchDelay
```
public void setBatchDelay(long value)
```
    Sets the batchDelay configuration property.
  - getBatchDelay
```
public long getBatchDelay()
```
    Returns the batchDelay configuration property.
  - setTruncateOversizeMessages
```
public void setTruncateOversizeMessages(boolean value)
```
    Sets the truncateOversizeMessages configuration property.
  - getTruncateOversizeMessages
```
public boolean getTruncateOversizeMessages()
```
    Returns the truncateOversizeMessages configuration property.
  - setDiscardThreshold
```
public void setDiscardThreshold(int value)
```
    Sets the discardThreshold configuration property.
  - getDiscardThreshold
```
public int getDiscardThreshold()
```
    Returns the discardThreshold configuration property.
  - setDiscardAction
```
public void setDiscardAction(String value)
```
    Sets the discardAction configuration property.
  - getDiscardAction
```
public String getDiscardAction()
```
    Returns the discardAction configuration property.
  - setAssumedRole
```
public void setAssumedRole(String value)
```
    Sets the assumedRole configuration property.
    Calling this method after the writer has been initialized will have no effect until the next log rotation.
  - getAssumedRole
```
public String getAssumedRole()
```
    Returns the assumedRole configuration property.
  - setClientFactory
```
public void setClientFactory(String value)
```
    Sets the discardAction configuration property.
    Calling this method after the writer has been initialized will have no effect until the next log rotation.
  - getClientFactory
```
public String getClientFactory()
```
    Returns the clientFactory configuration property.
  - setClientRegion
```
public void setClientRegion(String value)
```
    Sets the clientRegion configuration property.
  - getClientRegion
```
public String getClientRegion()
```
    Returns the clientRegion configuration property.
  - setClientEndpoint
```
public void setClientEndpoint(String value)
```
    Sets the clientEndpoint configuration property.
  - getClientEndpoint
```
public String getClientEndpoint()
```
    Returns the clientEndpoint configuration property.
  - setUseShutdownHook
```
public void setUseShutdownHook(boolean value)
```
    Sets the useShutdownHook configuration property.
  - getUseShutdownHook
```
public boolean getUseShutdownHook()
```
    Returns the useShutdownHook configuration property.
  - setInitializationTimeout
```
public void setInitializationTimeout(long value)
```
    Sets the initializationTimeout configuration property.
  - getInitializationTimeout
```
public long getInitializationTimeout()
```
    Returns the initializationTimeout configuration property.
  - setEnableBatchLogging
```
public void setEnableBatchLogging(boolean value)
```
    Sets the enableBatchLogging configuration property.
  - getEnableBatchLogging
```
public boolean getEnableBatchLogging()
```
    Returns the enableBatchLogging configuration property.
  - getAppenderStatistics
```
public AppenderStatsType getAppenderStatistics()
```
    Returns the appender statistics object.
  - start
```
public void start()
```
    Specified by:
    
    start in interface ch.qos.logback.core.spi.LifeCycle
    
    Overrides:
    
    start in class ch.qos.logback.core.UnsynchronizedAppenderBase<LogbackEventType>
  - stop
```
public void stop()
```
    Specified by:
    
    stop in interface ch.qos.logback.core.spi.LifeCycle
    
    Overrides:
    
    stop in class ch.qos.logback.core.UnsynchronizedAppenderBase<LogbackEventType>
  - append
```
protected void append(LogbackEventType event)
```
    Specified by:
    
    append in class ch.qos.logback.core.UnsynchronizedAppenderBase<LogbackEventType>
  - generateWriterConfig
```
protected abstract WriterConfigType generateWriterConfig()
```
    Called as part of initialization. Subclass should provide a config object that is populated with everything the subclass controls, and with all substitutions applied. The abstract class will populate with everything that it controls (eg, connection info).
  - registerStatisticsBean
```
protected void registerStatisticsBean()
```
    Registers the appender statistics with JMX. Logs but otherwise ignores failure.
    The name for the bean is consistent with the Log4J LayoutDynamicMBean, so that it will appear in the hierarchy under the appender.
    Note: this method is protected so that it can be avoided during unit tests.
  - unregisterStatisticsBean
```
protected void unregisterStatisticsBean()
```
    Unregisters the appender statistics from JMX. This is called when the appender is closed. Logs but otherwise ignores failure.
    Note: this method is protected so that it can be avoided during unit tests.

Class AbstractAppender<WriterConfigType extends AbstractWriterConfig<WriterConfigType>,AppenderStatsType extends AbstractWriterStatistics,AppenderStatsMXBeanType,LogbackEventType>

Field Summary

Fields inherited from class ch.qos.logback.core.UnsynchronizedAppenderBase

Fields inherited from class ch.qos.logback.core.spi.ContextAwareBase

Constructor Summary

Method Summary

Methods inherited from class ch.qos.logback.core.UnsynchronizedAppenderBase

Methods inherited from class ch.qos.logback.core.spi.ContextAwareBase

Methods inherited from class java.lang.Object

Methods inherited from interface ch.qos.logback.core.spi.ContextAware

Field Detail

threadFactory

writerFactory

internalLogger

appenderStats

writer

layout

appenderConfig

Constructor Detail

AbstractAppender

Method Detail

setName

setLayout

setSynchronous

getSynchronous

setBatchDelay

getBatchDelay

setTruncateOversizeMessages

getTruncateOversizeMessages

setDiscardThreshold

getDiscardThreshold

setDiscardAction

getDiscardAction

setAssumedRole

getAssumedRole

setClientFactory

getClientFactory

setClientRegion

getClientRegion

setClientEndpoint

getClientEndpoint

setUseShutdownHook

getUseShutdownHook

setInitializationTimeout

getInitializationTimeout

setEnableBatchLogging

getEnableBatchLogging

getAppenderStatistics

start

stop

append

generateWriterConfig

registerStatisticsBean

unregisterStatisticsBean