io.hawt.log.support

Interface LogQuerySupportMBean

All Known Subinterfaces:

Log4jLogQueryMBean

All Known Implementing Classes:

Log4jLogQuery, LogQuerySupport

public interface LogQuerySupportMBean

An MBean for querying log events which has a serialized API and a simple JSON API to avoid serialization issues

Method Summary

Modifier and Type	Method and Description
LogResults	allLogResults() Returns all the available recent log events as a LogResults object which is then serialized
String	filterLogEvents(String jsonFiler) Filters the list of log events using the JSON encoding of LogFilter
String	getJavaDoc(String mavenCoordinates, String filePath) Returns the javadoc file for the given maven coordinates and filePath
String	getLogEvents(int count) Returns the recent log events as JSON
LogResults	getLogResults(int count) Returns the recent log events as a LogResults object which is then serialized
String	getSource(String mavenCoordinates, String className, String filePath) Returns the source file for the given maven coordinates so that we can link log messages to source code
LogResults	jsonQueryLogResults(String jsonFilter) Allows a JSON filter to be specified then returns the log results as a serialised object
LogResults	logResultsSince(long time) Returns all the available log events since the given timestamp (millis)
LogResults	queryLogResults(LogFilter filter) Queries the log results using the given filter

Method Detail

allLogResults

LogResults allLogResults()
                  throws IOException

Returns all the available recent log events as a LogResults object which is then serialized

Returns:

the log events as a serialized object

Throws:

IOException

logResultsSince

LogResults logResultsSince(long time)
                    throws IOException

Returns all the available log events since the given timestamp (millis)

Returns:

the log events as a serialized object

Throws:

IOException

getLogResults

LogResults getLogResults(int count)
                  throws IOException

Returns the recent log events as a LogResults object which is then serialized

Parameters:

count - maximum number to return o <0 for all of them

Returns:

the log events as a serialized object

Throws:

IOException

queryLogResults

LogResults queryLogResults(LogFilter filter)

Queries the log results using the given filter

Parameters:

filter - the filter to apply to the logs

Returns:

the log events as a serialized object

getSource

String getSource(String mavenCoordinates,
                 String className,
                 String filePath)
          throws IOException

Returns the source file for the given maven coordinates so that we can link log messages to source code

Parameters:

mavenCoordinates - is a string of the form "groupId:artifactId:version". For some uber bundles this can be a space separated list.

Throws:

IOException

getJavaDoc

String getJavaDoc(String mavenCoordinates,
                  String filePath)
           throws IOException

Returns the javadoc file for the given maven coordinates and filePath

Parameters:

mavenCoordinates - is a string of the form "groupId:artifactId:version". For some uber bundles this can be a space separated list.

Throws:

IOException

getLogEvents

String getLogEvents(int count)
             throws IOException

Returns the recent log events as JSON

Parameters:

count - maximum number to return o <0 for all of them

Returns:

the log events as a blob of JSON using LogEvent

Throws:

IOException

filterLogEvents

String filterLogEvents(String jsonFiler)
                throws IOException

Filters the list of log events using the JSON encoding of LogFilter

Returns:

the log events as a blob of JSON using LogEvent

Throws:

IOException

jsonQueryLogResults

LogResults jsonQueryLogResults(String jsonFilter)
                        throws IOException

Allows a JSON filter to be specified then returns the log results as a serialised object

Throws:

IOException