A C D E F G I L M N P R S T V

A

addEntry(ParsedEntry) - Method in class com.lightysoft.logmx.mgr.LogFileParser

Called by the Parser for each entry it has successfully parsed.

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.

D

deleteFile() - Method in class com.lightysoft.logmx.mgr.LogFileManager

Called by LogMX to delete (i.e. remove from disk) the current file.

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. empty) the current file.

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.

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.

getCurrentOffset() - Method in class com.lightysoft.logmx.mgr.LogFileManager

Called by LogMX to know the current position in file.

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

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.

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.

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.

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.

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).

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.

getOpenedFilesLogManagers() - Static method in class com.lightysoft.logmx.api.LogMXAPIUtils

Returns a map of opened files in LogMX GUI, with their Log Manager.

getOpenedFilesLogParsers() - Static method in class com.lightysoft.logmx.api.LogMXAPIUtils

Returns a map of opened files in LogMX GUI, with their Log Parser.

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.

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.

getParserName() - Method in class com.lightysoft.logmx.mgr.LogFileParser

Called by LogMX to get the name of this Parser.

getProtocolName() - Method in class com.lightysoft.logmx.mgr.LogFileManager

Called by LogMX to get the Protocol handled by this Manager.

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.

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.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

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 entry user-defined fields stored by parser, given by their name (e.g. line in source file, relative timestamp, ... or anything else)

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.

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

I

init(LogURL, String) - Method in class com.lightysoft.logmx.mgr.LogFileManager

Called by LogMX to initialize the Manager for the specified resource.

isOptional() - Method in class com.lightysoft.logmx.business.LogURLParameter

Getter for attribute optional

L

lineText - Variable in class com.lightysoft.logmx.mgr.AutoRefreshLineInfo

Line text (null if no more text to read from underlying resource)

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.

LogFileParser - Class in com.lightysoft.logmx.mgr

Abstract class that each LogMX Parser must extend.

LogFileParser() - Constructor for class com.lightysoft.logmx.mgr.LogFileParser

Default constructor.

LogMXAPIUtils - Class in com.lightysoft.logmx.api

Utility class for using LogMX API.

LogMXAPIUtils() - Constructor for class com.lightysoft.logmx.api.LogMXAPIUtils

LogURL - Class in com.lightysoft.logmx.business

Locates a resource to open by a LogFileManager.

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.

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

LogURLParameterType - Enum in com.lightysoft.logmx.business

A LogURLParameterType defines the type of data contained in a LogURLParameter.

M

ManagerSpecVersion - Class in com.lightysoft.logmx.mgr

Defines LogMX Manager Specifications versions.

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.

P

ParsedEntry - Class in com.lightysoft.logmx.business

This class is used to store information on each '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.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).

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).

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.

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.

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,...).

readLineAtOffset(long) - Method in class com.lightysoft.logmx.mgr.LogFileManager

Called by LogMX to read the line of text starting at the specified offset.

releaseResources(boolean) - Method in class com.lightysoft.logmx.mgr.LogFileManager

Called by LogMX when it doesn't need to use this Manager anymore.

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

setLevel(String) - Method in class com.lightysoft.logmx.business.ParsedEntry

Set entry Level found by parser in file

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

setThread(String) - Method in class com.lightysoft.logmx.business.ParsedEntry

Set entry Thread found by parser in file

setUserDefinedFields(Map<String, Object>) - Method in class com.lightysoft.logmx.business.ParsedEntry

Set entry user-defined fields stored by parser, given by their name (e.g. line in source file, relative timestamp, ... or anything else)

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 Manger can delete (i.e. remove from disk) the current file.

supportFileFlush() - Method in class com.lightysoft.logmx.mgr.LogFileManager

Called by LogMX to know if this Manger can flush (i.e. empty) the current file.

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).

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).

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

Returns getVersion()

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

Manager Specification v1.1 (supported since LogMX v1.2.4, 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 I L M N P R S T V