ninja

Class APILog

java.lang.Object

ninja.APILog

public class APILog
extends Object

Contains a log of the latest API calls

The entries are stored in memory and will be lost during server restarts. Also the site is limited to 250 entries. The newest entry will be the first in the list.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	APILog.Entry Represents a log entry.
static class	APILog.Result Used to describe if a call was successful or why if failed.

Constructor Summary

Constructors

Constructor and Description
APILog()

Method Summary

Modifier and Type	Method and Description
List<APILog.Entry>	getEntries(int start, int count) Returns a sublist of the stored entries, starting at start returning at most count items.
void	log(String function, String description, APILog.Result result, Watch watch) Creates a new log entry.

Methods inherited from class java.lang.Object

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

Constructor Detail

APILog

public APILog()

Method Detail

getEntries

public List<APILog.Entry> getEntries(int start,
                                     int count)

Returns a sublist of the stored entries, starting at start returning at most count items.

Parameters:

start - index of the item where to start

count - max number of items returned

Returns:

a non null list of log entries

log

public void log(String function,
                String description,
                APILog.Result result,
                Watch watch)

Creates a new log entry.

Parameters:

function - name or method of the function which was invoked

description - description of the call

result - outcome of the call

watch - watch representing the duration of the call