Package org.opencastproject.usertracking.impl

Class UserTrackingServiceImpl

java.lang.Object

org.opencastproject.usertracking.impl.UserTrackingServiceImpl

All Implemented Interfaces:

UserTrackingService, org.osgi.service.cm.ManagedService

public class UserTrackingServiceImpl
extends Object
implements UserTrackingService, org.osgi.service.cm.ManagedService

Implementation of org.opencastproject.usertracking.api.UserTrackingService

See Also:

• UserTrackingService

Field Summary

Fields

Modifier and Type	Field	Description
protected DBSession	db
protected DBSessionFactory	dbSessionFactory
static final String	DETAILED_TRACKING
protected javax.persistence.EntityManagerFactory	emf	The factory used to generate the entity manager
static final String	FOOTPRINT_KEY
static final String	IP_LOGGING
static final String	PERSISTENCE_UNIT	JPA persistence unit name
static final String	SESSION_LOGGING
static final String	USER_LOGGING

Constructor Summary

Constructors

Constructor	Description
UserTrackingServiceImpl()

Method Summary

Modifier and Type	Method	Description
void	activate()	Activation callback to be executed once all dependencies are set
UserAction	addUserFootprint(UserAction action, UserSession session)	Adds a new annotation to the database and returns the event with an updated annotationId, to make sure the annotationId stays unique
UserAction	addUserTrackingEvent(UserAction a, UserSession session)	Adds a new tracking event to the database and returns the event with an updated annotationId, to make sure the annotationId stays unique
FootprintList	getFootprints(String mediapackageId, String userId)	Returns a list of footprints, if a userId is passed only the footprints of that user are returned.
Report	getReport(int offset, int limit)	Returns a report
Report	getReport(String from, String to, int offset, int limit)	Returns a report
UserAction	getUserAction(Long id)	Get a single user action by its identifier.
UserActionList	getUserActions(int offset, int limit)	Returns annotations
UserActionList	getUserActionsByDay(String day, int offset, int limit)	Returns annotations of a given day (YYYYMMDD)
UserActionList	getUserActionsByType(String type, int offset, int limit)	Returns annotations of a given key
UserActionList	getUserActionsByTypeAndDay(String type, String day, int offset, int limit)	Returns annotations of a given key and day
UserActionList	getUserActionsByTypeAndMediapackageId(String type, String mediapackageId, int offset, int limit)	Returns annotations of a given key and mediapackage id
UserActionList	getUserActionsByTypeAndMediapackageIdByDate(String type, String mediapackageId, int offset, int limit)	Returns annotations of a given key and mediapackage id ordered by date.
UserActionList	getUserActionsByTypeAndMediapackageIdByDescendingDate(String type, String mediapackageId, int offset, int limit)	Returns annotations of a given key and mediapackage id ordered descending by date.
boolean	getUserTrackingEnabled()	Returns the flag turning user tracking on or off.
int	getViews(String mediapackageId)	Returns the views of a mediapackage
void	setDBSessionFactory(DBSessionFactory dbSessionFactory)
void	updated(Dictionary props)

Methods inherited from class java.lang.Object

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

Field Details

PERSISTENCE_UNIT

public static final String PERSISTENCE_UNIT

JPA persistence unit name

See Also:

• Constant Field Values

FOOTPRINT_KEY

public static final String FOOTPRINT_KEY

See Also:

• Constant Field Values

DETAILED_TRACKING

public static final String DETAILED_TRACKING

See Also:

• Constant Field Values

IP_LOGGING

public static final String IP_LOGGING

See Also:

• Constant Field Values

USER_LOGGING

public static final String USER_LOGGING

See Also:

• Constant Field Values

SESSION_LOGGING

public static final String SESSION_LOGGING

See Also:

• Constant Field Values

emf

protected javax.persistence.EntityManagerFactory emf

The factory used to generate the entity manager

dbSessionFactory

protected DBSessionFactory dbSessionFactory

db

protected DBSession db

Constructor Details

UserTrackingServiceImpl

public UserTrackingServiceImpl()

Method Details

setDBSessionFactory

public void setDBSessionFactory(DBSessionFactory dbSessionFactory)

activate

public void activate()

Activation callback to be executed once all dependencies are set

updated

public void updated(Dictionary props)
             throws org.osgi.service.cm.ConfigurationException

Specified by:

updated in interface org.osgi.service.cm.ManagedService

Throws:

org.osgi.service.cm.ConfigurationException

getViews

public int getViews(String mediapackageId)

Description copied from interface: UserTrackingService

Returns the views of a mediapackage

Specified by:

getViews in interface UserTrackingService

Parameters:

mediapackageId - the mediapackeId

Returns:

the views

addUserFootprint

public UserAction addUserFootprint(UserAction action,
 UserSession session)
                            throws UserTrackingException

Description copied from interface: UserTrackingService

Adds a new annotation to the database and returns the event with an updated annotationId, to make sure the annotationId stays unique

Specified by:

addUserFootprint in interface UserTrackingService

Parameters:

action - The UserAction that will be added to the database

session - The UserSession associated with this footprint

Returns:

the updated annotation, with a new ID. NULL if there are errors while adding the annotation.

Throws:

UserTrackingException - if the user tracking service encounters an error

addUserTrackingEvent

