com.lightysoft.logmx.mgr

Class LogStreamManager

java.lang.Object

com.lightysoft.logmx.mgr.LogFileManager

com.lightysoft.logmx.mgr.LogStreamManager

All Implemented Interfaces:

Cloneable

public abstract class LogStreamManager
extends LogFileManager

This class describes a LogFileManager that reads logs from a live stream. Such Manager cannot read backward or forward, and, most of the time, cannot read the next data until it's available (blocking read). This typically occurs when reading through a pipe, socket, serial port, ...

Managers must always extend this abstract class if they are reading logs from a live stream, instead of extending directly LogFileManager.

Since:

LogMX v5.2.0, Manager Specification Version 1.2

Author:

LightySoft

See Also:

ManagerSpecVersion

Field Summary

Fields inherited from class com.lightysoft.logmx.mgr.LogFileManager

READ_MUTEX

Constructor Summary

Constructors

Constructor and Description
LogStreamManager()

Method Summary

Modifier and Type	Method and Description
boolean	deleteFile() Method overriding parent method LogFileManager.deleteFile() to always return false
boolean	flushFile() Method overriding parent method LogFileManager.flushFile() to always return true
long	getCurrentFileSize() Method overriding parent method LogFileManager.getCurrentFileSize() to always return -1
long	getCurrentOffset() Method overriding parent method LogFileManager.getCurrentOffset() to always throw UnsupportedOperationException
boolean	isLiveStream() Method overriding parent method LogFileManager.isLiveStream() to always return true
byte[]	readFileHeader(int pNbBytes) Method overriding parent method LogFileManager.readFileHeader(int) to always throw UnsupportedOperationException
AutoRefreshLineInfo	readLineAtOffset(long pOffset) Method overriding parent method LogFileManager.readLineAtOffset(long) to always throw UnsupportedOperationException
abstract void	setHasReadTimeout(boolean pHasReadTimeout) Called by LogMX to tell the Manager if next reads shall be blocking calls or not. If LogMX expects that LogFileManager.readLine() or LogFileManager.readEntry() shall be blocking until some data is read, then the parameter pHasReadTimeout will be false.
boolean	supportFileDelete() Method overriding parent method LogFileManager.supportFileDelete() to always return false
boolean	supportFileFlush() Method overriding parent method LogFileManager.supportFileFlush() to always return true
boolean	supportHeaderReading() Method overriding parent method LogFileManager.supportHeaderReading() to always return false
boolean	supportRandomAccess() Method overriding parent method LogFileManager.supportRandomAccess() to always return false

Methods inherited from class com.lightysoft.logmx.mgr.LogFileManager

canUseParser, createNewEntryForExtraction, getAutoRefreshDelay, getCompressFormat, getCompressFormatFromFileName, getConnectionTimeout, getCurrentFileInfo, getCurrentFileLastModifDate, getCurrentURL, getDecompressedStream, getDecompressedStream, getEncoding, getFileTypeIcon, getFileTypeIcon32x32, getIconFile, getLogEntriesInfoProvider, getName, getOrAskUserPassword, getProtocolName, getProxySettings, getShortFilename, getSpecificationVersion, getTemplateLogURL, getURLFromLogURL, getURLPattern, init, newEncodingDetected, prepareForReading, readEntry, readLine, releaseResources, supportLogEntriesExtraction

Methods inherited from class java.lang.Object

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

Constructor Detail

LogStreamManager

public LogStreamManager()

Method Detail

setHasReadTimeout

public abstract void setHasReadTimeout(boolean pHasReadTimeout)

Called by LogMX to tell the Manager if next reads shall be blocking calls or not.
If LogMX expects that LogFileManager.readLine() or LogFileManager.readEntry() shall be blocking until some data is read, then the parameter pHasReadTimeout will be false. Otherwise, the Manager shall use a timeout mechanism (e.g. java.net.Socket.setSoTimeout()) with a timeout value around 100ms.

Parameters:

pHasReadTimeout - true if a timeout shall be used when reading underlying resource, or false if next reads shall be blocking.

Since:

LogMX v5.2.0, Manager Specification Version 1.2 (see ManagerSpecVersion)

isLiveStream

public final boolean isLiveStream()

Method overriding parent method LogFileManager.isLiveStream() to always return true

Overrides:

isLiveStream in class LogFileManager

Returns:

This implementation always returns true

Since:

LogMX v5.2.0, Manager Specification Version 1.2 (see ManagerSpecVersion)

See Also:

LogFileManager.isLiveStream()

getCurrentFileSize

public final long getCurrentFileSize()

Method overriding parent method LogFileManager.getCurrentFileSize() to always return -1

