FileTransferringMessageHandler (Spring Integration API)

java.lang.ObjectSE
- org.springframework.integration.context.IntegrationObjectSupport
- - org.springframework.integration.handler.MessageHandlerSupport
  - - org.springframework.integration.handler.AbstractMessageHandler
    - - org.springframework.integration.file.remote.handler.FileTransferringMessageHandler<F>

実装されているすべてのインターフェース:
org.reactivestreams.Subscriber<Message<?>>, Aware, BeanFactoryAware, BeanNameAware, DisposableBean, InitializingBean, ApplicationContextAware, Ordered, ExpressionCapable, Orderable, IntegrationPattern, NamedComponent, IntegrationManagement, TrackableComponent, MessageHandler, reactor.core.CoreSubscriber<Message<?>>
既知の直属サブクラス
FtpMessageHandler, SftpMessageHandler
```
public class FileTransferringMessageHandler<F>
extends AbstractMessageHandler
```
ファイルをリモートサーバーに転送する MessageHandler 実装。
導入:
2.0
作成者:
Iwein Fuld, Mark Fisher, Josh Long, Oleg Zhurakousky, David Turanski, Gary Russell, Artem Bilan

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

フィールドのサマリー
フィールド
修飾子と型フィールドと説明
protected RemoteFileTemplate<F> remoteFileTemplate
- クラス 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

フィールド
修飾子と型	フィールドと説明
`protected RemoteFileTemplate<F>`	`remoteFileTemplate`

コンストラクターの概要

コンストラクター
コンストラクターと説明
`FileTransferringMessageHandler(RemoteFileTemplate<F> remoteFileTemplate)`
`FileTransferringMessageHandler(RemoteFileTemplate<F> remoteFileTemplate, FileExistsMode mode)`
`FileTransferringMessageHandler(SessionFactory<F> sessionFactory)`

メソッドのサマリー

すべてのメソッドインスタンスメソッド具象メソッド
修飾子と型	メソッドと説明
`protected void`	`doChmod(RemoteFileTemplate<F> remoteFileTemplate, StringSE path, int chmod)` 転送後にリモートファイルでモードを設定します。デフォルトの実装は何もしません。
`protected StringSE`	`getTemporaryFileSuffix()`
`protected void`	`handleMessageInternal(Message<?> message)`
`boolean`	`isChmodCapable()`
`protected boolean`	`isUseTemporaryFileName()`
`protected void`	`onInit()` サブクラスは、初期化ロジック用にこれを実装できます。
`void`	`setAutoCreateDirectory(boolean autoCreateDirectory)` 自動的にディレクトリを作成するかどうかを示す `boolean` フラグ。
`void`	`setCharset(StringSE charset)` 文字列ペイロードをリモートファイルのコンテンツとしてバイトに変換するときに使用する文字セットを設定します。
`void`	`setChmod(int chmod)` アップロード後にファイルのアクセス許可を設定します。
`void`	`setChmodOctal(StringSE chmod)` Spring XML の利便性のためのストリング setter。
`void`	`setFileNameGenerator(FileNameGenerator fileNameGenerator)` ファイルをリモートシステムに転送するときに使用されるリモートファイル名の生成に使用されるファイル名ジェネレーターを設定します。
`void`	`setRemoteDirectoryExpression(Expression remoteDirectoryExpression)` リモートディレクトリパス SpEL 式を指定します。
`void`	`setRemoteDirectoryExpressionString(StringSE remoteDirectoryExpression)` リモートディレクトリパス SpEL 式を指定します。
`void`	`setRemoteFileSeparator(StringSE remoteFileSeparator)` リモートファイル区切り記号を指定します。
`void`	`setTemporaryFileSuffix(StringSE temporaryFileSuffix)` ファイルをリモートシステムに転送するときに使用する一時的なサフィックスを設定します。
`void`	`setTemporaryRemoteDirectoryExpression(Expression temporaryRemoteDirectoryExpression)` リモートディレクトリパス SpEL 式を指定します。
`void`	`setTemporaryRemoteDirectoryExpressionString(StringSE temporaryRemoteDirectoryExpression)` リモートディレクトリパス SpEL 式を指定します。
`void`	`setUseTemporaryFileName(boolean useTemporaryFileName)` 一時ファイル名を使用するかどうかを指定する `boolean` フラグ。

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

クラス org.springframework.integration.handler.MessageHandlerSupport から継承されたメソッド
buildSendTimer, destroy, getComponentType, 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

- フィールドの詳細
  - remoteFileTemplate
```
protected final RemoteFileTemplate<F> remoteFileTemplate
```
- コンストラクターの詳細
  - FileTransferringMessageHandler
```
public FileTransferringMessageHandler(SessionFactory<F> sessionFactory)
```
  - FileTransferringMessageHandler
```
public FileTransferringMessageHandler(RemoteFileTemplate<F> remoteFileTemplate)
```
  - FileTransferringMessageHandler
```
public FileTransferringMessageHandler(RemoteFileTemplate<F> remoteFileTemplate,
                                      FileExistsMode mode)
```
- メソッドの詳細
  - setAutoCreateDirectory
```
public void setAutoCreateDirectory(boolean autoCreateDirectory)
```
    自動的にディレクトリを作成するかどうかを示す boolean フラグ。
    パラメーター:
    autoCreateDirectory - ディレクトリを自動的に作成する場合は true。
    関連事項:
    RemoteFileTemplate.setAutoCreateDirectory(boolean)
  - setRemoteFileSeparator
```
public void setRemoteFileSeparator(StringSE remoteFileSeparator)
```
    リモートファイル区切り記号を指定します。
    パラメーター:
    remoteFileSeparator - リモートファイル区切り。
    関連事項:
    RemoteFileTemplate.setRemoteFileSeparator(String)
  - setRemoteDirectoryExpression