public UserAction addUserTrackingEvent(UserAction a,
 UserSession session)
                                throws UserTrackingException

Description copied from interface: UserTrackingService

Adds a new tracking event to the database and returns the event with an updated annotationId, to make sure the annotationId stays unique

Specified by:

addUserTrackingEvent in interface UserTrackingService

Parameters:

a - The UserAction that will be added to the database

session - The UserSession associated with this footprint

Returns:

the updated annotation, with a new ID. NULL if there are errors while adding the annotation.

Throws:

UserTrackingException - if the user tracking service encounters an error

getUserActions

public UserActionList getUserActions(int offset,
 int limit)

Description copied from interface: UserTrackingService

Returns annotations

Specified by:

getUserActions in interface UserTrackingService

Parameters:

offset - the offset

limit - the limit

Returns:

the annotation list

getUserActionsByType

public UserActionList getUserActionsByType(String type,
 int offset,
 int limit)

Description copied from interface: UserTrackingService

Returns annotations of a given key

Specified by:

getUserActionsByType in interface UserTrackingService

Parameters:

type - The annotation key

offset - the offset

limit - the limit

Returns:

the annotation list

getUserActionsByTypeAndMediapackageId

public UserActionList getUserActionsByTypeAndMediapackageId(String type,
 String mediapackageId,
 int offset,
 int limit)

Description copied from interface: UserTrackingService

Returns annotations of a given key and mediapackage id

Specified by:

getUserActionsByTypeAndMediapackageId in interface UserTrackingService

Parameters:

type - the annotation key

mediapackageId - the mediapackage id

offset - the offset

limit - the limit

Returns:

the annotation list

getUserActionsByTypeAndDay

public UserActionList getUserActionsByTypeAndDay(String type,
 String day,
 int offset,
 int limit)

Description copied from interface: UserTrackingService

Returns annotations of a given key and day

Specified by:

getUserActionsByTypeAndDay in interface UserTrackingService

Parameters:

type - the annotation key

day - the day

offset - the offset

limit - the limit

Returns:

the annotation list

getUserActionsByTypeAndMediapackageIdByDate

public UserActionList getUserActionsByTypeAndMediapackageIdByDate(String type,
 String mediapackageId,
 int offset,
 int limit)

Description copied from interface: UserTrackingService

Returns annotations of a given key and mediapackage id ordered by date.

Specified by:

getUserActionsByTypeAndMediapackageIdByDate in interface UserTrackingService

Parameters:

type - the annotation key

mediapackageId - the mediapackage id

offset - the offset

limit - the limit

Returns:

the annotation list

getUserActionsByTypeAndMediapackageIdByDescendingDate

public UserActionList getUserActionsByTypeAndMediapackageIdByDescendingDate(String type,
 String mediapackageId,
 int offset,
 int limit)

Description copied from interface: UserTrackingService

Returns annotations of a given key and mediapackage id ordered descending by date.

Specified by:

getUserActionsByTypeAndMediapackageIdByDescendingDate in interface UserTrackingService

Parameters:

type - the annotation key

mediapackageId - the mediapackage id

offset - the offset

limit - the limit

Returns:

the annotation list

getUserActionsByDay

public UserActionList getUserActionsByDay(String day,
 int offset,
 int limit)

Description copied from interface: UserTrackingService

Returns annotations of a given day (YYYYMMDD)

Specified by:

getUserActionsByDay in interface UserTrackingService

Parameters:

day - The day in the format of YYYYMMDD

offset - the offset

limit - the limit

Returns:

the annotation list

getReport

public Report getReport(int offset,
 int limit)

Description copied from interface: UserTrackingService

Returns a report

Specified by:

getReport in interface UserTrackingService

Parameters:

offset - the offset

limit - the limit

Returns:

the report

getReport

public Report getReport(String from,
 String to,
 int offset,
 int limit)
                 throws ParseException

Description copied from interface: UserTrackingService

Returns a report

Specified by:

getReport in interface UserTrackingService

Parameters:

from - The from day key

to - The to day key

offset - the offset

limit - the limit

Returns:

the report

Throws:

ParseException

getFootprints

public FootprintList getFootprints(String mediapackageId,
 String userId)

Description copied from interface: UserTrackingService

Returns a list of footprints, if a userId is passed only the footprints of that user are returned.

Specified by:

getFootprints in interface UserTrackingService

Parameters:

mediapackageId - The mediapackageId

userId - The userId is optional

Returns:

the footprintList

getUserAction

public UserAction getUserAction(Long id)
                         throws UserTrackingException,
NotFoundException

Get a single user action by its identifier.

Specified by:

getUserAction in interface UserTrackingService

Parameters:

id - the user action identifier

Returns:

the user action

Throws:

UserTrackingException - if the user tracking service encounters an error

NotFoundException - if the no user action with this identifier exists

See Also:

• UserTrackingService.getUserAction(java.lang.Long)

getUserTrackingEnabled

public boolean getUserTrackingEnabled()

Returns the flag turning user tracking on or off. Turning user tracking off disables the detailed information gathering, but does *not* disable footprint gathering.

Specified by:

getUserTrackingEnabled in interface UserTrackingService

Returns:

True if detailed user tracking should be gathered, false otherwise

See Also:

• UserTrackingService.getUserTrackingEnabled()