java.lang.ObjectSE
- ch.qos.logback.core.spi.ContextAwareBase
- - ch.qos.logback.core.AppenderBase<ch.qos.logback.classic.spi.ILoggingEvent>
  - - org.springframework.amqp.rabbit.logback.AmqpAppender

実装されたすべてのインターフェース:: ch.qos.logback.core.Appender<ch.qos.logback.classic.spi.ILoggingEvent>、ch.qos.logback.core.spi.ContextAware、ch.qos.logback.core.spi.FilterAttachable<ch.qos.logback.classic.spi.ILoggingEvent>、ch.qos.logback.core.spi.LifeCycle

public class AmqpAppender
extends ch.qos.logback.core.AppenderBase<ch.qos.logback.classic.spi.ILoggingEvent>

ロギングイベントを AMQP Exchange に発行する Logback アペンダー。

すべてのオプションがデフォルトに設定された、完全に構成された AmqpAppender は次のようになります。

 
 <appender name="AMQP" class="org.springframework.amqp.rabbit.logback.AmqpAppender">
     <layout>
        <pattern><![CDATA[ %d %p %t [%c] - <%m>%n ]]></pattern>
     </layout>
     <!-- <abbreviation>36</abbreviation --> <!-- no category abbreviation by default -->
     <applicationId>AmqpAppenderTest</applicationId>
     <routingKeyPattern>%property{applicationId}.%c.%p</routingKeyPattern>
     <generateId>true</generateId>
     <charset>UTF-8</charset>
     <durable>false</durable>
     <deliveryMode>NON_PERSISTENT</deliveryMode>
 </appender>

導入:: 1.4
作成者:: Artem Bilan, Gary Russell, Stephen Oakey, Dominique Villard, Nicolas Ristock, Eugene Gusev, Wayne Chu

ネストされたクラスのサマリー

ネストされたクラス
修飾子と型	クラス	説明
`protected static class`	`AmqpAppender.Event`	LoggingEvent、その MDC プロパティ、および再試行回数をカプセル化する小さなヘルパークラス。
`protected class`	`AmqpAppender.EventSender`	実際に LoggingEvents を非同期で送信するためのヘルパークラス。

フィールドサマリー

フィールド
修飾子と型	フィールド	説明
`static StringSE`	`APPLICATION_ID`	メッセージプロパティ内のアプリケーション ID のキー名 (appender 構成で設定されている場合)。
`static StringSE`	`CATEGORY_LEVEL`	メッセージプロパティのロガーレベル名のキー名
`static StringSE`	`CATEGORY_NAME`	メッセージプロパティのロガーカテゴリ名のキー名
`static StringSE`	`THREAD_NAME`	メッセージプロパティのスレッド名のキー名。

クラス ch.qos.logback.core.AppenderBase から継承されたフィールド
name, started

コンストラクターのサマリー
コンストラクター
コンストラクター説明
AmqpAppender()

メソッドのサマリー

