org.opencastproject.util

Class StreamHelper

java.lang.Object

java.lang.Thread

org.opencastproject.util.StreamHelper

All Implemented Interfaces:

Runnable

Deprecated.

use StreamConsumer instead

public class StreamHelper
extends Thread

Helper class to handle Runtime.exec() output.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Thread

Thread.State, Thread.UncaughtExceptionHandler

Field Summary

Fields

Modifier and Type	Field and Description
protected StringBuffer	contentBuffer Deprecated. The content buffer
protected boolean	keepReading Deprecated. True to keep reading the streams
protected org.slf4j.Logger	processLogger Deprecated. Append messages to this logger
protected PrintWriter	writer Deprecated. the output writer

Fields inherited from class java.lang.Thread

MAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITY

Constructor Summary

Constructors

Constructor and Description
StreamHelper(InputStream inputStream) Deprecated. Creates a new stream helper and immediately starts capturing output from the given stream.
StreamHelper(InputStream inputStream, org.slf4j.Logger processLogger, StringBuffer contentBuffer) Deprecated. Creates a new stream helper and immediately starts capturing output from the given stream.
StreamHelper(InputStream inputStream, OutputStream redirect, org.slf4j.Logger processLogger, StringBuffer contentBuffer) Deprecated. Creates a new stream helper and immediately starts capturing output from the given stream.
StreamHelper(InputStream inputStream, OutputStream redirect, StringBuffer contentBuffer) Deprecated. Creates a new stream helper and immediately starts capturing output from the given stream.
StreamHelper(InputStream inputStream, StringBuffer contentBuffer) Deprecated. Creates a new stream helper and immediately starts capturing output from the given stream.

Method Summary

Modifier and Type	Method and Description
protected void	append(String output) Deprecated. This method will write any output from the stream to the the content buffer and the logger.
protected void	log(String output) Deprecated. If a logger has been specified, the output is written to the logger using the defined log level.
void	run() Deprecated. Thread run
void	stopReading() Deprecated. Tells the stream helper to stop reading and exit from the main loop, it then waits for the thread to die.

Methods inherited from class java.lang.Thread

activeCount, checkAccess, clone, countStackFrames, currentThread, destroy, dumpStack, enumerate, getAllStackTraces, getContextClassLoader, getDefaultUncaughtExceptionHandler, getId, getName, getPriority, getStackTrace, getState, getThreadGroup, getUncaughtExceptionHandler, holdsLock, interrupt, interrupted, isAlive, isDaemon, isInterrupted, join, join, join, resume, setContextClassLoader, setDaemon, setDefaultUncaughtExceptionHandler, setName, setPriority, setUncaughtExceptionHandler, sleep, sleep, start, stop, stop, suspend, toString, yield

Methods inherited from class java.lang.Object

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

Field Detail

contentBuffer

protected StringBuffer contentBuffer

Deprecated.

The content buffer

writer

protected PrintWriter writer

Deprecated.

the output writer

processLogger

protected org.slf4j.Logger processLogger

Deprecated.

Append messages to this logger

keepReading

protected boolean keepReading

Deprecated.

True to keep reading the streams

Constructor Detail

StreamHelper

public StreamHelper(InputStream inputStream)

Deprecated.

Creates a new stream helper and immediately starts capturing output from the given stream.

Parameters:

inputStream - the input stream

StreamHelper

public StreamHelper(InputStream inputStream,
                    StringBuffer contentBuffer)

Deprecated.

Creates a new stream helper and immediately starts capturing output from the given stream. Output will be captured to the given buffer.

Parameters:

inputStream - the input stream to read from

contentBuffer - the buffer to write the captured output to

StreamHelper

public StreamHelper(InputStream inputStream,
                    org.slf4j.Logger processLogger,
                    StringBuffer contentBuffer)

Deprecated.

Creates a new stream helper and immediately starts capturing output from the given stream. Output will be captured to the given buffer.

Parameters:

inputStream - the input stream to read from

processLogger - the logger to append to

contentBuffer - the buffer to write the captured output to

StreamHelper

public StreamHelper(InputStream inputStream,
                    OutputStream redirect,
                    StringBuffer contentBuffer)

Deprecated.

Creates a new stream helper and immediately starts capturing output from the given stream. Output will be captured to the given buffer and also redirected to the provided output stream.

Parameters:

inputStream - the input stream to read from

redirect - a stream to also redirect the captured output to

contentBuffer - the buffer to write the captured output to

StreamHelper

public StreamHelper(InputStream inputStream,
                    OutputStream redirect,
                    org.slf4j.Logger processLogger,
                    StringBuffer contentBuffer)

Deprecated.

Creates a new stream helper and immediately starts capturing output from the given stream. Output will be captured to the given buffer and also redirected to the provided output stream.

Parameters:

inputStream - the input stream to read from

redirect - a stream to also redirect the captured output to

processLogger - the logger to append to

contentBuffer - the buffer to write the captured output to

Method Detail

stopReading

public void stopReading()
                 throws InterruptedException

Deprecated.

Tells the stream helper to stop reading and exit from the main loop, it then waits for the thread to die.

Throws:

InterruptedException - if the thread is interrupted while waiting for the main loop to come to an end

See Also:

Thread.join()

run

public void run()

Deprecated.

Thread run

Specified by:

run in interface Runnable

Overrides:

run in class Thread

append

protected void append(String output)

Deprecated.

This method will write any output from the stream to the the content buffer and the logger.

Parameters:

output - the stream output

log

protected void log(String output)

Deprecated.

If a logger has been specified, the output is written to the logger using the defined log level.

Parameters:

output - the stream output