com.nitido.nimbox.http.services.tracking.file
Class FileTrackingService

java.lang.Object
  com.nitido.nimbox.http.services.tracking.NiMTrackingService
      com.nitido.nimbox.http.services.tracking.file.FileTrackingService

All Implemented Interfaces:

FileTrackingServiceConstants

public class FileTrackingService
extends NiMTrackingService
implements FileTrackingServiceConstants

This class implements the NiMTrackingService interface. This Tracking Service implementation logs all events into a log file using the NiM Logging Service. The configuration for this service must follow the format bellow:

• com.nitido.nimbox.http.services.tracking.file.trackinglog
  Specifies the Category name to be used by the NiM logging Service.
• com.nitido.nimbox.http.services.tracking.file.dateformat
  Specifies the date format to use when entering an entry log in the tracking file.
• com.nitido.nimbox.http.services.tracking.file.timezone
  Specifies the Timezone to use when entering a date in the tracking log.
• com.nitido.nimx.services.log.log4j.category.nitidolog.nimtracking
  Specifies the log level and the Log4j Category name. This configuration parameter is required.
• com.nitido.nimx.services.log.log4j.additivity.nitidolog.nimtracking
  Determines whether the log entries for the P2T general log will also appear on the standard out. This configuraton parameter is required.
• com.nitido.nimx.services.log.log4j.appender.NIM_TRACKING
  Defines the class name of the Log4j appender to be used for the debug log file.
• com.nitido.nimx.services.log.log4j.appender.NIM_TRACKING.File
  Defines the file name to be used for the debug log.
• com.nitido.nimx.services.log.log4j.appender.NIM_TRACKING.DatePattern
  The date pattern to be appended to the log file name when the general logs is being rotated.
• com.nitido.nimx.services.log.log4j.appender.NIM_TRACKING.layout
  The class name of the Log4j Layout to be used for the debug log file.
• com.nitido.nimx.services.log.log4j.appender.NIM_TRACKING.layout.ConversionPattern
  The format of how a log entry will be written to the log.

Field Summary

Fields inherited from interface com.nitido.nimbox.http.services.tracking.file.FileTrackingServiceConstants

ANONYMOUS_ID, CONF_KEY_TRACKING_DATE_FORMAT, CONF_KEY_TRACKING_LOG, CONF_KEY_TRACKING_TZ, DEFAULT_TRACKING_DATE_FORMAT, DEFAULT_TZ

Method Summary

static FileTrackingService	getInstance() This method returns the singleton instance of the class.
void	recordEvent(Entity entity, TrackingEvent event) This method records the given event using the NiM Logging Service.

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static FileTrackingService getInstance()

This method returns the singleton instance of the class. If an instance has not been instantiated, the instance is created, otherwise the existing instance is returned. This method can be assumed to be thread safe.

Returns:

Reference to the singleton class instance.

recordEvent

public void recordEvent(Entity entity,
                        TrackingEvent event)

This method records the given event using the NiM Logging Service.

Specified by:

recordEvent in class NiMTrackingService

Parameters:

entity - Reference to the entity making the request.

event - Reference to the event being recorded. This parameter cannot be null.

Throws:

java.lang.IllegalArgumentException - If the event parameter is null