すべてのメソッドインスタンスメソッド具象メソッド
修飾子と型	メソッド	説明
`protected void`	`append(ch.qos.logback.classic.spi.ILoggingEvent event)`
`protected void`	`configureRabbitConnectionFactory(RabbitConnectionFactoryBean factoryBean)`	`RabbitConnectionFactoryBean` を構成します。
`protected BlockingQueueSE<AmqpAppender.Event>`	`createEventQueue()`	サブクラスは、このメソッドをオーバーライドして、カスタムキューの実装を挿入できます。
`protected com.rabbitmq.client.ConnectionFactory`	`createRabbitConnectionFactory()`	`ConnectionFactory` を作成します。
`StringSE`	`getAddresses()`
`StringSE`	`getApplicationId()`
`StringSE`	`getCharset()`
`StringSE`	`getContentEncoding()`
`StringSE`	`getContentType()`
`StringSE`	`getDeliveryMode()`
`ch.qos.logback.core.encoder.Encoder<ch.qos.logback.classic.spi.ILoggingEvent>`	`getEncoder()`
`StringSE`	`getExchangeName()`
`StringSE`	`getExchangeType()`
`StringSE`	`getHost()`
`StringSE`	`getKeyStore()`
`StringSE`	`getKeyStorePassphrase()`
`StringSE`	`getKeyStoreType()`
`int`	`getMaxSenderRetries()`
`StringSE`	`getPassword()`
`IntegerSE`	`getPort()`
`int`	`getQueuedEventCount()`	送信待ちのイベント数を返します。
`StringSE`	`getRoutingKeyPattern()`
`StringSE`	`getSaslConfig()`
`int`	`getSenderPoolSize()`
`StringSE`	`getSslAlgorithm()`
`StringSE`	`getSslPropertiesLocation()`
`StringSE`	`getTrustStore()`
`StringSE`	`getTrustStorePassphrase()`
`StringSE`	`getTrustStoreType()`
`URISE`	`getUri()`
`StringSE`	`getUsername()`
`StringSE`	`getVirtualHost()`
`boolean`	`isAddMdcAsHeaders()`
`boolean`	`isAutoDelete()`
`boolean`	`isDeclareExchange()`
`boolean`	`isDurable()`
`boolean`	`isGenerateId()`
`boolean`	`isIncludeCallerData()`
`boolean`	`isUseSsl()`
`boolean`	`isVerifyHostname()`	TLS ホスト名の検証が有効になっている場合は、true (デフォルト) を返します。
`protected Message`	`postProcessMessageBeforeSend(Message message, AmqpAppender.Event event)`	サブクラスは、送信前に最終メッセージを変更できます。
`protected MessageProperties`	`prepareMessageProperties(AmqpAppender.Event event)`
`void`	`setAbbreviation(int len)`
`void`	`setAddMdcAsHeaders(boolean addMdcAsHeaders)`
`void`	`setAddresses(StringSE addresses)`
`void`	`setApplicationId(StringSE applicationId)`
`void`	`setAutoDelete(boolean autoDelete)`
`void`	`setCharset(StringSE charset)`
`void`	`setClientConnectionProperties(StringSE clientConnectionProperties)`	`key:value[,key:value]...` の形式で、rabbit 接続に追加する追加のクライアント接続プロパティを設定します。
`void`	`setConnectionName(StringSE connectionName)`	RabbitMQ 管理 UI に表示される接続の名前を設定します。
`void`	`setContentEncoding(StringSE contentEncoding)`
`void`	`setContentType(StringSE contentType)`
`void`	`setDeclareExchange(boolean declareExchange)`
`void`	`setDeliveryMode(StringSE deliveryMode)`
`void`	`setDurable(boolean durable)`
`void`	`setEncoder(ch.qos.logback.core.encoder.Encoder<ch.qos.logback.classic.spi.ILoggingEvent> encoder)`
`void`	`setExchangeName(StringSE exchangeName)`
`void`	`setExchangeType(StringSE exchangeType)`
`void`	`setGenerateId(boolean generateId)`
`void`	`setHost(StringSE host)`
`void`	`setIncludeCallerData(boolean includeCallerData)`	true の場合、発信者データはターゲット AMQP メッセージで使用できます。
`void`	`setKeyStore(StringSE keyStore)`
`void`	`setKeyStorePassphrase(StringSE keyStorePassphrase)`
`void`	`setKeyStoreType(StringSE keyStoreType)`
`void`	`setLayout(ch.qos.logback.core.Layout<ch.qos.logback.classic.spi.ILoggingEvent> layout)`
`void`	`setMaxSenderRetries(int maxSenderRetries)`
`void`	`setPassword(StringSE password)`
`void`	`setPort(IntegerSE port)`
`void`	`setRoutingKeyPattern(StringSE routingKeyPattern)`
`void`	`setSaslConfig(StringSE saslConfig)`	`SaslConfig` を設定します。
`void`	`setSenderPoolSize(int senderPoolSize)`
`void`	`setSslAlgorithm(StringSE sslAlgorithm)`
`void`	`setSslPropertiesLocation(StringSE sslPropertiesLocation)`
`void`	`setTrustStore(StringSE trustStore)`
`void`	`setTrustStorePassphrase(StringSE trustStorePassphrase)`
`void`	`setTrustStoreType(StringSE trustStoreType)`
`protected void`	`setUpExchangeDeclaration()`
`void`	`setUri(URISE uri)`
`void`	`setUsername(StringSE username)`
`void`	`setUseSsl(boolean ssl)`
`void`	`setVerifyHostname(boolean enable)`	TLS 接続のサーバーホスト名検証を有効にします。
`void`	`setVirtualHost(StringSE virtualHost)`
`void`	`start()`
`void`	`stop()`
`protected void`	`updateConnectionClientProperties(MapSE<StringSE,ObjectSE> clientProperties)`	サブクラスは、このメソッドをオーバーライドして、プロパティを接続クライアントプロパティに追加できます。

クラス ch.qos.logback.core.AppenderBase から継承されたメソッド
addFilter, clearAllFilters, doAppend, getCopyOfAttachedFiltersList, getFilterChainDecision, getName, isStarted, setName, toString

