Package org.springframework.integration.file.splitter

Class FileSplitter

java.lang.Object
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.splitter.AbstractMessageSplitter
org.springframework.integration.file.splitter.FileSplitter
All Implemented Interfaces:
org.reactivestreams.Subscriber<Message<?>>, Aware, BeanClassLoaderAware, BeanFactoryAware, BeanNameAware, DisposableBean, InitializingBean, ApplicationContextAware, Ordered, ExpressionCapable, Orderable, MessageProducer, DiscardingMessageHandler, HeaderPropagationAware, IntegrationPattern, NamedComponent, IntegrationManagement, TrackableComponent, MessageHandler, reactor.core.CoreSubscriber<Message<?>>
public class FileSplitter extends AbstractMessageSplitter
The AbstractMessageSplitter implementation to split the File Message payload to lines.

With iterator = true (defaults to true) this class produces an Iterator to process file lines on demand from Iterator.next(). Otherwise a List of all lines is returned to the to further AbstractMessageSplitter.handleRequestMessage(org.springframework.messaging.Message<?>) process.

Can accept String as file path, File, Reader or InputStream as payload type. All other types are ignored and returned to the AbstractMessageSplitter as is.

If setFirstLineAsHeader(String) is specified, the first line of the content is treated as a header and carried as a header with the provided name in the messages emitted for the remaining lines. In this case, if markers are enabled, the line count in the END marker does not include the header line and, if applySequence is true, the header is not included in the sequence.

Since:
4.1.2
Author:
Artem Bilan, Gary Russell, Ruslan Stelmachenko

  • Constructor Details

    • FileSplitter

      public FileSplitter()
      Construct a splitter where the splitMessage(Message) method returns an iterator and the file is read line-by-line during iteration.

    • FileSplitter

      public FileSplitter(boolean iterator)
      Construct a splitter where the splitMessage(Message) method returns an iterator, and the file is read line-by-line during iteration, or a list of lines from the file.
      Parameters:
      iterator - true to return an iterator, false to return a list of lines.

    • FileSplitter

      public FileSplitter(boolean iterator, boolean markers)
      Construct a splitter where the splitMessage(Message) method returns an iterator, and the file is read line-by-line during iteration, or a list of lines from the file. When file markers are enabled (START/END) applySequence is false by default. If enabled, the markers are included in the sequence size.
      Parameters:
      iterator - true to return an iterator, false to return a list of lines.
      markers - true to emit start of file/end of file marker messages before/after the data.
      Since:
      4.1.5

    • FileSplitter

      public FileSplitter(boolean iterator, boolean markers, boolean markersJson)
      Construct a splitter where the splitMessage(Message) method returns an iterator, and the file is read line-by-line during iteration, or a list of lines from the file. When file markers are enabled (START/END) applySequence is false by default. If enabled, the markers are included in the sequence size.
      Parameters:
      iterator - true to return an iterator, false to return a list of lines.
      markers - true to emit start of file/end of file marker messages before/after the data.
      markersJson - when true, markers are represented as JSON.
      Since:
      4.2.7

  • Method Details

    • setCharset

      public void setCharset(@Nullable Charset charset)
      Set the charset to be used when reading the file, when something other than the default charset is required.
      Parameters:
      charset - the charset.

    • setFirstLineAsHeader

      public void setFirstLineAsHeader(String firstLineHeaderName)
      Specify the header name for the first line to be carried as a header in the messages emitted for the remaining lines.
      Parameters:
      firstLineHeaderName - the header name to carry first line.
      Since:
      5.0

    • splitMessage

      protected Object splitMessage(Message<?> message)
      Description copied from class: AbstractMessageSplitter
      Subclasses must override this method to split the received Message. The return value may be a Collection or Array. The individual elements may be Messages, but it is not necessary. If the elements are not Messages, each will be provided as the payload of a Message. It is also acceptable to return a single Object or Message. In that case, a single reply Message will be produced.
      Specified by:
      splitMessage in class AbstractMessageSplitter
      Parameters:
      message - The message.
      Returns:
      The result of splitting the message.

    • willAddHeaders

      protected boolean willAddHeaders(Message<?> message)
      Description copied from class: AbstractMessageSplitter
      Return true if the subclass needs to add headers in the resulting splits. If true, AbstractMessageSplitter.addHeaders(org.springframework.messaging.Message<?>, java.util.Map<java.lang.String, java.lang.Object>) will be called.
      Overrides:
      willAddHeaders in class AbstractMessageSplitter
      Parameters:
      message - the message.
      Returns:
      true

    • addHeaders

      protected void addHeaders(Message<?> message, Map<String,Object> headers)
      Description copied from class: AbstractMessageSplitter
      Allows subclasses to add extra headers to the output messages. Headers may not be removed by this method.
      Overrides:
      addHeaders in class AbstractMessageSplitter
      Parameters:
      message - the inbound message.
      headers - the headers to add messages to.