```
public void setRemoteDirectoryExpression(Expression remoteDirectoryExpression)
```
    リモートディレクトリパス SpEL 式を指定します。
    パラメーター:
    remoteDirectoryExpression - リモートディレクトリ式
    関連事項:
    RemoteFileTemplate.setRemoteDirectoryExpression(Expression)
  - setRemoteDirectoryExpressionString
```
public void setRemoteDirectoryExpressionString(StringSE remoteDirectoryExpression)
```
    リモートディレクトリパス SpEL 式を指定します。
    パラメーター:
    remoteDirectoryExpression - リモートディレクトリ式
    導入:
    4.3.13
    関連事項:
    setRemoteDirectoryExpression(Expression)
  - setTemporaryRemoteDirectoryExpression
```
public void setTemporaryRemoteDirectoryExpression(Expression temporaryRemoteDirectoryExpression)
```
    リモートディレクトリパス SpEL 式を指定します。
    パラメーター:
    temporaryRemoteDirectoryExpression - 一時的なリモートディレクトリ式
    関連事項:
    RemoteFileTemplate.setTemporaryRemoteDirectoryExpression(Expression)
  - setTemporaryRemoteDirectoryExpressionString
```
public void setTemporaryRemoteDirectoryExpressionString(StringSE temporaryRemoteDirectoryExpression)
```
    リモートディレクトリパス SpEL 式を指定します。
    パラメーター:
    temporaryRemoteDirectoryExpression - 一時的なリモートディレクトリ式
    導入:
    4.3.13
    関連事項:
    setTemporaryRemoteDirectoryExpression(Expression)
  - getTemporaryFileSuffix
```
protected StringSE getTemporaryFileSuffix()
```
  - isUseTemporaryFileName
```
protected boolean isUseTemporaryFileName()
```
  - setUseTemporaryFileName
```
public void setUseTemporaryFileName(boolean useTemporaryFileName)
```
    一時ファイル名を使用するかどうかを指定する boolean フラグ。デフォルトは true です。
    パラメーター:
    useTemporaryFileName - 一時ファイル名を使用する場合は true。
    関連事項:
    RemoteFileTemplate.setUseTemporaryFileName(boolean)
  - setFileNameGenerator
```
public void setFileNameGenerator(FileNameGenerator fileNameGenerator)
```
    ファイルをリモートシステムに転送するときに使用されるリモートファイル名の生成に使用されるファイル名ジェネレーターを設定します。デフォルト DefaultFileNameGenerator
    パラメーター:
    fileNameGenerator - ファイル名ジェネレーター。
    関連事項:
    RemoteFileTemplate.setFileNameGenerator(FileNameGenerator)
  - setCharset
```
public void setCharset(StringSE charset)
```
    文字列ペイロードをリモートファイルのコンテンツとしてバイトに変換するときに使用する文字セットを設定します。デフォルト UTF-8
    パラメーター:
    charset - 文字セット。
    関連事項:
    RemoteFileTemplate.setCharset(String)
  - setTemporaryFileSuffix
```
public void setTemporaryFileSuffix(StringSE temporaryFileSuffix)
```
    ファイルをリモートシステムに転送するときに使用する一時的なサフィックスを設定します。デフォルトの ".writing"。
    パラメーター:
    temporaryFileSuffix - 一時ファイルのサフィックス。
    関連事項:
    RemoteFileTemplate.setTemporaryFileSuffix(String)
  - setChmodOctal
```
public void setChmodOctal(StringSE chmod)
```
    Spring XML の利便性のためのストリング setter。
    パラメーター:
    chmod - 8 進数の文字列としてのアクセス許可（例: "600"）。
    導入:
    4.3
    関連事項:
    setChmod(int)
  - setChmod
```
public void setChmod(int chmod)
```
    アップロード後にファイルのアクセス許可を設定します。所有者の読み取り / 書き込みの場合は 0600。
    パラメーター:
    chmod - 許可。
    導入:
    4.3
  - isChmodCapable
```
public boolean isChmodCapable()
```
  - onInit
```
protected void onInit()
```
    クラスからコピーされた説明: IntegrationObjectSupport
    サブクラスは、初期化ロジック用にこれを実装できます。
    オーバーライド:
    クラス IntegrationObjectSupport の onInit
  - handleMessageInternal
```
protected void handleMessageInternal(Message<?> message)
```
    次で指定:
    クラス AbstractMessageHandler の handleMessageInternal
  - doChmod
```
protected void doChmod(RemoteFileTemplate<F> remoteFileTemplate,
                       StringSE path,
                       int chmod)
```
    転送後にリモートファイルでモードを設定します。デフォルトの実装は何もしません。
    パラメーター:
    remoteFileTemplate - リモートファイルテンプレート。
    path - パス。
    chmod - 設定する chmod。
    導入:
    4.3

クラス FileTransferringMessageHandler<F>

ネストされたクラスの要約

インターフェース 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 から継承されたメソッド

フィールドの詳細

remoteFileTemplate

コンストラクターの詳細

FileTransferringMessageHandler

FileTransferringMessageHandler

FileTransferringMessageHandler

メソッドの詳細

setAutoCreateDirectory

setRemoteFileSeparator

setRemoteDirectoryExpression

setRemoteDirectoryExpressionString

setTemporaryRemoteDirectoryExpression

setTemporaryRemoteDirectoryExpressionString

getTemporaryFileSuffix

isUseTemporaryFileName

setUseTemporaryFileName

setFileNameGenerator

setCharset

setTemporaryFileSuffix

setChmodOctal

setChmod

isChmodCapable

onInit

handleMessageInternal

doChmod