クラス ch.qos.logback.core.spi.ContextAwareBase から継承されたメソッド
addError, addError, addInfo, addInfo, addStatus, addWarn, addWarn, getContext, getDeclaredOrigin, getStatusManager, setContext

クラス java.lang.ObjectSE から継承されたメソッド
clone, equalsSE, finalize, getClass, hashCode, notify, notifyAll, wait, waitSE, waitSE

インターフェース ch.qos.logback.core.spi.ContextAware から継承されたメソッド
addError, addError, addInfo, addInfo, addStatus, addWarn, addWarn, getContext, setContext

- フィールドの詳細
  - APPLICATION_ID
```
public static final StringSE APPLICATION_ID
```
    メッセージプロパティ内のアプリケーション ID のキー名 (appender 構成で設定されている場合)。
    関連事項:
    定数フィールド値
  - CATEGORY_NAME
```
public static final StringSE CATEGORY_NAME
```
    メッセージプロパティのロガーカテゴリ名のキー名
    関連事項:
    定数フィールド値
  - CATEGORY_LEVEL
```
public static final StringSE CATEGORY_LEVEL
```
    メッセージプロパティのロガーレベル名のキー名
    関連事項:
    定数フィールド値
  - THREAD_NAME
```
public static final StringSE THREAD_NAME
```
    メッセージプロパティのスレッド名のキー名。
    関連事項:
    定数フィールド値
- コンストラクターの詳細
  - AmqpAppender
```
public AmqpAppender()
```
- メソッドの詳細
  - setRoutingKeyPattern
```
public void setRoutingKeyPattern(StringSE routingKeyPattern)
```
  - getUri
```
public URISE getUri()
```
  - setUri
```
public void setUri(URISE uri)
```
  - getHost
```
public StringSE getHost()
```
  - setHost
```
public void setHost(StringSE host)
```
  - getPort
```
public IntegerSE getPort()
```
  - setPort
```
public void setPort(IntegerSE port)
```
  - setAddresses
```
public void setAddresses(StringSE addresses)
```
  - getAddresses
```
public StringSE getAddresses()
```
  - getVirtualHost
```
public StringSE getVirtualHost()
```
  - setVirtualHost
```
public void setVirtualHost(StringSE virtualHost)
```
  - getUsername
```
public StringSE getUsername()
```
  - setUsername
```
public void setUsername(StringSE username)
```
  - getPassword
```
public StringSE getPassword()
```
  - setPassword
```
public void setPassword(StringSE password)
```
  - isUseSsl
```
public boolean isUseSsl()
```
  - setUseSsl
```
public void setUseSsl(boolean ssl)
```
  - setVerifyHostname
```
public void setVerifyHostname(boolean enable)
```
    TLS 接続のサーバーホスト名検証を有効にします。
    パラメーター:
    enable - 無効にする場合は false。
    導入:
    2.1.6
    関連事項:
    RabbitConnectionFactoryBean.setEnableHostnameVerification(boolean)
  - isVerifyHostname
```
public boolean isVerifyHostname()
```
    TLS ホスト名の検証が有効になっている場合は、true (デフォルト) を返します。
    戻り値:
    TLS ホスト名検証が有効な場合は true (デフォルト)。
    導入:
    2.1.6
  - getSslAlgorithm
```
public StringSE getSslAlgorithm()
```
  - setSslAlgorithm
```
public void setSslAlgorithm(StringSE sslAlgorithm)
```
  - getSslPropertiesLocation
```
public StringSE getSslPropertiesLocation()
```
  - setSslPropertiesLocation
```
public void setSslPropertiesLocation(StringSE sslPropertiesLocation)
```
  - getKeyStore
```
public StringSE getKeyStore()
```
  - setKeyStore
```
public void setKeyStore(StringSE keyStore)
```
  - getKeyStorePassphrase
```
public StringSE getKeyStorePassphrase()
```
  - setKeyStorePassphrase
```
public void setKeyStorePassphrase(StringSE keyStorePassphrase)
```
  - getKeyStoreType
```
public StringSE getKeyStoreType()
```
  - setKeyStoreType
```
public void setKeyStoreType(StringSE keyStoreType)
```
  - getTrustStore
```
public StringSE getTrustStore()
```
  - setTrustStore
```
public void setTrustStore(StringSE trustStore)
```
  - getTrustStorePassphrase
```
public StringSE getTrustStorePassphrase()
```
  - setTrustStorePassphrase
```
public void setTrustStorePassphrase(StringSE trustStorePassphrase)
```
  - getTrustStoreType
