LoggingHandler (Spring Integration API)

java.lang.ObjectSE
- org.springframework.integration.context.IntegrationObjectSupport
- - org.springframework.integration.handler.MessageHandlerSupport
  - - org.springframework.integration.handler.AbstractMessageHandler
    - - org.springframework.integration.handler.LoggingHandler

実装されたすべてのインターフェース:
org.reactivestreams.Subscriber<Message<?>>, Aware, BeanFactoryAware, BeanNameAware, DisposableBean, InitializingBean, ApplicationContextAware, Ordered, ExpressionCapable, Orderable, IntegrationPattern, NamedComponent, IntegrationManagement, TrackableComponent, MessageHandler, reactor.core.CoreSubscriber<Message<?>>
```
public class LoggingHandler
extends AbstractMessageHandler
```
'shouldLogFullMessage' または SpEL 'logExpression' プロパティの値に応じて、メッセージまたはそのペイロードをログに記録するだけの MessageHandler 実装。ペイロードをログに記録し、それが Throwable に割り当て可能な場合は、スタックトレースがログに記録されます。デフォルトでは、ペイロードのみがログに記録されます。
導入:
1.0.1
作成者:
Mark Fisher, Gary Russell, Artem Bilan, Andriy Kryvtsun

ネストされたクラスのサマリー
ネストされたクラス
修飾子と型クラスと説明
static class LoggingHandler.Level
- インターフェース org.springframework.integration.support.management.IntegrationManagement から継承されたネストクラス / インターフェース
  IntegrationManagement.ManagementOverrides

ネストされたクラス
修飾子と型	クラスと説明
`static class`	`LoggingHandler.Level`

フィールドのサマリー
- クラス org.springframework.integration.context.IntegrationObjectSupport から継承されたフィールド
  EXPRESSION_PARSER, logger
- インターフェース org.springframework.core.Ordered から継承されたフィールド
  HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE
- インターフェース org.springframework.integration.support.management.IntegrationManagement から継承されたフィールド
  METER_PREFIX, RECEIVE_COUNTER_NAME, SEND_TIMER_NAME

コンストラクターの概要

コンストラクター
コンストラクターと説明
`LoggingHandler(LoggingHandler.Level level)` 指定されたログ `LoggingHandler.Level` を使用して `LoggingHandler` を作成します。
`LoggingHandler(StringSE level)` 指定したログレベルで LoggingHandler を作成します（大文字と小文字は区別されません）。

メソッドのサマリー

すべてのメソッドインスタンスメソッド具象メソッド
修飾子と型	メソッドと説明
`StringSE`	`getComponentType()` サブクラスはこのメソッドを実装して、コンポーネント型情報を提供できます。
`LoggingHandler.Level`	`getLevel()`
`protected void`	`handleMessageInternal(Message<?> message)`
`protected void`	`onInit()` サブクラスは、初期化ロジック用にこれを実装できます。
`void`	`setLevel(LoggingHandler.Level level)` ロギング `LoggingHandler.Level` を設定して、実行時の動作を変更します。
`void`	`setLogExpression(Expression expression)` `Expression` を設定して、実行時にリクエスト `Message` に対してログエントリを評価します。
`void`	`setLogExpressionString(StringSE expressionString)` 使用する SpEL 式文字列を設定します。
`void`	`setLoggerName(StringSE loggerName)`
`void`	`setShouldLogFullMessage(boolean shouldLogFullMessage)` メッセージ全体をログに記録するかどうかを指定します。

クラス org.springframework.integration.handler.AbstractMessageHandler から継承されたメソッド
handleMessage, onComplete, onError, onNext, onSubscribe

クラス org.springframework.integration.handler.MessageHandlerSupport から継承されたメソッド
buildSendTimer, destroy, getIntegrationPatternType, getManagedName, getManagedType, getMetricsCaptor, getOrder, getOverrides, isLoggingEnabled, registerMetricsCaptor, sendTimer, setLoggingEnabled, setManagedName, setManagedType, setOrder, setShouldTrack, shouldTrack

クラス org.springframework.integration.context.IntegrationObjectSupport から継承されたメソッド
afterPropertiesSet, extractTypeIfPossible, generateId, getApplicationContext, getApplicationContextId, getBeanDescription, getBeanFactory, getBeanName, getChannelResolver, getComponentName, getConversionService, getExpression, getIntegrationProperties, getIntegrationProperty, getMessageBuilderFactory, getTaskScheduler, isInitialized, setApplicationContext, setBeanFactory, setBeanName, setChannelResolver, setComponentName, setConversionService, setMessageBuilderFactory, setPrimaryExpression, setTaskScheduler, toString

