*** This API provides Binary Compatibility only, not Source Compatibility ***

com.sas.services.logging.util
Class LoggerStream

java.lang.Object
  |
  +--java.io.OutputStream
        |
        +--com.sas.services.logging.util.LoggerStream

public class LoggerStream

extends OutputStream

LoggerStream - used to create an output stream connected to a Logging Service LoggerInterface. Typically a LoggerInterface object is obtained from the LoggingServiceInterface, and that LoggerInterface object is passed to the constructor for this class. The LoggerStream object is then used as an OutputStream would normally be used. Information sent to this LoggerStream will appear as Logging Service messages originating from the specified LoggerInterface object.

Since:

1.0

See Also:

Logging Service Documentation

Field Summary

static int

DEFAULT_BUFFER_SIZE Default size, in bytes, of data flushed to Output Stream target.

Constructor Summary

LoggerStream(LoggerInterface log, String context, int priority)
Constructor.

Method Summary

void	close() Close the LoggerStream.
void	flush() Flush data contained in the LoggerStream.
int	getBufferSize() Get the size of the LoggerStream buffer.
void	setBufferSize(int bufferSize) Set the size of the LoggerStream buffer.
void	write(byte[] b) Write a byte array to the LoggerStream.
void	write(byte[] b, int offset, int length) Write a byte array to the LoggerStream.
void	write(int i) Write to the LoggerStream.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_BUFFER_SIZE

public static final int DEFAULT_BUFFER_SIZE

Default size, in bytes, of data flushed to Output Stream target.

Constructor Detail

LoggerStream

public LoggerStream(LoggerInterface log,
                    String context,
                    int priority)

Constructor.

Parameters:

log - a LoggerInterface object that messages will be logged on.

context - logging context for messages logged.

priority - level that messages will be reported at.

Method Detail

close

public void close()

Close the LoggerStream.

Overrides:

close in class OutputStream

flush

public void flush()

Flush data contained in the LoggerStream.

Overrides:

flush in class OutputStream

write

public void write(byte[] b)

Write a byte array to the LoggerStream.

Overrides:

write in class OutputStream

Parameters:

b - byte array to write.

write

public void write(byte[] b,
                  int offset,
                  int length)

Write a byte array to the LoggerStream.

Overrides:

write in class OutputStream

Parameters:

b - byte array to write.

offset - location in byte array of first byte to write.

length - number of bytes to write. If offset plus length is greater than the size of the byte array, then less than length bytes will be written - only those in the byte array.

write

public void write(int i)

Write to the LoggerStream.

Overrides:

write in class OutputStream

Parameters:

i - int written as a character to the LoggerStream.

getBufferSize

public int getBufferSize()

Get the size of the LoggerStream buffer.

setBufferSize

public void setBufferSize(int bufferSize)

Set the size of the LoggerStream buffer. If the length of the data in the buffer is greater than the new buffer size, then all data in the buffer will be flushed.

*** This API provides Binary Compatibility only, not Source Compatibility ***