org.apache.camel.component.stream

Class StreamEndpoint

java.lang.Object

org.apache.camel.support.ServiceSupport

org.apache.camel.impl.DefaultEndpoint

org.apache.camel.component.stream.StreamEndpoint

All Implemented Interfaces:

org.apache.camel.CamelContextAware, org.apache.camel.Endpoint, org.apache.camel.IsSingleton, org.apache.camel.Service, org.apache.camel.ShutdownableService, org.apache.camel.spi.HasId, org.apache.camel.StatefulService, org.apache.camel.SuspendableService

@UriEndpoint(firstVersion="1.3.0",
             scheme="stream",
             title="Stream",
             syntax="stream:kind",
             consumerClass=StreamConsumer.class,
             label="file,system")
public class StreamEndpoint
extends org.apache.camel.impl.DefaultEndpoint

The stream: component provides access to the system-in, system-out and system-err streams as well as allowing streaming of file and URL.

Field Summary

Fields inherited from class org.apache.camel.support.ServiceSupport

shutdown, shuttingdown, started, starting, stopped, stopping, suspended, suspending

Constructor Summary

Constructors

Constructor and Description
StreamEndpoint(String endpointUri) Deprecated.
StreamEndpoint(String endpointUri, org.apache.camel.Component component)

Method Summary

Modifier and Type	Method and Description
org.apache.camel.Consumer	createConsumer(org.apache.camel.Processor processor)
protected org.apache.camel.Exchange	createExchange(Object body, long index, boolean last)
org.apache.camel.Producer	createProducer()
protected void	doStart()
int	getAutoCloseCount()
Charset	getCharset()
int	getConnectTimeout()
long	getDelay()
String	getEncoding()
String	getFileName()
int	getGroupLines()
GroupStrategy	getGroupStrategy()
Map<String,Object>	getHttpHeaders()
long	getInitialPromptDelay()
String	getKind()
long	getPromptDelay()
String	getPromptMessage()
int	getReadTimeout()
long	getScanStreamDelay()
String	getUrl()
boolean	isCloseOnDone()
boolean	isFileWatcher()
boolean	isRetry()
boolean	isScanStream()
boolean	isSingleton()
void	setAutoCloseCount(int autoCloseCount) Number of messages to process before closing stream on Producer side.
void	setCloseOnDone(boolean closeOnDone) This option is used in combination with Splitter and streaming to the same file.
void	setConnectTimeout(int connectTimeout) Sets a specified timeout value, in milliseconds, to be used when opening a communications link to the resource referenced by this URLConnection.
void	setDelay(long delay) Initial delay in milliseconds before producing the stream.
void	setEncoding(String encoding) You can configure the encoding (is a charset name) to use text-based streams (for example, message body is a String object).
void	setFileName(String fileName) When using the stream:file URI format, this option specifies the filename to stream to/from.
void	setFileWatcher(boolean fileWatcher) To use JVM file watcher to listen for file change events to support re-loading files that may be overwritten, somewhat like tail --retry
void	setGroupLines(int groupLines) To group X number of lines in the consumer.
void	setGroupStrategy(GroupStrategy strategy) Allows to use a custom GroupStrategy to control how to group lines.
void	setHttpHeaders(Map<String,Object> httpHeaders) Optional http headers to use in request when using HTTP URL.
void	setInitialPromptDelay(long initialPromptDelay) Initial delay in milliseconds before showing the message prompt.
void	setKind(String kind) Kind of stream to use such as System.in or System.out.
void	setPromptDelay(long promptDelay) Optional delay in milliseconds before showing the message prompt.
void	setPromptMessage(String promptMessage) Message prompt to use when reading from stream:in; for example, you could set this to Enter a command:
void	setReadTimeout(int readTimeout) Sets the read timeout to a specified timeout, in milliseconds.
void	setRetry(boolean retry) Will retry opening the stream if it's overwritten, somewhat like tail --retry If reading from files then you should also enable the fileWatcher option, to make it work reliable.
void	setScanStream(boolean scanStream) To be used for continuously reading a stream such as the unix tail command.
void	setScanStreamDelay(long scanStreamDelay) Delay in milliseconds between read attempts when using scanStream.
void	setUrl(String url) When using the stream:url URI format, this option specifies the URL to stream to/from.

Methods inherited from class org.apache.camel.impl.DefaultEndpoint

configureConsumer, configurePollingConsumer, configureProperties, createEndpointConfiguration, createEndpointUri, createExchange, createExchange, createExchange, createPollingConsumer, doStop, equals, getCamelContext, getComponent, getConsumerProperties, getEndpointConfiguration, getEndpointKey, getEndpointUri, getExceptionHandler, getExchangePattern, getId, getPollingConsumerBlockTimeout, getPollingConsumerQueueSize, hashCode, isBridgeErrorHandler, isLenientProperties, isPollingConsumerBlockWhenFull, isSynchronous, setBridgeErrorHandler, setCamelContext, setConsumerProperties, setEndpointConfiguration, setEndpointUri, setEndpointUriIfNotSpecified, setExceptionHandler, setExchangePattern, setPollingConsumerBlockTimeout, setPollingConsumerBlockWhenFull, setPollingConsumerQueueSize, setProperties, setSynchronous, toString

Methods inherited from class org.apache.camel.support.ServiceSupport

