LogMX
The universal log analyzer
www.logmx.com
A C D E F G H I L M N P R S T U V 

A

addEntry(ParsedEntry) - Method in class com.lightysoft.logmx.mgr.LogFileParser
Called by the Parser for each entry it has successfully parsed.
Calling this method several consecutive times with the same pParsedEntry produces no effect in most cases.
addParameter(LogURLParameter) - Method in class com.lightysoft.logmx.business.LogURL
Adds a Parameter to this URL
AutoRefreshLineInfo - Class in com.lightysoft.logmx.mgr
Structure containing information on a line of text read for Auto-refresh, returned by LogFileManager.readLineAtOffset(long)
AutoRefreshLineInfo(String, boolean) - Constructor for class com.lightysoft.logmx.mgr.AutoRefreshLineInfo
Construct an AutoRefreshLineInfo with the given text and EOF flag

C

clone() - Method in class com.lightysoft.logmx.business.LogURL
Clone this URL (called by LogMX to clone URL returned by the Manager)
clone() - Method in class com.lightysoft.logmx.business.LogURLParameter
Clone this Parameter (called by LogMX to clone LogURL returned by the Manager)
com.lightysoft.logmx.api - package com.lightysoft.logmx.api
Package containing API classes not related to Log Parsers and Log Managers
com.lightysoft.logmx.business - package com.lightysoft.logmx.business
Business objects that Parsers and Managers can use to share data with LogMX
com.lightysoft.logmx.mgr - package com.lightysoft.logmx.mgr
Package containing abstract classes that Parsers and Managers have to extend
createNewEntry() - Method in class com.lightysoft.logmx.mgr.LogFileParser
Called by the Parser to create and return a new blank log entry to be used by this Parser.
Parsers should not try to directly create entries instead of calling this method.
createNewEntryForExtraction() - Method in class com.lightysoft.logmx.mgr.LogFileManager
Called by the Manager to create and return a new blank log entry to be used by this Manager during entry extraction (see LogFileManager.supportLogEntriesExtraction()).

Managers should not try to directly create entries instead of calling this method.

D

