de.innovationgate.wgpublisher.log

Class AppLog

java.lang.Object

de.innovationgate.wgpublisher.log.AppLog

All Implemented Interfaces:

WGAAwareService

public class AppLog
extends java.lang.Object
implements WGAAwareService

OpenWGA application log retrieval service

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AppLog.Message An applog message.
static class	AppLog.Page A page of applog content

Field Summary

Fields

Modifier and Type	Field and Description
static int	SEARCHTYPE_PLAINTEXT Search type which searches for the given string as plaintext
static int	SEARCHTYPE_REGEXP Searchtype which searches for the given string as regular expression, matching a single applog line.

Constructor Summary

Constructors

Constructor and Description
AppLog()

Method Summary

Methods

Modifier and Type	Method and Description
int	getLinesCount() Returns the current number of lines in the applog
AppLog.Page	getPage(int offset, int size) Retrieves a page of applog content, containing messages of all log levels
AppLog.Page	getPage(int offset, int size, de.innovationgate.wga.common.LogLevel loglevel) Retrieves a page of applog content
void	injectWGA(WGA wga) Callback method by which the WGA object is injected
int	search(int searchStartLine, java.lang.String searchString, int searchType, boolean forward) Searches the applog for a term or via regular expression
int	searchTime(java.util.Date time) Searches for the earliest message whose log time is equal or later than the given time
AppLog.Page	writePage(int offset, int size, java.io.Writer out, de.innovationgate.wga.common.LogLevel loglevel, boolean lineNumbers) Writes the content of an applog page to a writer.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

SEARCHTYPE_PLAINTEXT

public static final int SEARCHTYPE_PLAINTEXT

Search type which searches for the given string as plaintext

See Also:

Constant Field Values

SEARCHTYPE_REGEXP

public static final int SEARCHTYPE_REGEXP

Searchtype which searches for the given string as regular expression, matching a single applog line.

See Also:

Constant Field Values

Constructor Detail

AppLog

public AppLog()

Method Detail

getPage

public AppLog.Page getPage(int offset,
                  int size,
                  de.innovationgate.wga.common.LogLevel loglevel)

Retrieves a page of applog content

Parameters:

offset - The offset of the first line to retrieve, 1 being the first line in the applog

size - The number of messages to retrieve

loglevel - The minimum log level of messages to retrieve

Returns:

The applog page

getPage

public AppLog.Page getPage(int offset,
                  int size)

Retrieves a page of applog content, containing messages of all log levels

Parameters:

offset - The offset of the first line to retrieve, 1 being the first line in the applog

size - The number of messages to retrieve

Returns:

The applog page

searchTime

public int searchTime(java.util.Date time)

Searches for the earliest message whose log time is equal or later than the given time

Parameters:

time - The log time to search

Returns:

The line number of the message of that time, or -1 if it was not found

writePage

public AppLog.Page writePage(int offset,
                    int size,
                    java.io.Writer out,
                    de.innovationgate.wga.common.LogLevel loglevel,
                    boolean lineNumbers)

Writes the content of an applog page to a writer. Returns the data of the retrieved page as AppLog.Page object. Note that this object does not contain the page content.

Parameters:

offset - The offset of the first line to retrieve, 0 being the first line in the applog

size - The number of messages to retrieve

out - The writer to write log content to

loglevel - The minimum log level of messages to retrieve

lineNumbers - If true all written log lines will be prefixed with line numbers

Returns:

The applog page

getLinesCount

public int getLinesCount()

Returns the current number of lines in the applog

injectWGA

public void injectWGA(WGA wga)

Description copied from interface: WGAAwareService

Callback method by which the WGA object is injected

Specified by:

injectWGA in interface WGAAwareService

Parameters:

wga - The object used to instantiate the service via WGA.service(Class)

search

public int search(int searchStartLine,
         java.lang.String searchString,
         int searchType,
         boolean forward)
           throws java.io.IOException

Searches the applog for a term or via regular expression

Parameters:

searchStartLine - The number of the line where to start search

searchString - The term or regular expression to search for

searchType - Type of the search, either SEARCHTYPE_PLAINTEXT or SEARCHTYPE_REGEXP

forward - true to search forward from the starting line, false to search backward

Returns:

The line number where the term was found/regexp matched first. -1 if it was not found

Throws:

java.io.IOException