uPortal 2.4.1
API Documentation

org.jasig.portal.services.stats
Class StatsRecorderSettings

java.lang.Object
  extended byorg.jasig.portal.services.stats.StatsRecorderSettings

public class StatsRecorderSettings
extends java.lang.Object

This class is responsible for maintaining the on/off settings for each type of portal event that the StatsRecorder can record. StatsRecorder will consult with this class before it attempts to record an event. The initial values for each setting will be read upon portal startup from portal.properties. At runtime, the settings in this class can be controlled via StatsRecorder.set().

Version:
$Revision: 1.7.2.1 $
Author:
Ken Weiner, kweiner@unicon.net

Field Summary
static int RECORD_CHANNEL_ADDED_TO_LAYOUT
           
static int RECORD_CHANNEL_DEFINITION_MODIFIED
           
static int RECORD_CHANNEL_DEFINITION_PUBLISHED
           
static int RECORD_CHANNEL_DEFINITION_REMOVED
           
static int RECORD_CHANNEL_INSTANTIATED
           
static int RECORD_CHANNEL_MOVED_IN_LAYOUT
           
static int RECORD_CHANNEL_REMOVED_FROM_LAYOUT
           
static int RECORD_CHANNEL_RENDERED
           
static int RECORD_CHANNEL_TARGETED
           
static int RECORD_CHANNEL_UPDATED_IN_LAYOUT
           
static int RECORD_FOLDER_ADDED_TO_LAYOUT
           
static int RECORD_FOLDER_MOVED_IN_LAYOUT
           
static int RECORD_FOLDER_REMOVED_FROM_LAYOUT
           
static int RECORD_FOLDER_UPDATED_IN_LAYOUT
           
static int RECORD_LOGIN
           
static int RECORD_LOGOUT
           
static int RECORD_SESSION_CREATED
           
static int RECORD_SESSION_DESTROYED
           
 
Method Summary
 boolean get(int setting)
          Get the value of a particular setting.
static StatsRecorderSettings instance()
          Creates an instance of StatsRecorderSettings.
 void set(int setting, boolean newValue)
          Set the value of a particular setting.
 java.lang.String toString()
          Returns a String representation of this object.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

RECORD_LOGIN

public static final int RECORD_LOGIN
See Also:
Constant Field Values

RECORD_LOGOUT

public static final int RECORD_LOGOUT
See Also:
Constant Field Values

RECORD_SESSION_CREATED

public static final int RECORD_SESSION_CREATED
See Also:
Constant Field Values

RECORD_SESSION_DESTROYED

public static final int RECORD_SESSION_DESTROYED
See Also:
Constant Field Values

RECORD_CHANNEL_DEFINITION_PUBLISHED

public static final int RECORD_CHANNEL_DEFINITION_PUBLISHED
See Also:
Constant Field Values

RECORD_CHANNEL_DEFINITION_MODIFIED

public static final int RECORD_CHANNEL_DEFINITION_MODIFIED
See Also:
Constant Field Values

RECORD_CHANNEL_DEFINITION_REMOVED

public static final int RECORD_CHANNEL_DEFINITION_REMOVED
See Also:
Constant Field Values

RECORD_CHANNEL_ADDED_TO_LAYOUT

public static final int RECORD_CHANNEL_ADDED_TO_LAYOUT
See Also:
Constant Field Values

RECORD_CHANNEL_UPDATED_IN_LAYOUT

public static final int RECORD_CHANNEL_UPDATED_IN_LAYOUT
See Also:
Constant Field Values

RECORD_CHANNEL_MOVED_IN_LAYOUT

public static final int RECORD_CHANNEL_MOVED_IN_LAYOUT
See Also:
Constant Field Values

RECORD_CHANNEL_REMOVED_FROM_LAYOUT

public static final int RECORD_CHANNEL_REMOVED_FROM_LAYOUT
See Also:
Constant Field Values

RECORD_FOLDER_ADDED_TO_LAYOUT

public static final int RECORD_FOLDER_ADDED_TO_LAYOUT
See Also:
Constant Field Values

RECORD_FOLDER_UPDATED_IN_LAYOUT

public static final int RECORD_FOLDER_UPDATED_IN_LAYOUT
See Also:
Constant Field Values

RECORD_FOLDER_MOVED_IN_LAYOUT

public static final int RECORD_FOLDER_MOVED_IN_LAYOUT
See Also:
Constant Field Values

RECORD_FOLDER_REMOVED_FROM_LAYOUT

public static final int RECORD_FOLDER_REMOVED_FROM_LAYOUT
See Also:
Constant Field Values

RECORD_CHANNEL_INSTANTIATED

public static final int RECORD_CHANNEL_INSTANTIATED
See Also:
Constant Field Values

RECORD_CHANNEL_RENDERED

public static final int RECORD_CHANNEL_RENDERED
See Also:
Constant Field Values

RECORD_CHANNEL_TARGETED

public static final int RECORD_CHANNEL_TARGETED
See Also:
Constant Field Values
Method Detail

instance

public static final StatsRecorderSettings instance()
Creates an instance of StatsRecorderSettings.

Returns:
settingsInstance, a StatsRecorderSettings instance

get

public boolean get(int setting)
Get the value of a particular setting.

Parameters:
setting - the setting
Returns:
value the value for the setting

set

public void set(int setting,
                boolean newValue)
Set the value of a particular setting.

Parameters:
setting - the setting to change
newValue - the new value for the setting

toString

public java.lang.String toString()
Returns a String representation of this object.

Returns:
the settings as a String

uPortal 2.4.1
API Documentation