- 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.
- getAutoRefreshDelay() - Method in class com.lightysoft.logmx.mgr.LogFileManager
-
Called by LogMX to know the delay (in ms) to wait between each automatic refresh,
for all logs opened with this LogFileManager
.
- getCompressFormat() - Method in class com.lightysoft.logmx.mgr.LogFileManager
-
- getCompressFormatFromFileName(String) - Method in class com.lightysoft.logmx.mgr.LogFileManager
-
Called by the Manager to know the compression format that should be used for the given file name
(guessed from its extension: ZIP, GZIP or others).
- 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.
- getCurrentFileLastModifDate() - Method in class com.lightysoft.logmx.mgr.LogFileManager
-
Called by LogMX to know when the opened resource was modified for the last time.
- getCurrentFileSize() - Method in class com.lightysoft.logmx.mgr.LogFileManager
-
Called by LogMX to get the current resource size in bytes.
- 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.
- getCurrentOffset() - Method in class com.lightysoft.logmx.mgr.LogStreamManager
-
- getCurrentURL() - Method in class com.lightysoft.logmx.mgr.LogFileManager
-
Called by LogMX to get the current opened URL, matching this Manager URL template.
- 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).
- getDecompressedStream(InputStream, String) - 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 and specified compression format.
- getDefaultValue() - Method in class com.lightysoft.logmx.business.LogURLParameter
-
Getter for attribute defaultValue
: Default value that will be displayed in the GUI
- getDescriptionForUser() - Method in class com.lightysoft.logmx.mgr.LogFileParser
-
Called by LogMX to get a complete description of this parser to
build error messages.
- 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.
- getEntryStringRepresentation(ParsedEntry) - Method in class com.lightysoft.logmx.mgr.LogFileParser
-
Called by LogMX to get a textual description of the given Log entry.
- 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.
- getFileTypeIcon32x32() - Method in class com.lightysoft.logmx.mgr.LogFileManager
-
Called by LogMX to get this Manager icon, which must be a 32x32 icon.
- 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.
- 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).
- 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.
- getLogFileManager() - Method in class com.lightysoft.logmx.mgr.LogFileParser
-
Called by the Parser to get the
LogFileManager
currently used to read the current log.
- 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
: Name that will be displayed in GUI just before the parameter's value
- 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 their password if the password is not saved in LogMX password repository yet.
- 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.
- 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.
- 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
-
- getProtocolName() - Method in class com.lightysoft.logmx.mgr.LogFileManager
-
Called by LogMX to get the Protocol handled by this Manager.
- 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.
- 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.
- 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.
- 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).
- getTemplateLogURL() - Method in class com.lightysoft.logmx.mgr.LogFileManager
-
Called by LogMX to get a template of LogURL
used by this Manager.
- 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
: Text that will appear in GUI as a tooltip for this parameter
- getType() - Method in class com.lightysoft.logmx.business.LogURLParameter
-
Getter for attribute type
: Parameter type used by LogMX to render the "Open file" dialog and to check parameters validity
- 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.
- getUserDefinedFieldDesription(String) - Method in class com.lightysoft.logmx.mgr.LogFileParser
-
- 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.
- getUserDefinedFieldsClasses() - Method in class com.lightysoft.logmx.mgr.LogFileParser
-
- getValue() - Method in class com.lightysoft.logmx.business.LogURLParameter
-
Getter for attribute value
: Set by LogMX GUI to specify the parameter value to the Manager
- 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.
- setDate(String) - Method in class com.lightysoft.logmx.business.ParsedEntry
-
Set entry Date found by parser in file
- setDefaultValue(Object) - Method in class com.lightysoft.logmx.business.LogURLParameter
-
Setter for attribute defaultValue
: Default value that will be displayed in the GUI
- setEmitter(String) - Method in class com.lightysoft.logmx.business.ParsedEntry
-
Set entry Emitter found by parser in file
- setFileDate(long) - Method in class com.lightysoft.logmx.mgr.LogFileInfo
-
Set the file date
- setFileSize(long) - Method in class com.lightysoft.logmx.mgr.LogFileInfo
-
Set the file size
- setHasReadTimeout(boolean) - Method in class com.lightysoft.logmx.mgr.LogStreamManager
-
- setHost(String) - Method in class com.lightysoft.logmx.mgr.ProxySettings
-
Setter for attribute
host
- setLevel(String) - Method in class com.lightysoft.logmx.business.ParsedEntry
-
Set entry Level found by parser in file
- setLogin(String) - Method in class com.lightysoft.logmx.mgr.ProxySettings
-
Setter for attribute
login
- setMessage(String) - Method in class com.lightysoft.logmx.business.ParsedEntry
-
Set entry Message found by parser in file
- setOptional(boolean) - Method in class com.lightysoft.logmx.business.LogURLParameter
-
Setter for attribute optional
: Indicates whether this parameter is optional
- setPasswd(String) - Method in class com.lightysoft.logmx.mgr.ProxySettings
-
- setPort(int) - Method in class com.lightysoft.logmx.mgr.ProxySettings
-
Setter for attribute
port
- setShouldBeDisplayAsGeneric(boolean) - Method in class com.lightysoft.logmx.business.LogURLParameter
-
Setter for attribute shouldBeDisplayedAsGeneric
: Indicates whether this parameter should be displayed in "Open file" dialog with the other generic fields (used by some LogMX complex Managers for advanced parameters set in a separate panel of "Open file" dialog)
- setThread(String) - Method in class com.lightysoft.logmx.business.ParsedEntry
-
Set entry Thread found by parser in file
- setTooltip(String) - Method in class com.lightysoft.logmx.business.LogURLParameter
-
Setter for attribute tooltip
: Text that will appear in GUI as a tooltip for this parameter
- setUsedForConnection(boolean) - Method in class com.lightysoft.logmx.business.LogURLParameter
-
Setter for attribute usedForConnection
: Indicates whether this parameter is used to establish a connection
- setUseLogin(boolean) - Method in class com.lightysoft.logmx.mgr.ProxySettings
-
- setUseProxy(boolean) - Method in class com.lightysoft.logmx.mgr.ProxySettings
-
- setUserDefinedFields(Map<String, Object>) - Method in class com.lightysoft.logmx.business.ParsedEntry
-
Set the
Map
that holds all user-defined fields stored by the parser
for this entry, given by their name (e.g.
- setValue(Object) - Method in class com.lightysoft.logmx.business.LogURLParameter
-
Setter for attribute value
: Set by LogMX GUI to specify the parameter value to the Manager
- shouldBeDisplayedAsGeneric() - Method in class com.lightysoft.logmx.business.LogURLParameter
-
Getter for attribute shouldBeDisplayedAsGeneric
: Indicates whether this parameter should be displayed in "Open file" dialog with the other generic fields (used by some LogMX complex Managers for advanced parameters set in a separate panel of "Open file" dialog)
- supportFileDelete() - Method in class com.lightysoft.logmx.mgr.LogFileManager
-
Called by LogMX to know if this Manager can delete (i.e. remove from disk) the current file.
- supportFileDelete() - Method in class com.lightysoft.logmx.mgr.LogStreamManager
-
- supportFileFlush() - Method in class com.lightysoft.logmx.mgr.LogFileManager
-
Called by LogMX to know if this Manager can flush (i.e. empty) the current file.
- supportFileFlush() - Method in class com.lightysoft.logmx.mgr.LogStreamManager
-
- supportHeaderReading() - Method in class com.lightysoft.logmx.mgr.LogFileManager
-
Called by LogMX to know if this Manager support header reading (read a specified number of bytes from the beginning of the file).
- supportHeaderReading() - Method in class com.lightysoft.logmx.mgr.LogStreamManager
-
- supportLogEntriesExtraction() - Method in class com.lightysoft.logmx.mgr.LogFileManager
-
Called by LogMX to know if this Manager can extract log entries itself,
without the use of any Log Parser (e.g.
- supportRandomAccess() - Method in class com.lightysoft.logmx.mgr.LogFileManager
-
Called by LogMX to know if this Manager support random access (read bytes starting at a specified offset).
- supportRandomAccess() - Method in class com.lightysoft.logmx.mgr.LogStreamManager
-