Package org.opencastproject.adminui.usersettings

Class UserSettingsService

java.lang.Object

org.opencastproject.adminui.usersettings.UserSettingsService

public class UserSettingsService
extends Object

Finds the user settings and message signatures from the current user.

Field Summary

Fields

Modifier and Type	Field	Description
protected DBSession	db
protected DBSessionFactory	dbSessionFactory
protected javax.persistence.EntityManagerFactory	emf	Factory used to create EntityManagers for transactions
protected OrganizationDirectoryService	organizationDirectoryService	The organization directory service
static final String	PERSISTENCE_UNIT
protected SecurityService	securityService	The security service
protected UserDirectoryService	userDirectoryService	The user directory service

Constructor Summary

Constructors

Constructor	Description
UserSettingsService()

Method Summary

Modifier and Type	Method	Description
void	activate(org.osgi.service.component.ComponentContext cc)	Creates EntityManagerFactory using persistence provider and properties passed via OSGi.
UserSetting	addUserSetting(String key, String value)	Create a new user setting key value pair.
void	deleteUserSetting(long id)	Delete a user setting by using a unique id to find it.
UserSettings	findUserSettings(int limit, int offset)	Finds the user settings for the current user.
void	setDBSessionFactory(DBSessionFactory dbSessionFactory)
void	setEntityManagerFactory(javax.persistence.EntityManagerFactory emf)	OSGi DI
void	setOrganizationDirectoryService(OrganizationDirectoryService organizationDirectoryService)	OSGi callback to set the organization directory service.
void	setSecurityService(SecurityService securityService)	OSGi callback to set the security service.
void	setUserDirectoryService(UserDirectoryService userDirectoryService)	OSGi callback to set user directory service.
UserSetting	updateUserSetting(long id, String key, String value)	Update a user setting that currently exists using its unique id to find it.
UserSetting	updateUserSetting(String key, String value, String oldValue)	Update a user setting that currently exists using its key to find it.

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

See Also:

• Constant Field Values

emf

protected javax.persistence.EntityManagerFactory emf

Factory used to create EntityManagers for transactions

dbSessionFactory

protected DBSessionFactory dbSessionFactory

db

protected DBSession db

userDirectoryService

protected UserDirectoryService userDirectoryService

The user directory service

organizationDirectoryService

protected OrganizationDirectoryService organizationDirectoryService

The organization directory service

securityService

protected SecurityService securityService

The security service

Constructor Details

UserSettingsService

public UserSettingsService()

Method Details

activate

public void activate(org.osgi.service.component.ComponentContext cc)

Creates EntityManagerFactory using persistence provider and properties passed via OSGi.

Parameters:

cc -

setEntityManagerFactory

public void setEntityManagerFactory(javax.persistence.EntityManagerFactory emf)

OSGi DI

setDBSessionFactory

public void setDBSessionFactory(DBSessionFactory dbSessionFactory)

setUserDirectoryService

public void setUserDirectoryService(UserDirectoryService userDirectoryService)

OSGi callback to set user directory service.

Parameters:

userDirectoryService - user directory service

setSecurityService

public void setSecurityService(SecurityService securityService)

OSGi callback to set the security service.

Parameters:

securityService - the security service

setOrganizationDirectoryService

public void setOrganizationDirectoryService(OrganizationDirectoryService organizationDirectoryService)

OSGi callback to set the organization directory service.

Parameters:

organizationDirectoryService - the organization directory service

findUserSettings

public UserSettings findUserSettings(int limit,
 int offset)
                              throws UserSettingsServiceException

Finds the user settings for the current user.

Parameters:

limit - The maximum limit of results to return.

offset - The starting page offset.

Returns:

The user settings for the current user.

Throws:

UserSettingsServiceException

addUserSetting

public UserSetting addUserSetting(String key,
 String value)
                           throws UserSettingsServiceException

Create a new user setting key value pair.

Parameters:

key - The key to use for the current user setting.

value - The value of the user setting.

Returns:

A new user setting object

Throws:

UserSettingsServiceException

updateUserSetting

public UserSetting updateUserSetting(String key,
 String value,
 String oldValue)
                              throws UserSettingsServiceException

Update a user setting that currently exists using its key to find it.

Parameters:

key - The key for the user setting.

value - The new value to set for the user setting.

Returns:

An updated UserSetting

Throws:

UserSettingsServiceException

updateUserSetting

public UserSetting updateUserSetting(long id,
 String key,
 String value)
                              throws UserSettingsServiceException

Update a user setting that currently exists using its unique id to find it.

Parameters:

id - The id for the user setting.

key - The key for the user setting.

value - The value for the user setting.

Returns:

The updated UserSetting.

Throws:

UserSettingsServiceException

deleteUserSetting

public void deleteUserSetting(long id)
                       throws UserSettingsServiceException

Delete a user setting by using a unique id to find it.

Parameters:

id - The unique id for the user setting.

Throws:

UserSettingsServiceException