doResume, doShutdown, doSuspend, getStatus, getVersion, isRunAllowed, isStarted, isStarting, isStopped, isStopping, isStoppingOrStopped, isSuspended, isSuspending, isSuspendingOrSuspended, resume, shutdown, start, stop, suspend

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.camel.Service

start, stop

Constructor Detail

StreamEndpoint

public StreamEndpoint(String endpointUri,
                      org.apache.camel.Component component)
               throws Exception

Throws:

Exception

StreamEndpoint

@Deprecated
public StreamEndpoint(String endpointUri)

Deprecated.

Method Detail

createConsumer

public org.apache.camel.Consumer createConsumer(org.apache.camel.Processor processor)
                                         throws Exception

Throws:

Exception

createProducer

public org.apache.camel.Producer createProducer()
                                         throws Exception

Throws:

Exception

isSingleton

public boolean isSingleton()

createExchange

protected org.apache.camel.Exchange createExchange(Object body,
                                                   long index,
                                                   boolean last)

getKind

public String getKind()

setKind

public void setKind(String kind)

Kind of stream to use such as System.in or System.out.

getFileName

public String getFileName()

setFileName

public void setFileName(String fileName)

When using the stream:file URI format, this option specifies the filename to stream to/from.

getUrl

public String getUrl()

setUrl

public void setUrl(String url)

When using the stream:url URI format, this option specifies the URL to stream to/from. The input/output stream will be opened using the JDK URLConnection facility.

getDelay

public long getDelay()

setDelay

public void setDelay(long delay)

Initial delay in milliseconds before producing the stream.

getEncoding

public String getEncoding()

setEncoding

public void setEncoding(String encoding)

You can configure the encoding (is a charset name) to use text-based streams (for example, message body is a String object). If not provided, Camel uses the JVM default Charset.

getPromptMessage

public String getPromptMessage()

setPromptMessage

public void setPromptMessage(String promptMessage)

Message prompt to use when reading from stream:in; for example, you could set this to Enter a command:

getPromptDelay

public long getPromptDelay()

setPromptDelay

public void setPromptDelay(long promptDelay)

Optional delay in milliseconds before showing the message prompt.

getInitialPromptDelay

public long getInitialPromptDelay()

setInitialPromptDelay

public void setInitialPromptDelay(long initialPromptDelay)

Initial delay in milliseconds before showing the message prompt. This delay occurs only once. Can be used during system startup to avoid message prompts being written while other logging is done to the system out.

isScanStream

public boolean isScanStream()

setScanStream

public void setScanStream(boolean scanStream)

To be used for continuously reading a stream such as the unix tail command.

getGroupStrategy

public GroupStrategy getGroupStrategy()

setGroupStrategy

public void setGroupStrategy(GroupStrategy strategy)

Allows to use a custom GroupStrategy to control how to group lines.

isRetry

public boolean isRetry()

setRetry

public void setRetry(boolean retry)

Will retry opening the stream if it's overwritten, somewhat like tail --retry

If reading from files then you should also enable the fileWatcher option, to make it work reliable.

isFileWatcher

public boolean isFileWatcher()

setFileWatcher

public void setFileWatcher(boolean fileWatcher)

To use JVM file watcher to listen for file change events to support re-loading files that may be overwritten, somewhat like tail --retry

isCloseOnDone

public boolean isCloseOnDone()

setCloseOnDone

public void setCloseOnDone(boolean closeOnDone)

This option is used in combination with Splitter and streaming to the same file. The idea is to keep the stream open and only close when the Splitter is done, to improve performance. Mind this requires that you only stream to the same file, and not 2 or more files.

getScanStreamDelay

public long getScanStreamDelay()

setScanStreamDelay

public void setScanStreamDelay(long scanStreamDelay)

Delay in milliseconds between read attempts when using scanStream.

getGroupLines

public int getGroupLines()

setGroupLines

public void setGroupLines(int groupLines)

To group X number of lines in the consumer. For example to group 10 lines and therefore only spit out an Exchange with 10 lines, instead of 1 Exchange per line.

getAutoCloseCount

public int getAutoCloseCount()

setAutoCloseCount

public void setAutoCloseCount(int autoCloseCount)

Number of messages to process before closing stream on Producer side. Never close stream by default (only when Producer is stopped). If more messages are sent, the stream is reopened for another autoCloseCount batch.

getCharset

public Charset getCharset()

getHttpHeaders

public Map<String,Object> getHttpHeaders()

setHttpHeaders

public void setHttpHeaders(Map<String,Object> httpHeaders)

Optional http headers to use in request when using HTTP URL.

getConnectTimeout

public int getConnectTimeout()

setConnectTimeout

public void setConnectTimeout(int connectTimeout)

Sets a specified timeout value, in milliseconds, to be used when opening a communications link to the resource referenced by this URLConnection. If the timeout expires before the connection can be established, a java.net.SocketTimeoutException is raised. A timeout of zero is interpreted as an infinite timeout.

getReadTimeout

public int getReadTimeout()

setReadTimeout

public void setReadTimeout(int readTimeout)

Sets the read timeout to a specified timeout, in milliseconds. A non-zero value specifies the timeout when reading from Input stream when a connection is established to a resource. If the timeout expires before there is data available for read, a java.net.SocketTimeoutException is raised. A timeout of zero is interpreted as an infinite timeout.

doStart

protected void doStart()
                throws Exception

Overrides:

doStart in class org.apache.camel.impl.DefaultEndpoint

Throws:

Exception