```
public StringSE getTrustStoreType()
```
  - setTrustStoreType
```
public void setTrustStoreType(StringSE trustStoreType)
```
  - getSaslConfig
```
public StringSE getSaslConfig()
```
  - setSaslConfig
```
public void setSaslConfig(StringSE saslConfig)
```
    SaslConfig を設定します。
    パラメーター:
    saslConfig - 設定する saslConfig
    導入:
    1.7.14
    関連事項:
    RabbitUtils.stringToSaslConfig(String, ConnectionFactory)
  - getExchangeName
```
public StringSE getExchangeName()
```
  - setExchangeName
```
public void setExchangeName(StringSE exchangeName)
```
  - getExchangeType
```
public StringSE getExchangeType()
```
  - setExchangeType
```
public void setExchangeType(StringSE exchangeType)
```
  - getRoutingKeyPattern
```
public StringSE getRoutingKeyPattern()
```
  - isDeclareExchange
```
public boolean isDeclareExchange()
```
  - setDeclareExchange
```
public void setDeclareExchange(boolean declareExchange)
```
  - getContentType
```
public StringSE getContentType()
```
  - setContentType
```
public void setContentType(StringSE contentType)
```
  - getContentEncoding
```
public StringSE getContentEncoding()
```
  - setContentEncoding
```
public void setContentEncoding(StringSE contentEncoding)
```
  - getApplicationId
```
public StringSE getApplicationId()
```
  - setApplicationId
```
public void setApplicationId(StringSE applicationId)
```
  - getSenderPoolSize
```
public int getSenderPoolSize()
```
  - setSenderPoolSize
```
public void setSenderPoolSize(int senderPoolSize)
```
  - getMaxSenderRetries
```
public int getMaxSenderRetries()
```
  - setMaxSenderRetries
```
public void setMaxSenderRetries(int maxSenderRetries)
```
  - isAddMdcAsHeaders
```
public boolean isAddMdcAsHeaders()
```
  - setAddMdcAsHeaders
```
public void setAddMdcAsHeaders(boolean addMdcAsHeaders)
```
  - isDurable
```
public boolean isDurable()
```
  - setDurable
```
public void setDurable(boolean durable)
```
  - getDeliveryMode
```
public StringSE getDeliveryMode()
```
  - setDeliveryMode
```
public void setDeliveryMode(StringSE deliveryMode)
```
  - isAutoDelete
```
public boolean isAutoDelete()
```
  - setAutoDelete
```
public void setAutoDelete(boolean autoDelete)
```
  - isGenerateId
```
public boolean isGenerateId()
```
  - setGenerateId
```
public void setGenerateId(boolean generateId)
```
  - getCharset
```
public StringSE getCharset()
```
  - setCharset
```
public void setCharset(StringSE charset)
```
  - setLayout
```
public void setLayout(ch.qos.logback.core.Layout<ch.qos.logback.classic.spi.ILoggingEvent> layout)
```
  - getEncoder
```
public ch.qos.logback.core.encoder.Encoder<ch.qos.logback.classic.spi.ILoggingEvent> getEncoder()
```
  - setEncoder
```
public void setEncoder(ch.qos.logback.core.encoder.Encoder<ch.qos.logback.classic.spi.ILoggingEvent> encoder)
```
  - setAbbreviation
```
public void setAbbreviation(int len)
```
  - getQueuedEventCount
```
public int getQueuedEventCount()
```
    送信待ちのイベント数を返します。
    戻り値:
    送信待ちのイベント数。
  - setConnectionName
```
public void setConnectionName(StringSE connectionName)
```
    RabbitMQ 管理 UI に表示される接続の名前を設定します。
    パラメーター:
    connectionName - 接続名。
    導入:
    2.1.1
  - setClientConnectionProperties
```
public void setClientConnectionProperties(StringSE clientConnectionProperties)
```
    key:value[,key:value]... の形式で、rabbit 接続に追加する追加のクライアント接続プロパティを設定します。
    パラメーター:
    clientConnectionProperties - プロパティ。
    導入:
    1.5.6
  - isIncludeCallerData
```
public boolean isIncludeCallerData()
```
  - setIncludeCallerData
```
public void setIncludeCallerData(boolean includeCallerData)
```
    true の場合、発信者データはターゲット AMQP メッセージで使用できます。デフォルトでは、発信者データは RabbitMQ に送信されません。
    パラメーター:
    includeCallerData - 呼び出し元データを含めるまたはオンにする
    導入:
    1.7.1
    関連事項:
    ILoggingEvent.getCallerData()
  - start
