- getAbsoluteEntryDate(ParsedEntry) - Method in class com.lightysoft.logmx.mgr.LogFileParser
-
Called by LogMX to get the Date
of the specified entry,
or null
if this Parser could not return the Date for this entry.
Parser should try to get this Date
from the String
given by pEntry.getDate()
.
- getAutoRefreshDelay() - Method in class com.lightysoft.logmx.mgr.LogFileManager
-
Called by LogMX to know the delay to wait between each automatic refresh,
for all logs opened with this LogFileManager
.
If this method returns -1
, then LogMX will use the user settings to determine this delay (in Managers
Options, several delays are tunable depending on Manager type: local file, socket, others).
This default implementation always returns -1
.
- getCompressFormat() - Method in class com.lightysoft.logmx.mgr.LogFileManager
-
Called by the Manager to get the name of the compression method that was
detected during previous call to
LogFileManager.getDecompressedStream(String, InputStream)
.
If the input stream was not considered as compressed, it will return
null
.
The possible values that can be returned are:
"ZIP"
"GZIP"
"TAR-GZIP"
"BZ2"
"TAR-BZ2"
"LZMA"
"TAR-LZMA"
"XZ"
"TAR-XZ"
- getConnectionTimeout() - Method in class com.lightysoft.logmx.mgr.LogFileManager
-
Called by the Manager to get the current value (in seconds) for the
user setting "Connection timeout", according to LogMX user preferences set in LogMX GUI.
- getCurrentFileInfo() - Method in class com.lightysoft.logmx.mgr.LogFileManager
-
Called periodically by LogMX to get the current file size and date.
This method is not abstract
or final
, so that most Managers may
not have to override (i.e.
- getCurrentFileLastModifDate() - Method in class com.lightysoft.logmx.mgr.LogFileManager
-
Called by LogMX to know when the opened resource was modified for the last time.
The expected result is a standard Java timestamp (number of milliseconds since 01/01/1970, 00:00:00 GMT).
- getCurrentFileSize() - Method in class com.lightysoft.logmx.mgr.LogFileManager
-
Called by LogMX to get the current resource size in bytes.
This method may be called periodically, so it should be rather fast (e.g.
- getCurrentFileSize() - Method in class com.lightysoft.logmx.mgr.LogStreamManager
-
- getCurrentOffset() - Method in class com.lightysoft.logmx.mgr.LogFileManager
-
Called by LogMX to know the current position in file.
Only Managers supporting Auto Refresh must implement this method, others should return 0.
- getCurrentOffset() - Method in class com.lightysoft.logmx.mgr.LogStreamManager
-
- getCurrentURL() - Method in class com.lightysoft.logmx.mgr.LogFileManager
-
- getDate() - Method in class com.lightysoft.logmx.business.ParsedEntry
-
Return entry Date found by parser in file
- getDecompressedStream(String, InputStream) - Method in class com.lightysoft.logmx.mgr.LogFileManager
-
Called by the Manager to get, if needed, a stream of uncompressed data
for the specified logs stream (case of file compressed with ZIP, GZIP or others).
If no compression was detected, the specified
InputStream
is returned.
LogMX will consider a file as compressed if its extension matches an handled compression method
(see
LogFileManager.getCompressFormat()
).
Note that user preferences (set in LogMX GUI) can disable all decompression features (see 'General' tab in Options).
The calling Manager should not have to keep a reference to
pInputStream
:
for example, closing the returned stream will also close the specified underlying stream even if it contains
compressed data.
- getDefaultValue() - Method in class com.lightysoft.logmx.business.LogURLParameter
-
Getter for attribute defaultValue
- getDescriptionForUser() - Method in class com.lightysoft.logmx.mgr.LogFileParser
-
Called by LogMX to get a complete description of this parser to
build error messages.
Implementing this method is optional for Parsers.
- getEmitter() - Method in class com.lightysoft.logmx.business.ParsedEntry
-
Return entry Emitter found by parser in file
- getEncoding() - Method in class com.lightysoft.logmx.mgr.LogFileManager
-
Called by the Manager to get the Encoding to use when reading bytes.
All Managers should call this method to use the right encoding.
The returned string is a valid Java encoding you can use for Java API methods, like:
new InputStreamReader(myStream, getEncoding());
- getFileDate() - Method in class com.lightysoft.logmx.mgr.LogFileInfo
-
Returns the file date (or 0 if unknown)
- getFileSize() - Method in class com.lightysoft.logmx.mgr.LogFileInfo
-
Returns the file size (or -1 if unknown)
- getFileTypeIcon() - Method in class com.lightysoft.logmx.mgr.LogFileManager
-
Called by LogMX to get this Manager icon, which must be a 16x16 icon.
Manager may use
LogFileManager.getIconFile(String)
to get an icon file
contained in LogMX pictures directory, in order to avoid relative file path issues.
This icon may (should) be cached, the same instance may be returned for each call for better performances.
If
null
is returned, a default icon will be used.
- getFileTypeIcon32x32() - Method in class com.lightysoft.logmx.mgr.LogFileManager
-
Called by LogMX to get this Manager icon, which must be a 32x32 icon.
For compatibility reason, this method is not abstract
so that exiting user-defined Managers
don't have to implement this new method appeared in LogMX v5.2.0.
- getGUIName() - Method in class com.lightysoft.logmx.mgr.LogFileParser
-
Called by the Parser to get the name of this parser, as set in LogMX GUI options
(may be used to build error messages for example).
- getHost() - Method in class com.lightysoft.logmx.mgr.ProxySettings
-
Getter for attribute
host
- getIconFile(String) - Static method in class com.lightysoft.logmx.mgr.LogFileManager
-
Called by the Manager to get the image contained in file named pImageFileName
in LogMX "pics/" directory.
The Manager should use this method to avoid relative file path issues.
- getLastParsedLineNumber() - Method in class com.lightysoft.logmx.mgr.LogFileParser
-
Called by the Parser to get the last parsed line number.
- getLevel() - Method in class com.lightysoft.logmx.business.ParsedEntry
-
Return entry Level found by parser in file
- getLocale() - Method in class com.lightysoft.logmx.mgr.LogFileParser
-
Called by the Parser to get the Locale to use by this Parser
(useful for Date & Time format handling).
Parsers should not call this method in constructor (will return null
).
- getLogEntriesInfoProvider() - Method in class com.lightysoft.logmx.mgr.LogFileManager
-
Called by LogMX to request the Manager to provide an object that will enrich
extracted log entries (like Parsers do): log entry date conversions, user-defined fields management.
This default implementation always returns
null
.
LogMX will call this method only if Manager returned
true
in
LogFileManager.supportLogEntriesExtraction()
.
- getLogFileManager() - Method in class com.lightysoft.logmx.mgr.LogFileParser
-
Called by the Parser to get the
LogFileManager
currently used to read the current log.
LogMX may return
null
in some cases (internal parsing, Parser test wizard, ...).
- getLogin() - Method in class com.lightysoft.logmx.mgr.ProxySettings
-
Getter for attribute
login
- getLogMXVersion() - Static method in class com.lightysoft.logmx.api.LogMXAPIUtils
-
Returns the current LogMX version as a String, with character "v" as prefix.
- getLogMXVersionAsIntegers() - Static method in class com.lightysoft.logmx.api.LogMXAPIUtils
-
Returns the current LogMX version as a list of integers.
- getMessage() - Method in class com.lightysoft.logmx.business.ParsedEntry
-
Return entry Message found by parser in file
- getName() - Method in class com.lightysoft.logmx.business.LogURLParameter
-
Getter for attribute name
- getName() - Method in class com.lightysoft.logmx.mgr.LogFileManager
-
Called by LogMX to get the name of this Manager.
- getOpenedFiles() - Static method in class com.lightysoft.logmx.api.LogMXAPIUtils
-
Returns the list of opened files in LogMX GUI.
- getOpenedFilesLogEntries() - Static method in class com.lightysoft.logmx.api.LogMXAPIUtils
-
Returns a map of opened files in LogMX GUI, with their Log Entries.
Each file is associated to the list of its
ParsedEntry
.
WARNING: For evident performances and memory consumption reasons, the returned lists of entries
are not clones of internal LogMX lists.
- getOpenedFilesLogManagers() - Static method in class com.lightysoft.logmx.api.LogMXAPIUtils
-
Returns a map of opened files in LogMX GUI, with their Log Manager.
Each file is associated to the
LogFileManager
that read it
- getOpenedFilesLogParsers() - Static method in class com.lightysoft.logmx.api.LogMXAPIUtils
-
Returns a map of opened files in LogMX GUI, with their Log Parser.
Each file is associated to the
LogFileParser
that parsed it
- getOrAskUserPassword(String, String) - Method in class com.lightysoft.logmx.mgr.LogFileManager
-
Called by the Manager to get a user password saved in LogMX password repository, or by asking
the user his password if the password is not saved in LogMX password repository yet.
The password is returned as a char[]
for security reasons, so that you can flush it efficiently from memory.
- getParameter(String) - Method in class com.lightysoft.logmx.business.LogURL
-
Get the Parameter
named pParamName
.
- getParameters() - Method in class com.lightysoft.logmx.business.LogURL
-
Returns Parameter
s contained in this URL.
- getParsedFileName() - Method in class com.lightysoft.logmx.mgr.LogFileParser
-
Called by the Parser to get the name of the file to be parsed by this Parser.
Parsers should not call this method in constructor (will return null
).
- getParserName() - Method in class com.lightysoft.logmx.mgr.LogEntriesInfoProvider
-
This implementation returns a specific name to indicate that this is not a really Parser, but a stub used to extract entries.
- getParserName() - Method in class com.lightysoft.logmx.mgr.LogFileParser
-
Called by LogMX to get the name of this Parser.
All Parsers must implement this method to return a short name (~3 words maximum) that will
be displayed in LogMX GUI.
- getPasswd() - Method in class com.lightysoft.logmx.mgr.ProxySettings
-
- getPort() - Method in class com.lightysoft.logmx.mgr.ProxySettings
-
Getter for attribute
port
- getPossibleValues() - Method in class com.lightysoft.logmx.business.LogURLParameter
-
Getter for attribute possibleValues
- getProtocolName() - Method in class com.lightysoft.logmx.mgr.LogFileManager
-
Called by LogMX to get the Protocol handled by this Manager.
This protocol can be any string, like "http", "jdbc", "ftp", "myprotocol", ...
LogMX will use it to find the Manager to use for a given a URL (eg: "jdbc:oracle:thin:@host:1521:db")
- getProxySettings(String) - Method in class com.lightysoft.logmx.mgr.LogFileManager
-
Called by the Manager to get the proxy settings to use to connect to a host,
according to LogMX user preferences set in LogMX GUI.
Note: the returned object does not contain any password, even if a login/password is set for proxy in LogMX preferences (for security reasons).
- getRelativeEntryDate(ParsedEntry) - Method in class com.lightysoft.logmx.mgr.LogFileParser
-
Called by LogMX to get a timestamp for entry pEntry
,
or null
if this Parser doesn't support relative timestamps.
A relative timestamp is a timestamp relative to any arbitrary start date (in many cases,
T0
matches the launch of the process that writes the log file).
Parser should try to get this timestamp from the data given by pEntry.getExtraInfo()
or pEntry.getDate()
.
- getShortFilename() - Method in class com.lightysoft.logmx.mgr.LogFileManager
-
Called by LogMX to get a shorter version of current URL, in order to
display it in GUI file tab.
This method is not abstract
or final
, so that most Managers may
not have to override (i.e.
- getSize() - Method in class com.lightysoft.logmx.business.LogURL
-
Returns the number of Parameter
s in this URL
- getSpecificationVersion() - Method in class com.lightysoft.logmx.mgr.LogFileManager
-
Called by LogMX to get the Manager Specification version supported by this Manager.
- getSupportedFileType() - Method in class com.lightysoft.logmx.mgr.LogEntriesInfoProvider
-
This implementation returns a specific file type to indicate that this is not a really Parser, but a stub used to extract entries.
- getSupportedFileType() - Method in class com.lightysoft.logmx.mgr.LogFileParser
-
Called by LogMX to get a short description of supported file type(s).
All Parsers must implement this method to return a short description (~3 words maximum)
of supported file type(s) (will be displayed in LogMX GUI).
- getTemplateLogURL() - Method in class com.lightysoft.logmx.mgr.LogFileManager
-
Called by LogMX to get a template of LogURL
used by this Manager.
The returned LogURL
can (should) be a static shared instance for better performance.
- getThread() - Method in class com.lightysoft.logmx.business.ParsedEntry
-
Return entry Thread found by parser in file
- getTooltip() - Method in class com.lightysoft.logmx.business.LogURLParameter
-
Getter for attribute tooltip
- getType() - Method in class com.lightysoft.logmx.business.LogURLParameter
-
Getter for attribute type
- getURLFromLogURL(LogURL, String) - Static method in class com.lightysoft.logmx.mgr.LogFileManager
-
Called by the Manager to construct a string URL from a LogURL and a URL pattern.
- getURLPattern() - Method in class com.lightysoft.logmx.mgr.LogFileManager
-
Called by LogMX to know how to display a URL handled by this Manager.
- getUserDefinedFields() - Method in class com.lightysoft.logmx.business.ParsedEntry
-
Return the
Map
that holds all user-defined fields stored by the parser
for this entry, given by their name (e.g.
- getUserDefinedFields() - Method in class com.lightysoft.logmx.mgr.LogFileParser
-
Called by LogMX to get the ordered list of user-defined fields to display
(given by their key), for each entry.
The default implementation for this class is to return an empty list (i.e.
- getUserDefinedFieldsClasses() - Method in class com.lightysoft.logmx.mgr.LogFileParser
-
Called by LogMX to get the type of each user-defined field (see
LogFileParser.getUserDefinedFields()
).
The default implementation for this class is to return an empty list, which means that LogMX will assume
that all user-defined fields are
String
.
- getValue() - Method in class com.lightysoft.logmx.business.LogURLParameter
-
Getter for attribute value
- getVersion() - Method in class com.lightysoft.logmx.mgr.ManagerSpecVersion
-
Returns the Specification version for this instance
- getVersionInfo() - Method in class com.lightysoft.logmx.mgr.LogFileParser
-
Called by LogMX to get a Parser version info message to display.
Implementing this method is optional for Parsers.