deleteFile() - Method in class com.lightysoft.logmx.mgr.LogFileManager
Called by LogMX to delete (i.e.
deleteFile() - Method in class com.lightysoft.logmx.mgr.LogStreamManager
Method overriding parent method LogFileManager.deleteFile() to always return false

E

endOfFileReached - Variable in class com.lightysoft.logmx.mgr.AutoRefreshLineInfo
Flag indicating if end of file was reached before a line terminator could be read

F

flushFile() - Method in class com.lightysoft.logmx.mgr.LogFileManager
Called by LogMX to flush (i.e.
flushFile() - Method in class com.lightysoft.logmx.mgr.LogStreamManager
Method overriding parent method LogFileManager.flushFile() to always return true

G

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
Method overriding parent method LogFileManager.getCurrentFileSize() to always return -1
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
Method overriding parent method LogFileManager.getCurrentOffset() to always throw UnsupportedOperationException
getCurrentURL() - Method in class com.lightysoft.logmx.mgr.LogFileManager
Called by LogMX to get the current opened URL, matching this Manager URL template.
This method may return the URL string received by LogFileManager.init(LogURL, String), or use LogFileManager.getURLFromLogURL(LogURL, String) to construct the URL.
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 Parameters 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
Getter for attribute passwd
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 Parameters 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.

H

host - Variable in class com.lightysoft.logmx.mgr.ProxySettings
Proxy host

I

init(LogURL, String) - Method in class com.lightysoft.logmx.mgr.LogFileManager
Called by LogMX to initialize the Manager for the specified resource.
This method should not try to open any resource yet, but should only save URL parameters for further use (resources may be opened later in LogFileManager.prepareForReading()).
isEmitterFieldProvided() - Method in class com.lightysoft.logmx.mgr.LogFileParser
Called by LogMX to detect invalid/incomplete log entries and to decide whether emitters tree shall be displayed.
If this method returns true: If this Parser produces an entry without any Emitter (i.e.
isLevelFieldProvided() - Method in class com.lightysoft.logmx.mgr.LogFileParser
Called by LogMX to detect invalid/incomplete log entries: if this method returns true but this Parser produces an entry without any Level (i.e.
isLiveStream() - Method in class com.lightysoft.logmx.mgr.LogFileManager
Called by LogMX to know if this Manager reads log entries from a live stream (e.g.
isLiveStream() - Method in class com.lightysoft.logmx.mgr.LogStreamManager
Method overriding parent method LogFileManager.isLiveStream() to always return true
isOptional() - Method in class com.lightysoft.logmx.business.LogURLParameter
Getter for attribute optional
isUsedForConnection() - Method in class com.lightysoft.logmx.business.LogURLParameter
Getter for attribute usedForConnection

L

lineText - Variable in class com.lightysoft.logmx.mgr.AutoRefreshLineInfo
Line text (null if no more text to read from underlying resource)
LogEntriesInfoProvider - Class in com.lightysoft.logmx.mgr
Instances of this class provide extra information on log entries extracted by a LogFileManager that supports entries extraction (see LogFileManager.supportLogEntriesExtraction()).

Since log entries extraction (performed by a Manager) doesn't involve any Log Parser, LogMX needs a way to handle some log entries specific information like date format, or user-defined fields (information usually handled by the LogFileParser that parses the log text).
This is why this abstract class extends LogFileParser, providing a stub for features irrelevant to entries extraction (like parsing a line of text).
LogEntriesInfoProvider() - Constructor for class com.lightysoft.logmx.mgr.LogEntriesInfoProvider
 
LogFileInfo - Class in com.lightysoft.logmx.mgr
Provide basic information on a log file: file size and file date
LogFileInfo() - Constructor for class com.lightysoft.logmx.mgr.LogFileInfo
Default constructor (file size/date set to unknown)
LogFileInfo(long, long) - Constructor for class com.lightysoft.logmx.mgr.LogFileInfo
Constructor with a file size and date
LogFileManager - Class in com.lightysoft.logmx.mgr
Abstract class that each LogMX Manager must extend.
LogFileManager() - Constructor for class com.lightysoft.logmx.mgr.LogFileManager
Default constructor.
Managers should not override it.
LogFileParser - Class in com.lightysoft.logmx.mgr
Abstract class that each LogMX Parser must extend.
A LogMX Parser gets lines of text as input (LogFileParser.parseLine(String)), and shall parse these lines into log entries (LogFileParser.addEntry(ParsedEntry)).

This class contains abstract methods to be implemented by Parsers, and final methods to be called by parsers.
LogFileParser() - Constructor for class com.lightysoft.logmx.mgr.LogFileParser
Default constructor.
Parsers don't have to override this constructor.
login - Variable in class com.lightysoft.logmx.mgr.ProxySettings
Proxy login
LogMXAPIUtils - Class in com.lightysoft.logmx.api
Utility class for using LogMX API.
LogMXAPIUtils() - Constructor for class com.lightysoft.logmx.api.LogMXAPIUtils
 
LogStreamManager - Class in com.lightysoft.logmx.mgr
This class describes a LogFileManager that reads logs from a live stream.
LogStreamManager() - Constructor for class com.lightysoft.logmx.mgr.LogStreamManager
 
LogURL - Class in com.lightysoft.logmx.business
Locates a resource to open by a LogFileManager.

A LogURL contains LogURLParameter's storing URL information (e.g.
LogURL() - Constructor for class com.lightysoft.logmx.business.LogURL
Create a LogURL containing no parameter
LogURLParameter - Class in com.lightysoft.logmx.business
Defines a parameter that will be sent to a LogFileManager in order to locate the resource to open.
A LogURLParameter defines a part of a LogURL.

For example, an LogURLParameter could be a login: its name will be "login" and its value (set by the LogMX user via the GUI) could be "john".
LogURLParameter(String, LogURLParameterType) - Constructor for class com.lightysoft.logmx.business.LogURLParameter
Construct a mandatory LogURLParameter with its name and type and no default value
LogURLParameter(String, LogURLParameterType, Object) - Constructor for class com.lightysoft.logmx.business.LogURLParameter
Construct a mandatory LogURLParameter with its name, type, and default value
LogURLParameter(String, LogURLParameterType, Object, boolean) - Constructor for class com.lightysoft.logmx.business.LogURLParameter
Construct an optional or mandatory LogURLParameter with its name, type, and default value
LogURLParameter(String, LogURLParameterType, Object, boolean, Object[]) - Constructor for class com.lightysoft.logmx.business.LogURLParameter
Construct an optional or mandatory LogURLParameter with its name, type, default value, and possible values
LogURLParameterType - Enum in com.lightysoft.logmx.business
A LogURLParameterType defines the type of data contained in a LogURLParameter.

Parameter types are used by LogMX to render the "Open log file" dialog and to check LogURL parameters validity.

M

ManagerSpecVersion - Class in com.lightysoft.logmx.mgr
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.

N

newEncodingDetected() - Method in class com.lightysoft.logmx.mgr.LogFileManager
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().

P

ParsedEntry - Class in com.lightysoft.logmx.business
This class is used to store information for each log entry found by a parser in a log file.
ParsedEntry() - Constructor for class com.lightysoft.logmx.business.ParsedEntry
Internal constructor, parsers should NOT use this constructor but LogFileParser.createNewEntry() instead.
parseLine(String) - Method in class com.lightysoft.logmx.mgr.LogEntriesInfoProvider
This implementation does nothing, its purpose it to avoid implementations of this class to have to implement this method.
parseLine(String) - Method in class com.lightysoft.logmx.mgr.LogFileParser
Called by LogMX each time a new line is read from the underlying media by the LogFileManager (eg: a line is read from a local file).
LogFileManager contract implies this line contains no line terminator (\n or \r).
All Parsers must implement this method and process all lines given by this method.
passwd - Variable in class com.lightysoft.logmx.mgr.ProxySettings
Proxy password
port - Variable in class com.lightysoft.logmx.mgr.ProxySettings
Proxy port
prepareForReading() - Method in class com.lightysoft.logmx.mgr.LogFileManager
Called by LogMX to open the resource previously specified by LogFileManager.init(LogURL, String) to get ready to read this underlying resource, and return information on this resource (size and date).
If the Manager is not able to get the number of bytes to read, it can return a negative number.
ProxySettings - Class in com.lightysoft.logmx.mgr
Simple object describing proxy settings
ProxySettings() - Constructor for class com.lightysoft.logmx.mgr.ProxySettings
Default constructor
ProxySettings(boolean, String, int, boolean, String, String) - Constructor for class com.lightysoft.logmx.mgr.ProxySettings
Constructs a proxy settings object, with given information

R

READ_MUTEX - Variable in class com.lightysoft.logmx.mgr.LogFileManager
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.
readEntry() - Method in class com.lightysoft.logmx.mgr.LogFileManager
Called by LogMX to request the Manager to extract the next log entry.

This default implementation always returns null.

LogMX will call this method only if Manager returned true in LogFileManager.supportLogEntriesExtraction().
readFileHeader(int) - Method in class com.lightysoft.logmx.mgr.LogFileManager
Called by LogMX to read the first pNbBytes bytes from the underlying file or resource.
Only Managers supporting Auto Refresh must implement this method, others should return null.
readFileHeader(int) - Method in class com.lightysoft.logmx.mgr.LogStreamManager
Method overriding parent method LogFileManager.readFileHeader(int) to always throw UnsupportedOperationException
readLine() - Method in class com.lightysoft.logmx.mgr.LogFileManager
Called by LogMX to get the next line of text from the underlying Manager resource (file, stream, socket,...).
Manager must return null if there is no more byte to read.
readLineAtOffset(long) - Method in class com.lightysoft.logmx.mgr.LogFileManager
Called by LogMX to read the line of text starting at the specified offset.
Only Managers supporting Auto Refresh must implement this method, others should return null.
readLineAtOffset(long) - Method in class com.lightysoft.logmx.mgr.LogStreamManager
Method overriding parent method LogFileManager.readLineAtOffset(long) to always throw UnsupportedOperationException
releaseResources(boolean) - Method in class com.lightysoft.logmx.mgr.LogFileManager
Called by LogMX when it doesn't need to use this Manager anymore.
This method should release all resources allocated by this Manager (e.g.
removeLastEntry() - Method in class com.lightysoft.logmx.mgr.LogFileParser
Called by the Parser to remove the last entry previously added using LogFileParser.addEntry(ParsedEntry).
Calling this method when no entry was added has no effect.
removeParameter(String) - Method in class com.lightysoft.logmx.business.LogURL
Remove the Parameter named pParamName.

S

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
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
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.
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
setPasswd(String) - Method in class com.lightysoft.logmx.mgr.ProxySettings
Setter for attribute passwd
setPort(int) - Method in class com.lightysoft.logmx.mgr.ProxySettings
Setter for attribute port
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
setUsedForConnection(boolean) - Method in class com.lightysoft.logmx.business.LogURLParameter
Setter for attribute usedForConnection
setUseLogin(boolean) - Method in class com.lightysoft.logmx.mgr.ProxySettings
Setter for attribute useLogin
setUseProxy(boolean) - Method in class com.lightysoft.logmx.mgr.ProxySettings
Setter for attribute useProxy
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
supportFileDelete() - Method in class com.lightysoft.logmx.mgr.LogFileManager
Called by LogMX to know if this Manager can delete (i.e.
supportFileDelete() - Method in class com.lightysoft.logmx.mgr.LogStreamManager
Method overriding parent method LogFileManager.supportFileDelete() to always return false
supportFileFlush() - Method in class com.lightysoft.logmx.mgr.LogFileManager
Called by LogMX to know if this Manager can flush (i.e.
supportFileFlush() - Method in class com.lightysoft.logmx.mgr.LogStreamManager
Method overriding parent method LogFileManager.supportFileFlush() to always return true
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).
Used for Auto Refresh and Auto detect encoding features.
supportHeaderReading() - Method in class com.lightysoft.logmx.mgr.LogStreamManager
Method overriding parent method LogFileManager.supportHeaderReading() to always return false
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).
Used for Auto Refresh feature only.
supportRandomAccess() - Method in class com.lightysoft.logmx.mgr.LogStreamManager
Method overriding parent method LogFileManager.supportRandomAccess() to always return false

T

toString() - Method in enum com.lightysoft.logmx.business.LogURLParameterType
Returns the name of this Type
toString() - Method in class com.lightysoft.logmx.mgr.ManagerSpecVersion
toString() - Method in class com.lightysoft.logmx.mgr.ProxySettings
Returns a String representation of this object

U

useLogin - Variable in class com.lightysoft.logmx.mgr.ProxySettings
Flag to indicate if a login/password authentication shall be used
useLogin() - Method in class com.lightysoft.logmx.mgr.ProxySettings
Getter for attribute useLogin
useProxy - Variable in class com.lightysoft.logmx.mgr.ProxySettings
Flag to indicate if a Proxy shall be used
useProxy() - Method in class com.lightysoft.logmx.mgr.ProxySettings
Getter for attribute useProxy

V

V1_0 - Static variable in class com.lightysoft.logmx.mgr.ManagerSpecVersion
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 - Static variable in class com.lightysoft.logmx.mgr.ManagerSpecVersion
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 - Static variable in class com.lightysoft.logmx.mgr.ManagerSpecVersion
Manager Specification v1.2 (supported since LogMX v5.2.0, see this class Javadoc for details)
valueOf(String) - Static method in enum com.lightysoft.logmx.business.LogURLParameterType
Returns the enum constant of this type with the specified name.
values() - Static method in enum com.lightysoft.logmx.business.LogURLParameterType
Returns an array containing the constants of this enum type, in the order they are declared.
A C D E F G H I L M N P R S T U V 
LogMX
The universal log analyzer
www.logmx.com

Copyright © 2017 LightySoft. All rights reserved. [LogMX v6.0.0 (February 7, 2017)]