|
uPortal 2.4.1 API Documentation |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.jasig.portal.services.StatsRecorder
Stats recorder service. Various parts of the portal call the methods in this service to record events such as when a user logs in, logs out, and subscribes to a channel. The information is handed off in a separate thread to an IStatsRecorder implementation that is determined by the IStatsRecorderFactory implementation that can be configured in portal.properties.
Method Summary | |
static boolean |
get(int setting)
Gets the value of a particular stats recorder setting. |
static StatsRecorderLayoutEventListener |
newLayoutEventListener(IPerson person,
UserProfile profile)
Creates an instance of a StatsRecorderLayoutEventListener . |
static void |
recordChannelAddedToLayout(IPerson person,
UserProfile profile,
IUserLayoutChannelDescription channelDesc)
Record that a channel is being added to a user layout |
static void |
recordChannelDefinitionModified(IPerson person,
ChannelDefinition channelDef)
Record that an existing channel is being modified |
static void |
recordChannelDefinitionPublished(IPerson person,
ChannelDefinition channelDef)
Record that a new channel is being published |
static void |
recordChannelDefinitionRemoved(IPerson person,
ChannelDefinition channelDef)
Record that a channel is being removed |
static void |
recordChannelInstantiated(IPerson person,
UserProfile profile,
IUserLayoutChannelDescription channelDesc)
Record that a channel is being instantiated |
static void |
recordChannelMovedInLayout(IPerson person,
UserProfile profile,
IUserLayoutChannelDescription channelDesc)
Record that a channel is being moved in a user layout |
static void |
recordChannelRemovedFromLayout(IPerson person,
UserProfile profile,
IUserLayoutChannelDescription channelDesc)
Record that a channel is being removed from a user layout |
static void |
recordChannelRendered(IPerson person,
UserProfile profile,
IUserLayoutChannelDescription channelDesc)
Record that a channel is being rendered |
static void |
recordChannelTargeted(IPerson person,
UserProfile profile,
IUserLayoutChannelDescription channelDesc)
Record that a channel is being targeted. |
static void |
recordChannelUpdatedInLayout(IPerson person,
UserProfile profile,
IUserLayoutChannelDescription channelDesc)
Record that a channel is being updated in a user layout |
static void |
recordFolderAddedToLayout(IPerson person,
UserProfile profile,
IUserLayoutFolderDescription folderDesc)
Record that a folder is being added to a user layout |
static void |
recordFolderMovedInLayout(IPerson person,
UserProfile profile,
IUserLayoutFolderDescription folderDesc)
Record that a folder is being moved in a user layout |
static void |
recordFolderRemovedFromLayout(IPerson person,
UserProfile profile,
IUserLayoutFolderDescription folderDesc)
Record that a folder is being removed from a user layout |
static void |
recordFolderUpdatedInLayout(IPerson person,
UserProfile profile,
IUserLayoutFolderDescription folderDesc)
Record that a folder is being updated in a user layout |
static void |
recordLogin(IPerson person)
Record the successful login of a user. |
static void |
recordLogout(IPerson person)
Record the logout of a user. |
static void |
recordSessionCreated(IPerson person)
Record that a new session is created for a user. |
static void |
recordSessionDestroyed(IPerson person)
Record that a user's session is destroyed (when the user logs out or his/her session simply times out) |
static void |
set(int setting,
boolean newValue)
Sets the value of a particular stats recorder setting. |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Method Detail |
public static final StatsRecorderLayoutEventListener newLayoutEventListener(IPerson person, UserProfile profile)
StatsRecorderLayoutEventListener
.
public static boolean get(int setting)
StatsRecorderSettings
.
For example: StatsRecorder.get(StatsRecorderSettings.RECORD_LOGIN)
setting
- the setting
public static void set(int setting, boolean newValue)
StatsRecorderSettings
.
For example: StatsRecorder.set(StatsRecorderSettings.RECORD_LOGIN, true)
setting
- the setting to changenewValue
- the new value for the settingpublic static void recordLogin(IPerson person)
person
- the person who is logging inpublic static void recordLogout(IPerson person)
person
- the person who is logging outpublic static void recordSessionCreated(IPerson person)
person
- the person whose session is being createdpublic static void recordSessionDestroyed(IPerson person)
person
- the person whose session is endingpublic static void recordChannelDefinitionPublished(IPerson person, ChannelDefinition channelDef)
person
- the person publishing the channelchannelDef
- the channel being publishedpublic static void recordChannelDefinitionModified(IPerson person, ChannelDefinition channelDef)
person
- the person modifying the channelchannelDef
- the channel being modifiedpublic static void recordChannelDefinitionRemoved(IPerson person, ChannelDefinition channelDef)
person
- the person removing the channelchannelDef
- the channel being modifiedpublic static void recordChannelAddedToLayout(IPerson person, UserProfile profile, IUserLayoutChannelDescription channelDesc)
person
- the person adding the channelprofile
- the profile of the layout to which the channel is being addedchannelDesc
- the channel being subscribed topublic static void recordChannelUpdatedInLayout(IPerson person, UserProfile profile, IUserLayoutChannelDescription channelDesc)
person
- the person updating the channelprofile
- the profile of the layout in which the channel is being updatedchannelDesc
- the channel being updatedpublic static void recordChannelMovedInLayout(IPerson person, UserProfile profile, IUserLayoutChannelDescription channelDesc)
person
- the person moving the channelprofile
- the profile of the layout in which the channel is being movedchannelDesc
- the channel being movedpublic static void recordChannelRemovedFromLayout(IPerson person, UserProfile profile, IUserLayoutChannelDescription channelDesc)
person
- the person removing the channelprofile
- the profile of the layout to which the channel is being addedchannelDesc
- the channel being removed from a user layoutpublic static void recordFolderAddedToLayout(IPerson person, UserProfile profile, IUserLayoutFolderDescription folderDesc)
person
- the person adding the folderprofile
- the profile of the layout to which the folder is being addedfolderDesc
- the folder being subscribed topublic static void recordFolderUpdatedInLayout(IPerson person, UserProfile profile, IUserLayoutFolderDescription folderDesc)
person
- the person updating the folderprofile
- the profile of the layout in which the folder is being updatedfolderDesc
- the folder being updatedpublic static void recordFolderMovedInLayout(IPerson person, UserProfile profile, IUserLayoutFolderDescription folderDesc)
person
- the person moving the folderprofile
- the profile of the layout in which the folder is being movedfolderDesc
- the folder being movedpublic static void recordFolderRemovedFromLayout(IPerson person, UserProfile profile, IUserLayoutFolderDescription folderDesc)
person
- the person removing the folderprofile
- the profile of the layout to which the folder is being addedfolderDesc
- the folder being removed from a user layoutpublic static void recordChannelInstantiated(IPerson person, UserProfile profile, IUserLayoutChannelDescription channelDesc)
person
- the person for whom the channel is instantiatedprofile
- the profile of the layout for whom the channel is instantiatedchannelDesc
- the channel being instantiatedpublic static void recordChannelRendered(IPerson person, UserProfile profile, IUserLayoutChannelDescription channelDesc)
person
- the person for whom the channel is renderedprofile
- the profile of the layout for whom the channel is renderedchannelDesc
- the channel being renderedpublic static void recordChannelTargeted(IPerson person, UserProfile profile, IUserLayoutChannelDescription channelDesc)
person
- the person interacting with the channelprofile
- the profile of the layout in which the channel resideschannelDesc
- the channel being targeted
|
uPortal 2.4.1 API Documentation |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |