org.springframework.integration.stream

Class CharacterStreamReadingMessageSource

java.lang.Object

org.springframework.integration.util.AbstractExpressionEvaluator

org.springframework.integration.endpoint.AbstractMessageSource<String>

org.springframework.integration.stream.CharacterStreamReadingMessageSource

All Implemented Interfaces:

Aware, BeanFactoryAware, BeanNameAware, DisposableBean, InitializingBean, ApplicationEventPublisherAware, MessageSource<String>, NamedComponent, BaseSourceMetrics, IntegrationManagement, MessageSourceMetrics

public class CharacterStreamReadingMessageSource
extends AbstractMessageSource<String>
implements ApplicationEventPublisherAware

A pollable source for Readers.

Author:

Mark Fisher, Gary Russell, Artem Bilan

Nested Class Summary

Nested classes/interfaces inherited from interface org.springframework.integration.support.management.IntegrationManagement

IntegrationManagement.ManagementOverrides

Field Summary

Fields inherited from class org.springframework.integration.util.AbstractExpressionEvaluator

EXPRESSION_PARSER, logger

Fields inherited from interface org.springframework.integration.support.management.IntegrationManagement

METER_PREFIX, RECEIVE_COUNTER_NAME, SEND_TIMER_NAME

Constructor Summary

Constructors

Constructor and Description
CharacterStreamReadingMessageSource(Reader reader) Construct an instance with the provider reader.
CharacterStreamReadingMessageSource(Reader reader, int bufferSize) Construct an instance with the provider reader and buffer size.
CharacterStreamReadingMessageSource(Reader reader, int bufferSize, boolean blockToDetectEOF) Construct an instance with the provided reader and buffer size.

Method Summary

Modifier and Type	Method and Description
String	doReceive() Subclasses must implement this method.
String	getComponentType()
void	setApplicationEventPublisher(ApplicationEventPublisher applicationEventPublisher)
static CharacterStreamReadingMessageSource	stdin() Create a source that reads from System.in.
static CharacterStreamReadingMessageSource	stdin(String charsetName) Create a source that reads from System.in.
static CharacterStreamReadingMessageSource	stdinPipe() Create a source that reads from System.in.
static CharacterStreamReadingMessageSource	stdinPipe(String charsetName) Create a source that reads from System.in.

Methods inherited from class org.springframework.integration.endpoint.AbstractMessageSource

buildMessage, destroy, getBeanName, getComponentName, getManagedName, getManagedType, getMessageCount, getMessageCountLong, getOverrides, isCountsEnabled, isLoggingEnabled, receive, registerMetricsCaptor, reset, setBeanName, setCountsEnabled, setHeaderExpressions, setLoggingEnabled, setManagedName, setManagedType

Methods inherited from class org.springframework.integration.util.AbstractExpressionEvaluator

afterPropertiesSet, evaluateExpression, evaluateExpression, evaluateExpression, evaluateExpression, evaluateExpression, evaluateExpression, evaluateExpression, getBeanFactory, getEvaluationContext, getEvaluationContext, getMessageBuilderFactory, onInit, setBeanFactory, setConversionService

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.springframework.integration.support.management.MessageSourceMetrics

messageCount

Constructor Detail

CharacterStreamReadingMessageSource

public CharacterStreamReadingMessageSource(Reader reader)

Construct an instance with the provider reader. AbstractMessageSource.receive() will return null when the reader is not ready.

Parameters:

reader - the reader.

CharacterStreamReadingMessageSource

public CharacterStreamReadingMessageSource(Reader reader,
                                           int bufferSize)

Construct an instance with the provider reader and buffer size. AbstractMessageSource.receive() will return null when the reader is not ready.

Parameters:

reader - the reader.

bufferSize - the buffer size.

CharacterStreamReadingMessageSource

public CharacterStreamReadingMessageSource(Reader reader,
                                           int bufferSize,
                                           boolean blockToDetectEOF)

Construct an instance with the provided reader and buffer size. When blockToDetectEOF is false, AbstractMessageSource.receive() will return null when the reader is not ready. When it is true, the thread will block until data is available; when the underlying stream is closed, a StreamClosedEvent is published to inform the application via an ApplicationListener. This can be useful, for example, when piping stdin

     cat foo.txt | java -jar my.jar
 

or

     java -jar my.jar < foo.txt
 

Parameters:

reader - the reader.

bufferSize - the buffer size; if negative use the default in BufferedReader.

blockToDetectEOF - true to block the thread until data is available and publish a StreamClosedEvent at EOF.

Since:

5.0

Method Detail

setApplicationEventPublisher

public void setApplicationEventPublisher(ApplicationEventPublisher applicationEventPublisher)

Specified by:

setApplicationEventPublisher in interface ApplicationEventPublisherAware

getComponentType

public String getComponentType()

Specified by:

getComponentType in interface NamedComponent

doReceive

public String doReceive()

Description copied from class: AbstractMessageSource

Subclasses must implement this method. Typically the returned value will be the payload of type T, but the returned value may also be a Message instance whose payload is of type T; also can be AbstractIntegrationMessageBuilder which is used for additional headers population.

Specified by:

doReceive in class AbstractMessageSource<String>

Returns:

The value returned.

stdin

public static final CharacterStreamReadingMessageSource stdin()

Create a source that reads from System.in. EOF will not be detected.

Returns:

the stream.

stdin

public static final CharacterStreamReadingMessageSource stdin(String charsetName)

Create a source that reads from System.in. EOF will not be detected.

Parameters:

charsetName - the charset to use when converting bytes to String.

Returns:

the stream.

stdinPipe

public static final CharacterStreamReadingMessageSource stdinPipe()

Create a source that reads from System.in. EOF will be detected and the application context closed.

Returns:

the stream.

Since:

5.0

See Also:

CharacterStreamReadingMessageSource(Reader, int, boolean)

stdinPipe

public static final CharacterStreamReadingMessageSource stdinPipe(String charsetName)

Create a source that reads from System.in. EOF will be detected and the application context closed.

Parameters:

charsetName - the charset to use when converting bytes to String.

Returns:

the stream.

Since:

5.0

See Also:

CharacterStreamReadingMessageSource(Reader, int, boolean)