org.apache.jetspeed.services.portletstats
Interface PortletStatsService

All Superinterfaces:

org.apache.turbine.services.Initable, org.apache.turbine.services.Service

All Known Implementing Classes:

JetspeedPortletStatsService

public interface PortletStatsService

extends org.apache.turbine.services.Service

This service is responsible for logging access to portlets.

Version:

$Id: PortletStatsService.java,v 1.3 2004/02/23 03:36:27 jford Exp $

Author:

Mark Orciuch

Field Summary

static java.lang.String

SERVICE_NAME The default control to use when none is specified

Method Summary

boolean	isEnabled() Returns sevice enabled state
void	logAccess(org.apache.turbine.util.RunData data, Portlet portlet, java.lang.String statusCode) Logs portlet access using default load time.
void	logAccess(org.apache.turbine.util.RunData data, Portlet portlet, java.lang.String statusCode, long time) Logs portlet access.
boolean	setEnabled(boolean state) Sets service enabled state

Methods inherited from interface org.apache.turbine.services.Service

getConfiguration, getName, getProperties, setName, setServiceBroker

Methods inherited from interface org.apache.turbine.services.Initable

getInit, init, init, setInitableBroker, shutdown

Field Detail

SERVICE_NAME

public static final java.lang.String SERVICE_NAME

The default control to use when none is specified

See Also:

Constant Field Values

Method Detail

isEnabled

public boolean isEnabled()

Returns sevice enabled state

Returns:

true if service is enabled

setEnabled

public boolean setEnabled(boolean state)

Sets service enabled state

Parameters:

state - new state

Returns:

original service enabled state

logAccess

public void logAccess(org.apache.turbine.util.RunData data,
                      Portlet portlet,
                      java.lang.String statusCode)

Logs portlet access using default load time.

Parameters:

data - Current request info object

portlet - Portlet being logged

statusCode - HTTP status code. For now, either 200 (successfull) or 401 (unauthorized)

logAccess

public void logAccess(org.apache.turbine.util.RunData data,
                      Portlet portlet,
                      java.lang.String statusCode,
                      long time)

Logs portlet access.

Parameters:

data - Current request info object

portlet - Portlet being logged

statusCode - HTTP status code. For now, either 200 (successfull) or 401 (unauthorized)