com.ibm.portal.services.siteanalyzer
Interface SiteAnalyzerLogger

All Known Subinterfaces:

PortletSiteAnalyzerLogger

public interface SiteAnalyzerLogger

This logger allows components to perform site analytics logging.

Since:

6.1.0.1

Method Summary

boolean	isLogging() Checks to see if site analytics logging is enabled for this logger. This method should always be called prior to making an attempt to write to the site analytics log.
void	log(java.lang.String businessEvent) If this logger is enabled for site analytics logging, this method creates a log entry in NCSA Combined format and writes it to the site analytics log file.

Method Detail

isLogging

boolean isLogging()

Checks to see if site analytics logging is enabled for this logger.
This method should always be called prior to making an attempt to write to the site analytics log.

Returns:

true if the the logger is enabled. Otherwise, false.

log

void log(java.lang.String businessEvent)

If this logger is enabled for site analytics logging, this method creates a log entry in NCSA Combined format and writes it to the site analytics log file. The given business event forms a part of the request URI section of the assembled log entry.

Parameters:

businessEvent - the event to log. May be null.