```
public void start()
```
    次で指定:
    インターフェース ch.qos.logback.core.spi.LifeCycle の start
    オーバーライド:
    クラス ch.qos.logback.core.AppenderBase<ch.qos.logback.classic.spi.ILoggingEvent> の start
  - createRabbitConnectionFactory
```
protected com.rabbitmq.client.ConnectionFactory createRabbitConnectionFactory()
```
    ConnectionFactory を作成します。
    戻り値:
    ConnectionFactory。
  - configureRabbitConnectionFactory
```
protected void configureRabbitConnectionFactory(RabbitConnectionFactoryBean factoryBean)
```
    RabbitConnectionFactoryBean を構成します。サブクラスは、Bean の構成をカスタマイズするためにオーバーライドできます。
    パラメーター:
    factoryBean - RabbitConnectionFactoryBean
  - updateConnectionClientProperties
```
protected void updateConnectionClientProperties(MapSE<StringSE,ObjectSE> clientProperties)
```
    サブクラスは、このメソッドをオーバーライドして、プロパティを接続クライアントプロパティに追加できます。
    パラメーター:
    clientProperties - クライアントプロパティ。
    導入:
    1.5.6
  - createEventQueue
```
protected BlockingQueueSE<AmqpAppender.Event> createEventQueue()
```
    サブクラスは、このメソッドをオーバーライドして、カスタムキューの実装を挿入できます。
    戻り値:
    ログ記録イベントを処理する前にキューに入れるために使用するキュー。
    導入:
    2.0.1
  - stop
```
public void stop()
```
    次で指定:
    インターフェース ch.qos.logback.core.spi.LifeCycle の stop
    オーバーライド:
    クラス ch.qos.logback.core.AppenderBase<ch.qos.logback.classic.spi.ILoggingEvent> の stop
  - append
```
protected void append(ch.qos.logback.classic.spi.ILoggingEvent event)
```
    次で指定:
    クラス ch.qos.logback.core.AppenderBase<ch.qos.logback.classic.spi.ILoggingEvent> の append
  - setUpExchangeDeclaration
```
protected void setUpExchangeDeclaration()
```
  - prepareMessageProperties
```
protected MessageProperties prepareMessageProperties(AmqpAppender.Event event)
```
  - postProcessMessageBeforeSend
```
protected Message postProcessMessageBeforeSend(Message message,
                                               AmqpAppender.Event event)
```
    サブクラスは、送信前に最終メッセージを変更できます。
    パラメーター:
    message - メッセージ。
    event - 行事。
    戻り値:
    変更されたメッセージ。
    導入:
    1.4

クラス AmqpAppender

ネストされたクラスのサマリー

フィールドサマリー

クラス ch.qos.logback.core.AppenderBase から継承されたフィールド

コンストラクターのサマリー

メソッドのサマリー

クラス ch.qos.logback.core.AppenderBase から継承されたメソッド

クラス ch.qos.logback.core.spi.ContextAwareBase から継承されたメソッド

クラス java.lang.ObjectSE から継承されたメソッド

インターフェース ch.qos.logback.core.spi.ContextAware から継承されたメソッド

フィールドの詳細

APPLICATION_ID

CATEGORY_NAME

CATEGORY_LEVEL

THREAD_NAME

コンストラクターの詳細

AmqpAppender

メソッドの詳細

setRoutingKeyPattern

getUri

setUri

getHost

setHost

getPort

setPort

setAddresses

getAddresses

getVirtualHost

setVirtualHost

getUsername

setUsername

getPassword

setPassword

isUseSsl

setUseSsl

setVerifyHostname

isVerifyHostname

getSslAlgorithm

setSslAlgorithm

getSslPropertiesLocation

setSslPropertiesLocation

getKeyStore

setKeyStore

getKeyStorePassphrase

setKeyStorePassphrase

getKeyStoreType

setKeyStoreType

getTrustStore

setTrustStore

getTrustStorePassphrase

setTrustStorePassphrase

getTrustStoreType

setTrustStoreType

getSaslConfig

setSaslConfig

getExchangeName

setExchangeName

getExchangeType

setExchangeType

getRoutingKeyPattern

isDeclareExchange

setDeclareExchange

getContentType

setContentType

getContentEncoding

setContentEncoding

getApplicationId

setApplicationId

getSenderPoolSize

setSenderPoolSize

getMaxSenderRetries

setMaxSenderRetries

isAddMdcAsHeaders

setAddMdcAsHeaders

isDurable

setDurable

getDeliveryMode

setDeliveryMode

isAutoDelete

setAutoDelete