Overview | Package | Class | Tree | Deprecated | Index | Help
| Copyright © 2008 BEA Systems, Inc. All Rights Reserved
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## com.bea.p13n.tracking
Class TrackingEventHelper

    java.lang.Object
      com.bea.p13n.tracking.TrackingEventHelper

    public class TrackingEventHelper

extends Object

Helper methods for dispatching Behavior Tracking events to the Event Service.

Constructor Summary
`TrackingEventHelper()`

Method Summary
`static void` | `dispatchEvent(Event theEvent)` Deprecated Use EventService.dispatchEvent(Event theEvent).
`static void` | `dispatchEvent(EventService eventService, Event evt)` Fire the event, passing in the reference of the EventService EJB.
`static void` | `dispatchEvent(javax.servlet.http.HttpServletRequest theRequest, Event theEvent)` Dispatch an event using an EventService that is cached in theRequest.
`static void` | `dispatchSessionLoginEvent(javax.servlet.http.HttpServletRequest theRequest)` Utility method to dispatch a SessionLoginEvent for the user logged into the given servlet request, if it hasn't been done already.
`static void` | `dispatchSessionLoginEvent(javax.servlet.http.HttpServletRequest theRequest, String userId)` Utility method to dispatch a SessionLoginEvent for the specified userId, if it hasn't been done already.
`static void` | `dispatchSessionLoginEvent(javax.servlet.http.HttpSession session, String userId)` Utility method to dispatch a SessionLoginEvent for the user logged into the given servlet request, if it hasn't been done already.
`static void` | `dispatchUserRegistrationEvent(javax.servlet.http.HttpServletRequest request)` Utility method to dispatch a UserRegistrationEvent for the user logged into the given servlet request, if it hasn't been done already.
`static void` | `dispatchUserRegistrationEvent(javax.servlet.http.HttpServletRequest request, String newUserId)` Utility method to dispatch a UserRegistrationEvent for the specified user, if it hasn't been done already.
`static void` | `dispatchUserRegistrationEvent(javax.servlet.http.HttpServletRequest request, String newUserId, UserRegistrationEvent evt)` Utility method to dispatch a UserRegistrationEvent for the specified user, if it hasn't been done already.
`static EventService` | `getEventService()` Get an instance of the EventService EJB.
`static EventService` | `getEventService(javax.servlet.http.HttpServletRequest theRequest)` Get a new event service instance and set it in theRequest for later event dispatching.
`static EventService` | `getEventService(String lookup)` Get an instance of the EventService EJB.
`static String` | `getUserId(javax.servlet.http.HttpServletRequest req)` Return the user id of the currently logged in user (i.e.

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Constructor Detail

### TrackingEventHelper

    public TrackingEventHelper()

Method Detail

### dispatchEvent

    public static void dispatchEvent(Event theEvent)

  Deprecated Use EventService.dispatchEvent(Event theEvent).

  Dispatch an event, looking up the EventService EJB each time. It is recommended that the caller instead get an instance of the EventServiceBean using TrackingEventHelperImpl.getEventService(), then call TrackingEventHelperImpl.dispatchEvent() with with that EventServiceBean.

  To enable debugging for monitoring event firing, set this in debug.properties:

  com.bea.p13n.tracking.TrackingEventHelperImpl: on

### dispatchEvent

    public static void dispatchEvent(EventService eventService,
                                     Event evt)

  Fire the event, passing in the reference of the EventService EJB. To enable debugging for monitoring event firing, set this in debug.properties:

  com.bea.p13n.tracking.TrackingEventHelperImpl: on

### dispatchEvent

    public static void dispatchEvent(javax.servlet.http.HttpServletRequest theRequest,
                                     Event theEvent)

  Dispatch an event using an EventService that is cached in theRequest. To enable debugging for monitoring event firing, set this in debug.properties:

  com.bea.p13n.tracking.TrackingEventHelperImpl: on

### getEventService

    public static EventService getEventService()
                                        throws Exception

  Get an instance of the EventService EJB. This class (Helper) should not be responsible for caching instances of the EventService EJB. That should be done by the calling application.

  This API will use the ApplicationHelper to get the application name and prepend it to .BEA_personalization.EventService to do the JNDI lookup. If the JNDI lookup name is known (such as an ejb-ref), then use the getEventService(String lookup) API.

  Throws
    `Exception`

### getEventService

    public static EventService getEventService(String lookup)
                                        throws Exception

  Get an instance of the EventService EJB. This class (Helper) should not be responsible for caching instances of the EventService EJB. That should be done by the calling application.

  This API will use the ApplicationHelper to get the application name and prepend it to .BEA_personalization.EventService to do the JNDI lookup. If the JNDI lookup name is not known, then use the getEventService() API.

  Parameters
    `lookup` - The JNDI lookup name
  Throws
    `Exception`

### getEventService

    public static EventService getEventService(javax.servlet.http.HttpServletRequest theRequest)
                                        throws RemoteException,
                                               Exception

  Get a new event service instance and set it in theRequest for later event dispatching.

  Throws
    `RemoteException`
    `Exception`

### getUserId

    public static String getUserId(javax.servlet.http.HttpServletRequest req)

  Return the user id of the currently logged in user (i.e. the user associated to the thread, not neccessarily the request's remote user).

### dispatchSessionLoginEvent

    public static void dispatchSessionLoginEvent(javax.servlet.http.HttpServletRequest theRequest,
                                                 String userId)

  Utility method to dispatch a SessionLoginEvent for the specified userId, if it hasn't been done already.

  Parameters
    `theRequest` - the http servlet request the event is generating from.
    `userId` - the user id to generate the event for.

### dispatchSessionLoginEvent

    public static void dispatchSessionLoginEvent(javax.servlet.http.HttpServletRequest theRequest)

  Utility method to dispatch a SessionLoginEvent for the user logged into the given servlet request, if it hasn't been done already.

  Parameters
    `theRequest` - the http servlet request the event is generating from.
  See Also
    `getUserId(javax.servlet.http.HttpServletRequest)`

### dispatchSessionLoginEvent

    public static void dispatchSessionLoginEvent(javax.servlet.http.HttpSession session,
                                                 String userId)

  Utility method to dispatch a SessionLoginEvent for the user logged into the given servlet request, if it hasn't been done already.

  Parameters
    `session` - the http servlet session the event is generating from.
  See Also
    `getUserId(javax.servlet.http.HttpServletRequest)`

### dispatchUserRegistrationEvent

    public static void dispatchUserRegistrationEvent(javax.servlet.http.HttpServletRequest request,
                                                     String newUserId,
                                                     UserRegistrationEvent evt)

  Utility method to dispatch a UserRegistrationEvent for the specified user, if it hasn't been done already.

  Parameters
    `request` - the http servlet request the event is generating from.
    `newUserId` - the user id to generate the event for.
    `evt` - the event to fire.

### dispatchUserRegistrationEvent

    public static void dispatchUserRegistrationEvent(javax.servlet.http.HttpServletRequest request,
                                                     String newUserId)

  Utility method to dispatch a UserRegistrationEvent for the specified user, if it hasn't been done already.

  Parameters
    `request` - the http servlet request the event is generating from.
    `newUserId` - the user id to generate the event for.

### dispatchUserRegistrationEvent

    public static void dispatchUserRegistrationEvent(javax.servlet.http.HttpServletRequest request)

  Utility method to dispatch a UserRegistrationEvent for the user logged into the given servlet request, if it hasn't been done already.

  Parameters
    `request` - the http servlet request the event is generating from.
  See Also
    `getUserId(javax.servlet.http.HttpServletRequest)`

Overview | Package | Class | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright © 2008 BEA Systems, Inc. All Rights Reserved