atg.userprofiling
Class ProfileEventTrigger

java.lang.Object
  atg.userprofiling.ProfileEventTrigger

public class ProfileEventTrigger
extends java.lang.Object

Contains methods for firing off various profile related session events.

Field Summary

static java.lang.String

CLASS_VERSION Class version string

Constructor Summary

ProfileEventTrigger()

Method Summary

atg.service.event.EventDistributor	getDistributor() The EventDistributor to send fired events to.
atg.userprofiling.dms.DPSMessageSource	getMessageSource() Returns property messageSource
long	getNumLoginEvents() Returns property NumLoginEvents
long	getNumLogoutEvents() Returns property NumLogoutEvents
long	getNumRegisterEvents() Returns property NumRegisterEvents
boolean	isBroadcastAdminRegisterEvents() Returns property BroadcastAdminRegisterEvents
boolean	isBroadcastLoginEvents() Returns property BroadcastLoginEvents
boolean	isBroadcastLogoutEvents() Returns property BroadcastLogoutEvents
boolean	isBroadcastRegisterEvents() Returns property BroadcastRegisterEvents
void	sendAdminRegisterEvent(RepositoryItem pAdminProfile, RepositoryItem pProfile, DynamoHttpServletRequest pRequest) Sends off an event indicating that the given user profile was registered by the given administrator profile.
void	sendLoginEvent(RepositoryItem pProfile, DynamoHttpServletRequest pRequest) Sends off a SessionEvent of type login for the given profile.
void	sendLogoutEvent(RepositoryItem pProfile, DynamoHttpServletRequest pRequest) Sends off a SessionEvent of type logout for the given profile.
void	sendLogoutEvent(java.lang.String pProfileId, DynamoHttpServletRequest pRequest) Sends off a SessionEvent of type logout for the given profile.
void	sendRegisterEvent(RepositoryItem pProfile, DynamoHttpServletRequest pRequest) Sends off a SessionEvent of type register for the given profile.
void	setBroadcastAdminRegisterEvents(boolean pBroadcastAdminRegisterEvents) Sets property BroadcastAdminRegisterEvents
void	setBroadcastLoginEvents(boolean pBroadcastLoginEvents) Sets property BroadcastLoginEvents
void	setBroadcastLogoutEvents(boolean pBroadcastLogoutEvents) Sets property BroadcastLogoutEvents
void	setBroadcastRegisterEvents(boolean pBroadcastRegisterEvents) Sets property BroadcastRegisterEvents
void	setDistributor(atg.service.event.EventDistributor pValue) The EventDistributor to send fired events to.
void	setMessageSource(atg.userprofiling.dms.DPSMessageSource pMessageSource) Sets property messageSource

Methods inherited from class java.lang.Object

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

Field Detail

CLASS_VERSION

public static java.lang.String CLASS_VERSION

Class version string

Constructor Detail

ProfileEventTrigger

public ProfileEventTrigger()

Method Detail

setDistributor

public void setDistributor(atg.service.event.EventDistributor pValue)

The EventDistributor to send fired events to.

getDistributor

public atg.service.event.EventDistributor getDistributor()

The EventDistributor to send fired events to.

getNumLoginEvents

public long getNumLoginEvents()

Returns property NumLoginEvents

getNumLogoutEvents

public long getNumLogoutEvents()

Returns property NumLogoutEvents

getNumRegisterEvents

public long getNumRegisterEvents()

Returns property NumRegisterEvents

setBroadcastLoginEvents

public void setBroadcastLoginEvents(boolean pBroadcastLoginEvents)

Sets property BroadcastLoginEvents

isBroadcastLoginEvents

public boolean isBroadcastLoginEvents()

Returns property BroadcastLoginEvents

setBroadcastLogoutEvents

public void setBroadcastLogoutEvents(boolean pBroadcastLogoutEvents)

Sets property BroadcastLogoutEvents

isBroadcastLogoutEvents

public boolean isBroadcastLogoutEvents()

Returns property BroadcastLogoutEvents

setBroadcastRegisterEvents

public void setBroadcastRegisterEvents(boolean pBroadcastRegisterEvents)

Sets property BroadcastRegisterEvents

isBroadcastRegisterEvents

public boolean isBroadcastRegisterEvents()

Returns property BroadcastRegisterEvents

setBroadcastAdminRegisterEvents

public void setBroadcastAdminRegisterEvents(boolean pBroadcastAdminRegisterEvents)

Sets property BroadcastAdminRegisterEvents

isBroadcastAdminRegisterEvents

public boolean isBroadcastAdminRegisterEvents()

Returns property BroadcastAdminRegisterEvents

setMessageSource

public void setMessageSource(atg.userprofiling.dms.DPSMessageSource pMessageSource)

Sets property messageSource

getMessageSource

public atg.userprofiling.dms.DPSMessageSource getMessageSource()

Returns property messageSource

sendLoginEvent

public void sendLoginEvent(RepositoryItem pProfile,
                           DynamoHttpServletRequest pRequest)

Sends off a SessionEvent of type login for the given profile.

sendLogoutEvent

public void sendLogoutEvent(RepositoryItem pProfile,
                            DynamoHttpServletRequest pRequest)

Sends off a SessionEvent of type logout for the given profile.

sendLogoutEvent

public void sendLogoutEvent(java.lang.String pProfileId,
                            DynamoHttpServletRequest pRequest)

Sends off a SessionEvent of type logout for the given profile.

Parameters:

pProfileId - the id of the person who has logged out

pRequest - the current request NOTE: The user may have already logged out at this point, and thus the request will not point to their profile any longer

sendRegisterEvent

public void sendRegisterEvent(RepositoryItem pProfile,
                              DynamoHttpServletRequest pRequest)

Sends off a SessionEvent of type register for the given profile.

sendAdminRegisterEvent

public void sendAdminRegisterEvent(RepositoryItem pAdminProfile,
                                   RepositoryItem pProfile,
                                   DynamoHttpServletRequest pRequest)

Sends off an event indicating that the given user profile was registered by the given administrator profile.