public class ManagerSpecVersion extends Object
LogFileManagermust provide (through implementation of abstract Java methods).
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.
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, ...).
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.
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.
LogFileManager.getCurrentOffset()must not throw
LogFileManager.getCurrentFileSize()must not return
0if Manager can't get its size, but
LogFileManager.prepareForReading()must not return a
long, but a
LogFileManager.releaseResources(boolean)now takes a
booleanparameter (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.
LogFileManager.getCurrentFileInfo(): this method is not
final, so that most Managers may not have to override (i.e. redefine) it, but some others can. The default implementation returns a
LogFileInfocontaining the file size and date returned by
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.
LogFileManager.newEncodingDetected(): this method is not
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.readLine()if and only if the encoding to use (to read bytes from the underlying resource) has changed.
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
LogFileManager.prepareForReading()to initialize its Input Stream Reader, or if the Input Stream Reader used in
LogFileManager.readFileHeader(int)is also used in
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.getCurrentFileSize()to be called by LogMX during a specific code execution.
|Modifier and Type||Field and Description|
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
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
Manager Specification v1.2 (supported since LogMX v5.2.0, see this class Javadoc for details)
|Modifier and Type||Method and Description|
Returns the Specification version for this instance
@Deprecated public static final ManagerSpecVersion V1_0
@Deprecated public static final ManagerSpecVersion V1_1
public static final ManagerSpecVersion V1_2
public String toString()
public String getVersion()
Copyright © 2019 LightySoft. All rights reserved. [LogMX v7.8.0 (May 10, 2019)]