stream.net

Class BufferedDataObjectStream

java.lang.Object

stream.io.AbstractStream

stream.io.DataObjectStream

stream.net.BufferedDataObjectStream

All Implemented Interfaces:

Source, Stream

public class BufferedDataObjectStream
extends DataObjectStream

Adds a receive buffer to DataObjectStream for performance reasons and adds a reconnect functionality in case of an error.

Author:

Hendrik Blom, Tobias Beckers

Field Summary

Fields

Modifier and Type	Field and Description
protected int	bufferSize The buffer size (in bytes) used by this stream.
protected boolean	connected
protected int	connectionRetries the maximum amount of connection retries before the general connection attempt finally fails
private org.slf4j.Logger	log
protected long	reconnectInterval the time between two connection attempts if the first connection attempt was unsuccessful
protected String	urlCache caches the return value of getConnectionString()

Fields inherited from class stream.io.DataObjectStream

input

Fields inherited from class stream.io.AbstractStream

closed, count, id, in, limit, prefix, seqId, sequenceKey, url

Fields inherited from interface stream.io.Stream

SOURCE_KEY

Constructor Summary

Constructors

Constructor and Description
BufferedDataObjectStream(InputStream in) invokes DataObjectStream.DataObjectStream(InputStream)
BufferedDataObjectStream(SourceURL url) invokes DataObjectStream.DataObjectStream(SourceURL)

Method Summary

Modifier and Type	Method and Description
void	close() Closes / Resets this connection such that all resources are freed and the next invocation of AbstractStream.getInputStream() will return a fresh new connection to the target.
protected void	connect() Connects to the specified URL.
int	getBufferSize()
int	getConnectionRetries()
protected String	getConnectionString() Returns a string representing the connection url (works currently only with tcp connections).
long	getReconnectInterval()
void	init()
Data	readNext()
void	setBufferSize(int bufferSize)
void	setConnectionRetries(int connectionRetries)
void	setReconnectInterval(String reconnectIntervalString)

Methods inherited from class stream.io.AbstractStream

getId, getInputStream, getLimit, getPrefix, getSequenceKey, getUrl, read, setId, setLimit, setPrefix, setSequenceKey, setUrl

Methods inherited from class java.lang.Object

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

Field Detail

log

private final org.slf4j.Logger log

bufferSize

protected int bufferSize

The buffer size (in bytes) used by this stream. If set to ≤ 0: The BufferedInputStream's default buffer size is taken (usually 8192)

connectionRetries

protected int connectionRetries

the maximum amount of connection retries before the general connection attempt finally fails

reconnectInterval

protected long reconnectInterval

the time between two connection attempts if the first connection attempt was unsuccessful

urlCache

protected String urlCache

caches the return value of getConnectionString()

connected

protected boolean connected

Constructor Detail

BufferedDataObjectStream

public BufferedDataObjectStream(InputStream in)

invokes DataObjectStream.DataObjectStream(InputStream)

BufferedDataObjectStream

public BufferedDataObjectStream(SourceURL url)

invokes DataObjectStream.DataObjectStream(SourceURL)

Method Detail

getBufferSize

public int getBufferSize()

setBufferSize

@Parameter(required=false,
           defaultValue="0",
           description="The buffer size (in bytes) used by this stream. If set to <= 0: The BufferedInputStream\'s default buffer size is taken (usually 8192)")
public void setBufferSize(int bufferSize)

getConnectionRetries

public int getConnectionRetries()

setConnectionRetries

@Parameter(required=false,
           defaultValue="Integer.MAX_VALUE",
           description="the maximum amount of connection retries before the general connection attempt finally fails")
public void setConnectionRetries(int connectionRetries)

getReconnectInterval

public long getReconnectInterval()

setReconnectInterval

@Parameter(required=false,
           defaultValue="5s",
           description="the time between two connection attempts if the first connection attempt was unsuccessful")
public void setReconnectInterval(String reconnectIntervalString)
                                                                                                                                                                                                       throws Exception

Throws:

Exception

init

public void init()
          throws Exception

Specified by:

init in interface Source

Overrides:

init in class DataObjectStream

Throws:

Exception

See Also:

Source.init()

connect

protected void connect()
                throws ConnectException

Connects to the specified URL. Retries to connect up to connectionRetries times if not successful.

Throws:

ConnectException - if it is not possible to connect to the target

readNext

public Data readNext()
              throws ConnectException

See BufferedDataObjectStream for details.

Overrides:

readNext in class DataObjectStream

Throws:

ConnectException

See Also:

Source.read()

getConnectionString

protected String getConnectionString()

Returns a string representing the connection url (works currently only with tcp connections).

TODO Better: Implement and call SourceURL.toString() method

Returns:

a string representing the connection url

close

public void close()

Closes / Resets this connection such that all resources are freed and the next invocation of AbstractStream.getInputStream() will return a fresh new connection to the target.

Does nothing if the connection is not open

Specified by:

close in interface Source

Overrides:

close in class DataObjectStream

See Also:

Source.close()