クラス java.lang.ObjectSE から継承されたメソッド
cloneSE, equalsSE, finalizeSE, getClassSE, hashCodeSE, notifySE, notifyAllSE, waitSE, waitSE, waitSE

インターフェース reactor.core.CoreSubscriber から継承されたメソッド
currentContext

インターフェース org.springframework.integration.support.management.IntegrationManagement から継承されたメソッド
getThisAs

インターフェース org.springframework.integration.support.context.NamedComponent から継承されたメソッド
getBeanName, getComponentName

- コンストラクターの詳細
  - LoggingHandler
```
public LoggingHandler(StringSE level)
```
    指定したログレベルで LoggingHandler を作成します（大文字と小文字は区別されません）。
    有効なレベルは: FATAL、ERROR、WARN、INFO、DEBUG、TRACE
    パラメーター:
    level - レベル。
    関連事項:
    LoggingHandler(Level)
  - LoggingHandler
```
public LoggingHandler(LoggingHandler.Level level)
```
    指定されたログ LoggingHandler.Level を使用して LoggingHandler を作成します。
    パラメーター:
    level - 使用する LoggingHandler.Level。
    導入:
    4.3
- メソッドの詳細
  - setLogExpressionString
```
public void setLogExpressionString(StringSE expressionString)
```
    使用する SpEL 式文字列を設定します。
    パラメーター:
    expressionString - 使用する SpEL 式文字列。
    導入:
    4.3
    関連事項:
    setLogExpression(Expression)
  - setLogExpression
```
public void setLogExpression(Expression expression)
```
    Expression を設定して、実行時にリクエスト Message に対してログエントリを評価します。
    パラメーター:
    expression - 使用する Expression。
    導入:
    4.3
    関連事項:
    setLogExpressionString(String)
  - getLevel
```
public LoggingHandler.Level getLevel()
```
    戻り値:
    現在のロギング LoggingHandler.Level。
  - setLevel
```
public void setLevel(LoggingHandler.Level level)
```
    ロギング LoggingHandler.Level を設定して、実行時の動作を変更します。
    パラメーター:
    level - レベル。
  - setLoggerName
```
public void setLoggerName(StringSE loggerName)
```
  - setShouldLogFullMessage
```
public void setShouldLogFullMessage(boolean shouldLogFullMessage)
```
    メッセージ全体をログに記録するかどうかを指定します。それ以外の場合は、ペイロードのみがログに記録されます。この値はデフォルトで false です。
    パラメーター:
    shouldLogFullMessage - 完全なメッセージをログに記録する必要がある場合は true。
  - getComponentType
```
public StringSE getComponentType()
```
    クラスからコピーされた説明: IntegrationObjectSupport
    サブクラスはこのメソッドを実装して、コンポーネント型情報を提供できます。
    次で指定:
    インターフェース NamedComponent の getComponentType
    オーバーライド:
    クラス MessageHandlerSupport の getComponentType
  - onInit
```
protected void onInit()
```
    クラスからコピーされた説明: IntegrationObjectSupport
    サブクラスは、初期化ロジック用にこれを実装できます。
    オーバーライド:
    クラス IntegrationObjectSupport の onInit
  - handleMessageInternal
```
protected void handleMessageInternal(Message<?> message)
```
    次で指定:
    クラス AbstractMessageHandler の handleMessageInternal

クラス LoggingHandler

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

インターフェース org.springframework.integration.support.management.IntegrationManagement から継承されたネストクラス / インターフェース

フィールドのサマリー

クラス org.springframework.integration.context.IntegrationObjectSupport から継承されたフィールド

インターフェース org.springframework.core.Ordered から継承されたフィールド

インターフェース org.springframework.integration.support.management.IntegrationManagement から継承されたフィールド

コンストラクターの概要

メソッドのサマリー

クラス org.springframework.integration.handler.AbstractMessageHandler から継承されたメソッド

クラス org.springframework.integration.handler.MessageHandlerSupport から継承されたメソッド

クラス org.springframework.integration.context.IntegrationObjectSupport から継承されたメソッド

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

インターフェース reactor.core.CoreSubscriber から継承されたメソッド

インターフェース org.springframework.integration.support.management.IntegrationManagement から継承されたメソッド

インターフェース org.springframework.integration.support.context.NamedComponent から継承されたメソッド

コンストラクターの詳細

LoggingHandler

LoggingHandler

メソッドの詳細

setLogExpressionString

setLogExpression

getLevel

setLevel

setLoggerName

setShouldLogFullMessage

getComponentType

onInit

handleMessageInternal