Specified by:

getCurrentFileSize in class LogFileManager

Returns:

This implementation always returns -1 (live streams don't have a size)

Since:

LogMX v5.2.0, Manager Specification Version 1.2 (see ManagerSpecVersion)

See Also:

LogFileManager.getCurrentFileSize()

getCurrentOffset

public final long getCurrentOffset()

Method overriding parent method LogFileManager.getCurrentOffset() to always throw UnsupportedOperationException

Specified by:

getCurrentOffset in class LogFileManager

Returns:

This implementation always throws UnsupportedOperationException (live streams don't have to be aware of current offset)

Since:

LogMX v5.2.0, Manager Specification Version 1.2 (see ManagerSpecVersion)

See Also:

LogFileManager.getCurrentOffset()

readLineAtOffset

public final AutoRefreshLineInfo readLineAtOffset(long pOffset)
                                           throws Exception

Method overriding parent method LogFileManager.readLineAtOffset(long) to always throw UnsupportedOperationException

Specified by:

readLineAtOffset in class LogFileManager

Parameters:

pOffset - Starting offset

Returns:

This implementation always throws UnsupportedOperationException (live streams don't have to be aware of current offset)

Throws:

Exception - If Manager could not read bytes

Since:

LogMX v5.2.0, Manager Specification Version 1.2 (see ManagerSpecVersion)

See Also:

LogFileManager.readLineAtOffset(long)

readFileHeader

public final byte[] readFileHeader(int pNbBytes)
                            throws Exception

Method overriding parent method LogFileManager.readFileHeader(int) to always throw UnsupportedOperationException

Specified by:

readFileHeader in class LogFileManager

Parameters:

pNbBytes - Number of bytes to read. If negative, Manager must read as much bytes as possible (for example, up to the end of file)

Returns:

This implementation always throws UnsupportedOperationException (live streams don't have to support file header reading)

Throws:

Exception - If Manager could not read bytes

Since:

LogMX v5.2.0, Manager Specification Version 1.2 (see ManagerSpecVersion)

See Also:

LogFileManager.readFileHeader(int)

supportFileDelete

public final boolean supportFileDelete()

Method overriding parent method LogFileManager.supportFileDelete() to always return false

Specified by:

supportFileDelete in class LogFileManager

Returns:

This implementation always returns false(live streams don't have to support file deletion)

Since:

LogMX v5.2.0, Manager Specification Version 1.2 (see ManagerSpecVersion)

See Also:

LogFileManager.supportFileDelete()

supportFileFlush

public final boolean supportFileFlush()

Method overriding parent method LogFileManager.supportFileFlush() to always return true

Specified by:

supportFileFlush in class LogFileManager

Returns:

This implementation always returns true since LogMX will only flush read entries from its GUI, and stream is not impacted (no job to be done by Manager, that's why this method is final).

Since:

LogMX v5.2.0, Manager Specification Version 1.2 (see ManagerSpecVersion)

See Also:

LogFileManager.supportFileFlush()

supportHeaderReading

public final boolean supportHeaderReading()

Method overriding parent method LogFileManager.supportHeaderReading() to always return false

Specified by:

supportHeaderReading in class LogFileManager

Returns:

This implementation always returns false(live streams don't have to support header reading)

Since:

LogMX v5.2.0, Manager Specification Version 1.2 (see ManagerSpecVersion)

See Also:

LogFileManager.supportHeaderReading()

supportRandomAccess

public final boolean supportRandomAccess()

Method overriding parent method LogFileManager.supportRandomAccess() to always return false

Specified by:

supportRandomAccess in class LogFileManager

Returns:

This implementation always returns false(live streams don't have to support random access)

Since:

LogMX v5.2.0, Manager Specification Version 1.2 (see ManagerSpecVersion)

See Also:

LogFileManager.supportRandomAccess()

deleteFile

public final boolean deleteFile()

Method overriding parent method LogFileManager.deleteFile() to always return false

Specified by:

deleteFile in class LogFileManager

Returns:

This implementation always returns false(live streams don't have to support file deletion)

Since:

LogMX v5.2.0, Manager Specification Version 1.2 (see ManagerSpecVersion)

See Also:

LogFileManager.deleteFile()

flushFile

public final boolean flushFile()

Method overriding parent method LogFileManager.flushFile() to always return true

Specified by:

flushFile in class LogFileManager

Returns:

This implementation always returns true since LogMX will only flush read entries from its GUI, and stream is not impacted (no job to be done by Manager, that's why this method is final).

Since:

LogMX v5.2.0, Manager Specification Version 1.2 (see ManagerSpecVersion)

See Also:

LogFileManager.flushFile()