Class CharacterStreamWritingMessageHandler
java.lang.Object
org.springframework.integration.context.IntegrationObjectSupport
org.springframework.integration.handler.MessageHandlerSupport
org.springframework.integration.handler.AbstractMessageHandler
org.springframework.integration.stream.CharacterStreamWritingMessageHandler
- All Implemented Interfaces:
org.reactivestreams.Subscriber<org.springframework.messaging.Message<?>>,org.springframework.beans.factory.Aware,org.springframework.beans.factory.BeanFactoryAware,org.springframework.beans.factory.BeanNameAware,org.springframework.beans.factory.DisposableBean,org.springframework.beans.factory.InitializingBean,org.springframework.context.ApplicationContextAware,org.springframework.core.Ordered,org.springframework.integration.context.ExpressionCapable,org.springframework.integration.context.Orderable,org.springframework.integration.IntegrationPattern,org.springframework.integration.support.context.NamedComponent,org.springframework.integration.support.management.IntegrationManagement,org.springframework.integration.support.management.TrackableComponent,org.springframework.messaging.MessageHandler,reactor.core.CoreSubscriber<org.springframework.messaging.Message<?>>
public class CharacterStreamWritingMessageHandler
extends org.springframework.integration.handler.AbstractMessageHandler
A
MessageHandler
that writes characters to a Writer.
String, character array, and byte array payloads will be written directly,
but for other payload types, the result of the object's IntegrationObjectSupport.toString()
method will be written. To append a new-line after each write, set the
shouldAppendNewLine flag to 'true'. It is 'false' by default.-
Nested Class Summary
-
Field Summary
Fields inherited from class org.springframework.integration.context.IntegrationObjectSupport
EXPRESSION_PARSER, logger -
Constructor Summary
Constructors Constructor Description CharacterStreamWritingMessageHandler(java.io.Writer writer)CharacterStreamWritingMessageHandler(java.io.Writer writer, int bufferSize) -
Method Summary
Modifier and Type Method Description CharacterStreamWritingMessageHandlerappendNewLine(boolean append)Fluent api forsetShouldAppendNewLine(boolean).java.lang.StringgetComponentType()protected voidhandleMessageInternal(org.springframework.messaging.Message<?> message)voidsetShouldAppendNewLine(boolean shouldAppendNewLine)static CharacterStreamWritingMessageHandlerstderr()Factory method that creates a target for stderr (System.err) with the default charset encoding.static CharacterStreamWritingMessageHandlerstderr(java.lang.String charsetName)Factory method that creates a target for stderr (System.err) with the specified charset encoding.static CharacterStreamWritingMessageHandlerstdout()Factory method that creates a target for stdout (System.out) with the default charset encoding.static CharacterStreamWritingMessageHandlerstdout(java.lang.String charsetName)Factory method that creates a target for stdout (System.out) with the specified charset encoding.Methods inherited from class org.springframework.integration.handler.AbstractMessageHandler
handleMessage, onComplete, onError, onNext, onSubscribeMethods inherited from class org.springframework.integration.handler.MessageHandlerSupport
buildSendTimer, destroy, getIntegrationPatternType, getManagedName, getManagedType, getMetricsCaptor, getOrder, getOverrides, isLoggingEnabled, registerMetricsCaptor, sendTimer, setLoggingEnabled, setManagedName, setManagedType, setOrder, setShouldTrack, shouldTrackMethods inherited from class org.springframework.integration.context.IntegrationObjectSupport
afterPropertiesSet, extractTypeIfPossible, generateId, getApplicationContext, getApplicationContextId, getBeanDescription, getBeanFactory, getBeanName, getChannelResolver, getComponentName, getConversionService, getExpression, getIntegrationProperties, getIntegrationProperty, getMessageBuilderFactory, getTaskScheduler, isInitialized, onInit, setApplicationContext, setBeanFactory, setBeanName, setChannelResolver, setComponentName, setConversionService, setMessageBuilderFactory, setPrimaryExpression, setTaskScheduler, toStringMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
Constructor Details
-
CharacterStreamWritingMessageHandler
public CharacterStreamWritingMessageHandler(java.io.Writer writer) -
CharacterStreamWritingMessageHandler
public CharacterStreamWritingMessageHandler(java.io.Writer writer, int bufferSize)
-
-
Method Details
-
stdout
Factory method that creates a target for stdout (System.out) with the default charset encoding.- Returns:
- A stdout handler with the default charset.
-
stdout
Factory method that creates a target for stdout (System.out) with the specified charset encoding.- Parameters:
charsetName- The charset name.- Returns:
- A stdout handler.
-
stderr
Factory method that creates a target for stderr (System.err) with the default charset encoding.- Returns:
- A stderr handler with the default charset.
-
stderr
Factory method that creates a target for stderr (System.err) with the specified charset encoding.- Parameters:
charsetName- The charset name.- Returns:
- A stderr handler.
-
setShouldAppendNewLine
public void setShouldAppendNewLine(boolean shouldAppendNewLine) -
appendNewLine
Fluent api forsetShouldAppendNewLine(boolean).- Parameters:
append- true to append a newline.- Returns:
- this.
- Since:
- 5.4
-
getComponentType
public java.lang.String getComponentType()- Specified by:
getComponentTypein interfaceorg.springframework.integration.support.context.NamedComponent- Overrides:
getComponentTypein classorg.springframework.integration.handler.MessageHandlerSupport
-
handleMessageInternal
protected void handleMessageInternal(org.springframework.messaging.Message<?> message)- Specified by:
handleMessageInternalin classorg.springframework.integration.handler.AbstractMessageHandler
-