com.lightysoft.logmx.mgr

Class ManagerSpecVersion

java.lang.Object

com.lightysoft.logmx.mgr.ManagerSpecVersion

public class ManagerSpecVersion
extends Object

Defines LogMX Manager Specifications versions.

Each Specification version matches a set of services that a LogMX LogFileManager must provide (through implementation of abstract Java methods).

This Specification version helps LogMX to know if a Manager is too old to be used with the current LogMX version. For example, a Manager written for Specification v1.0 will be ignored if current version of LogMX requires a v1.1 Manager. Yet, version v1.2 is backward compatible with v1.1 (i.e. a LogMX version needing a v1.2 version will still be able to use a v1.1 version).

Specification versions change log:

Version v1.2 (since LogMX v5.2.0)

Compressed logs feature

• LogFileManager.getDecompressedStream(String, InputStream) is now available to uncompress (ZIP, GZIP, ...) logs on the fly if needed. See LogFileManager.getCompressFormat() for the complete list of supported formats. Manager just has to use the returned stream to read uncompressed data.
• LogFileManager.getCompressFormat() is now available so that the Manager can be aware of compression type detected by LogMX.

Live stream Managers

• LogFileManager.isLiveStream() is now available to indicate to LogMX if this Manager is reading log entries from a live stream (e.g. socket, serial port, ...).

Log entries extraction by Managers

• LogFileManager.supportLogEntriesExtraction() is now available to indicate to LogMX that this Manager can extract log entries itself, without the use of any Log Parser (e.g. case of log entries received as a non-textual stream, like when reading a database, or reading binary data).
• LogFileManager.readEntry() is now available to require a Manager (with log-entries-extraction capabilities) to extract the next entry from its underlying data source.
• LogFileManager.getLogEntriesInfoProvider() is now available to require a Manager to provide an object that will enrich extracted entries (like Parsers do): log entry date conversions, user-defined fields management.

New miscellaneous features

• LogFileManager.getFileTypeIcon32x32() is now available so that Manager can provide LogMX GUI with a larger icon for its file type.
• LogFileManager.getConnectionTimeout() is now available so that the Manager can use the connection timeout value as defined by the user in his/her preferences.

Version v1.1 (since LogMX v1.2.4)

• LogFileManager.getCurrentOffset() must not throw Exception anymore
  
• LogFileManager.getCurrentFileSize() must not return 0 if Manager can't get its size, but -1 instead
  
• LogFileManager.prepareForReading() must not return a long, but a LogFileInfo instead
  
• LogFileManager.releaseResources(boolean) now takes a boolean parameter (no parameter in previous versions). This boolean is a flag indicating if the Manager should perform a soft release, because the LogMX file tab remains open, or if the Manager should release all allocated resources and close all sockets because the LogMX file tab was closed. For example, a FTP Manager can close the current channel or file transfer on a soft release, but should also close the entire FTP session on a full release.
  
• New method LogFileManager.getCurrentFileInfo(): this method is not abstract or final, so that most Managers may not have to override (i.e. redefine) it, but some others can. The default implementation returns a LogFileInfo containing the file size and date returned by LogFileManager.getCurrentFileSize() and LogFileManager.getCurrentFileLastModifDate(). Manager must override this new method if getting the file size and file date are both time-consuming and if they both need a same connection, transaction, context, ... For example, if getting both file size/date can be performed via a single SFTP "STAT" command, the Manager shall override LogFileManager.getCurrentFileInfo() so that only one "STAT" command is performed. Note: this new method is called periodically for file change detection and Auto-Refresh.
  
• New method LogFileManager.newEncodingDetected(): this method is not abstract or final, so that most Managers may not have to override (i.e. redefine) it, but some others can. This method is called by LogMX after LogFileManager.prepareForReading() and before LogFileManager.readLine() if and only if the encoding to use (to read bytes from the underlying resource) has changed.
  Managers can get this new encoding using LogFileManager.getEncoding().
  If the user chose to auto-detect encoding from LogMX GUI, LogMX will perform this auto-detection after the call to prepareForReading(). If the encoding found during this auto-detection is different from the one set while prepareForReading() was called, this method newEncodingDetected() will be called so that the Manager can re-create its Input Stream Reader before readLine() is called.
  Default implementation of this method does nothing. A Manager should override this method if it calls LogFileManager.getEncoding() in LogFileManager.prepareForReading() to initialize its Input Stream Reader, or if the Input Stream Reader used in LogFileManager.readFileHeader(int) is also used in LogFileManager.readLine().
  
• New final attribute LogFileManager.READ_MUTEX: mutex used by LogMX and the Manager to ensure that only one thread makes this Manager read from the underlying resource, at the same time. Managers can synchronize with this Mutex if they don't want LogFileManager.getCurrentFileLastModifDate() or LogFileManager.getCurrentFileSize() to be called by LogMX during a specific code execution.

Version v1.0 (from LogMX v1.2.2 to LogMX v1.2.3)

• (first published version)

Since:

LogMX v1.2.2

Author:

LightySoft

See Also:

LogFileManager.getSpecificationVersion()

Field Summary

Fields

Modifier and Type	Field and Description
static ManagerSpecVersion	V1_0 Deprecated. Manager Specification v1.0 (supported from LogMX v1.2.2 to v1.2.3). Managers must be compliant with V1_1 since LogMX v1.2.4
static ManagerSpecVersion	V1_1 Deprecated. Manager Specification v1.1 (supported since LogMX v1.2.4, and deprecated since v5.2.0). Managers should be compliant with V1_2 since LogMX v5.2.0
static ManagerSpecVersion	V1_2 Manager Specification v1.2 (supported since LogMX v5.2.0, see this class Javadoc for details)

Method Summary

Modifier and Type	Method and Description
String	getVersion() Returns the Specification version for this instance
String	toString() Returns getVersion()

Methods inherited from class java.lang.Object

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

Field Detail

V1_0

@Deprecated
public static final ManagerSpecVersion V1_0

Deprecated. Manager Specification v1.0 (supported from LogMX v1.2.2 to v1.2.3).
Managers must be compliant with V1_1 since LogMX v1.2.4

V1_1

@Deprecated
public static final ManagerSpecVersion V1_1

Deprecated. Manager Specification v1.1 (supported since LogMX v1.2.4, and deprecated since v5.2.0).
Managers should be compliant with V1_2 since LogMX v5.2.0

V1_2

public static final ManagerSpecVersion V1_2

Manager Specification v1.2 (supported since LogMX v5.2.0, see this class Javadoc for details)

Method Detail

toString

public String toString()

Returns getVersion()

Overrides:

toString in class Object

Returns:

Returns value of getVersion()

Since:

LogMX v1.2.2

See Also:

Object.toString()

getVersion

public String getVersion()

Returns the Specification version for this instance

Returns:

Specification version for this instance

Since:

LogMX v1.2.2