org.apache.wicket.protocol.http

Interface IRequestLogger

All Known Implementing Classes:

AbstractRequestLogger, JsonRequestLogger, RequestLogger

public interface IRequestLogger

Interface for the request logger and viewer.

Author:

jcompagner

See Also:

Application.newRequestLogger()

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	IRequestLogger.ISessionLogInfo This interface can be implemented in a custom session object.
static class	IRequestLogger.RequestData This class hold the information one request of a session has.
static class	IRequestLogger.SessionData This class hold the information one request of a session has.

Method Summary

Methods

Modifier and Type	Method and Description
long	getAverageRequestTime()
int	getCurrentActiveRequestCount()
IRequestLogger.RequestData	getCurrentRequest()
IRequestLogger.SessionData[]	getLiveSessions()
int	getPeakActiveRequestCount()
int	getPeakSessions()
List<IRequestLogger.RequestData>	getRequests() This method returns a List of the current requests that are in mem.
long	getRequestsPerMinute()
int	getTotalCreatedSessions()
void	logEventTarget(IRequestHandler target) Sets the target that was the event target for the current request
void	logRequestedUrl(String url) Logs the URL that was requested by the browser.
void	logResponseTarget(IRequestHandler target) Sets the target that was the response target for the current request
void	objectCreated(Object value) Called to monitor additions of objects in the ISessionStore
void	objectRemoved(Object value) Called to monitor removals of objects out of the ISessionStore
void	objectUpdated(Object value) Called to monitor updates of objects in the ISessionStore
void	performLogging() Perform the actual logging
void	requestTime(long timeTaken) This method is called when the request is over.
void	sessionCreated(String id) called when the session is created and has an id.
void	sessionDestroyed(String sessionId) Method used to cleanup a livesession when the session was invalidated by the webcontainer

Method Detail

getTotalCreatedSessions

int getTotalCreatedSessions()

Returns:

The total created sessions counter

getPeakSessions

int getPeakSessions()

Returns:

The peak sessions counter

getRequests

List<IRequestLogger.RequestData> getRequests()

This method returns a List of the current requests that are in mem. This is a readonly list.

Returns:

Collection of the current requests

getLiveSessions

IRequestLogger.SessionData[] getLiveSessions()

Returns:

Collection of live Sessions Data

getCurrentActiveRequestCount

int getCurrentActiveRequestCount()

Returns:

The current active requests

getCurrentRequest

IRequestLogger.RequestData getCurrentRequest()

Returns:

The IRequestLogger.RequestData for the current request.

getPeakActiveRequestCount

int getPeakActiveRequestCount()

Returns:

The peak active requests

getRequestsPerMinute

long getRequestsPerMinute()

Returns:

The number of requests per minute.

getAverageRequestTime

long getAverageRequestTime()

Returns:

The average request time.

sessionCreated

void sessionCreated(String id)

called when the session is created and has an id. (for http it means that the http session is created)

Parameters:

id - the session id

sessionDestroyed

void sessionDestroyed(String sessionId)

Method used to cleanup a livesession when the session was invalidated by the webcontainer

Parameters:

sessionId - the session id

requestTime

void requestTime(long timeTaken)

This method is called when the request is over. This will set the total time a request takes and cleans up the current request data.

Parameters:

timeTaken - the time taken in milliseconds

objectRemoved

void objectRemoved(Object value)

Called to monitor removals of objects out of the ISessionStore

Parameters:

value - the object being removed

objectUpdated

void objectUpdated(Object value)

Called to monitor updates of objects in the ISessionStore

Parameters:

value - the object being updated

objectCreated

void objectCreated(Object value)

Called to monitor additions of objects in the ISessionStore

Parameters:

value - the object being created/added

logResponseTarget

void logResponseTarget(IRequestHandler target)

Sets the target that was the response target for the current request

Parameters:

target - the response target

logEventTarget

void logEventTarget(IRequestHandler target)

Sets the target that was the event target for the current request

Parameters:

target - the event target

logRequestedUrl

void logRequestedUrl(String url)

Logs the URL that was requested by the browser.

Parameters:

url - the requested URL

performLogging

void performLogging()

Perform the actual logging