クラス FileWritingMessageHandler
java.lang.ObjectSE
org.springframework.integration.context.IntegrationObjectSupport
org.springframework.integration.handler.MessageHandlerSupport
org.springframework.integration.handler.AbstractMessageHandler
org.springframework.integration.handler.AbstractMessageProducingHandler
org.springframework.integration.handler.AbstractReplyProducingMessageHandler
org.springframework.integration.file.outbound.FileWritingMessageHandler
org.springframework.integration.file.FileWritingMessageHandler
- 実装されているすべてのインターフェース:
org.reactivestreams.Subscriber<Message<?>>、Aware、BeanClassLoaderAware、BeanFactoryAware、BeanNameAware、DisposableBean、InitializingBean、ApplicationContextAware、Lifecycle、Ordered、ComponentSourceAware、ExpressionCapable、Orderable、MessageProducer、HeaderPropagationAware、MessageTriggerAction、IntegrationPattern、NamedComponent、IntegrationManagement、ManageableLifecycle、TrackableComponent、MessageHandler、reactor.core.CoreSubscriber<Message<?>>
@DeprecatedSE(forRemoval=true,
since="7.0")
public class FileWritingMessageHandler
extends FileWritingMessageHandler
非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
メッセージペイロードをファイルに書き込む
MessageHandler 実装。ペイロードが File オブジェクトの場合、指定された宛先ディレクトリにファイルをコピーします。ペイロードがバイト配列、文字列、InputStream の場合、直接書き込まれます。それ以外の場合、ペイロード型はサポートされず、例外がスローされます。 各書き込みの後に改行を追加するには、appendNewLine フラグを "true" に設定します。デフォルトでは "false" です。
'deleteSourceFiles' フラグが true に設定されている場合、元のファイルは削除されます。このフラグのデフォルト値は false です。詳細については、FileWritingMessageHandler.setDeleteSourceFiles(boolean) メソッドの javadoc を参照してください。
このハンドラーの前に他のトランスフォーマーが役立つ場合があります。例: Serializable オブジェクトのペイロードは、PayloadSerializingTransformer によってバイト配列に変換できます。同様に、ObjectToStringTransformer は、toString() メソッドに基づいて任意のオブジェクトを文字列に変換できます。
FileExistsMode.APPEND は既存のファイルにコンテンツを追加します。ファイルは書き込みごとに閉じられます。FileExistsMode.APPEND_NO_FLUSH は既存のファイルにコンテンツを追加し、データをフラッシュせずにファイルを開いたままにします。データは、flushInterval に基づいて、またはメッセージが FileWritingMessageHandler.trigger(Message) メソッドに送信されたとき、または flushIfNeeded メソッドが呼び出されたときにフラッシュされます。
- 作成者:
- Mark Fisher, Iwein Fuld, Alex Peters, Oleg Zhurakousky, Artem Bilan, Gunnar Hillert, Gary Russell, Tony Falabella, Alen Turkovic, Trung Pham, Christian Tzolov, Ngoc Nhan
ネストされたクラスの要約
クラス org.springframework.integration.file.outbound.FileWritingMessageHandler から継承されたネストクラス / インターフェース
FileWritingMessageHandler.FlushPredicate, FileWritingMessageHandler.MessageFlushPredicateクラス org.springframework.integration.handler.AbstractReplyProducingMessageHandler から継承されたネストクラス / インターフェース
AbstractReplyProducingMessageHandler.RequestHandlerインターフェース org.springframework.integration.support.management.IntegrationManagement から継承されたネストクラス / インターフェース
IntegrationManagement.ManagementOverridesフィールドのサマリー
クラス org.springframework.integration.handler.AbstractMessageProducingHandler から継承されたフィールド
messagingTemplateクラス org.springframework.integration.context.IntegrationObjectSupport から継承されたフィールド
EXPRESSION_PARSER, loggerインターフェース org.springframework.integration.support.management.IntegrationManagement から継承されたフィールド
METER_PREFIX, RECEIVE_COUNTER_NAME, SEND_TIMER_NAMEインターフェース org.springframework.core.Ordered から継承されたフィールド
HIGHEST_PRECEDENCE, LOWEST_PRECEDENCEコンストラクターの概要
コンストラクターコンストラクター説明FileWritingMessageHandler(FileSE destinationDirectory) 非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。対象ファイルを保存するディレクトリを設定するコンストラクター。FileWritingMessageHandler(Expression destinationDirectoryExpression) 非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。ターゲットファイルを保存する SpEL ディレクトリを設定するコンストラクター。方法の概要
クラス org.springframework.integration.file.outbound.FileWritingMessageHandler から継承されたメソッド
createOutputStream, createWriter, doInit, flushIfNeeded, flushIfNeeded, getComponentType, getIntegrationPatternType, getTemporaryFileSuffix, handleRequestMessage, isRunning, setAppendNewLine, setAutoCreateDirectory, setBufferSize, setCharset, setChmod, setChmodOctal, setDeleteSourceFiles, setExpectReply, setFileExistsMode, setFileNameGenerator, setFlushInterval, setFlushPredicate, setFlushWhenIdle, setNewFileCallback, setPermissions, setPreserveTimestamp, setTemporaryFileSuffix, start, stop, triggerクラス org.springframework.integration.handler.AbstractReplyProducingMessageHandler から継承されたメソッド
doInvokeAdvisedRequestHandler, getBeanClassLoader, getRequiresReply, handleMessageInternal, hasAdviceChain, onInit, setAdviceChain, setBeanClassLoader, setRequiresReplyクラス org.springframework.integration.handler.AbstractMessageProducingHandler から継承されたメソッド
addNotPropagatedHeaders, createOutputMessage, getNotPropagatedHeaders, getOutputChannel, isAsync, messageBuilderForReply, produceOutput, resolveErrorChannel, sendErrorMessage, sendOutput, sendOutputs, setAsync, setNotPropagatedHeaders, setOutputChannel, setOutputChannelName, setSendTimeout, setupMessageProcessor, shouldCopyRequestHeaders, shouldSplitOutput, updateNotPropagatedHeadersクラス org.springframework.integration.handler.AbstractMessageHandler から継承されたメソッド
handleMessage, onComplete, onError, onNext, onSubscribe, setObservationConventionクラス org.springframework.integration.handler.MessageHandlerSupport から継承されたメソッド
buildSendTimer, destroy, getManagedName, getManagedType, getMetricsCaptor, getObservationRegistry, getOrder, getOverrides, isLoggingEnabled, isObserved, registerMetricsCaptor, registerObservationRegistry, sendTimer, setLoggingEnabled, setManagedName, setManagedType, setOrder, setShouldTrack, shouldTrackクラス org.springframework.integration.context.IntegrationObjectSupport から継承されたメソッド
afterPropertiesSet, extractTypeIfPossible, generateId, getApplicationContext, getApplicationContextId, getBeanDescription, getBeanFactory, getBeanName, getChannelResolver, getComponentDescription, getComponentName, getComponentSource, getConversionService, getExpression, getIntegrationProperties, getMessageBuilderFactory, getTaskScheduler, isInitialized, setApplicationContext, setBeanFactory, setBeanName, setChannelResolver, setComponentDescription, setComponentName, setComponentSource, setConversionService, setMessageBuilderFactory, setPrimaryExpression, setTaskScheduler, toStringクラス java.lang.ObjectSE から継承されたメソッド
clone, equalsSE, finalize, getClass, hashCode, notify, notifyAll, wait, waitSE, waitSEインターフェース reactor.core.CoreSubscriber から継承されたメソッド
currentContextインターフェース org.springframework.integration.support.management.IntegrationManagement から継承されたメソッド
getThisAsインターフェース org.springframework.integration.support.context.NamedComponent から継承されたメソッド
getBeanName, getComponentName
コンストラクターの詳細
FileWritingMessageHandler
非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。対象ファイルを保存するディレクトリを設定するコンストラクター。- パラメーター:
destinationDirectory- null であってはなりません- 関連事項:
FileWritingMessageHandler
非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。ターゲットファイルを保存する SpEL ディレクトリを設定するコンストラクター。- パラメーター:
destinationDirectoryExpression- null であってはなりません- 関連事項:
FileWritingMessageHandlerに有利であるため