org.apache.marmotta.platform.user.services

Class UserConfigurationServiceImpl

java.lang.Object

org.apache.marmotta.platform.user.services.UserConfigurationServiceImpl

All Implemented Interfaces:

UserConfigurationService

@ApplicationScoped
public class UserConfigurationServiceImpl
extends Object
implements UserConfigurationService

Add file description here!

Author: Sebastian Schaffert

Constructor Summary

Constructors

Constructor and Description
UserConfigurationServiceImpl()

Method Summary

Methods

Modifier and Type	Method and Description
org.apache.commons.configuration.Configuration	getUserConfiguration(UserAccount user)
String	getUserConfiguration(UserAccount user, String key) Get the configuration for the given user and key.
String	getUserConfiguration(UserAccount user, String key, String defaultValue) Get the configuration for the given user and key.
List<Object>	getUserListConfiguration(UserAccount user, String key) Return the list configuration value of the given key for the given user.
List<Object>	getUserListConfiguration(UserAccount user, String key, List<Object> defaultValue) Return the list configuration value of the given key for the given user.
void	initialise()
boolean	isUserConfigurationSet(UserAccount user, String key) Check whether the given configuration is set for the given user.
void	removeUserConfiguration(UserAccount user, String key) Remove the user configuration identified by "key" from the database.
void	save(UserAccount user)
void	setUserConfiguration(UserAccount user, String key, String value) Set the configuration "key" to the string value "value".
void	setUserListConfiguration(UserAccount user, String key, List<String> values) Set the configuration "key" to the string value "value".

Methods inherited from class java.lang.Object

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

Constructor Detail

UserConfigurationServiceImpl

public UserConfigurationServiceImpl()

Method Detail

initialise

@PostConstruct
public void initialise()

isUserConfigurationSet

public boolean isUserConfigurationSet(UserAccount user,
                             String key)

Description copied from interface: UserConfigurationService

Check whether the given configuration is set for the given user.

Specified by:

isUserConfigurationSet in interface UserConfigurationService

Returns:

getUserConfiguration

public String getUserConfiguration(UserAccount user,
                          String key,
                          String defaultValue)

Description copied from interface: UserConfigurationService

Get the configuration for the given user and key. If there is no such configuration, a new one is created using the provided defaultValue as string value.

Specified by:

getUserConfiguration in interface UserConfigurationService

Parameters:

user - the user for whom to get the configuration

key - unique configuration key for lookup

defaultValue - default value if configuration not found

Returns:

a configuration object with either the configured value or defaultValue

getUserConfiguration

public String getUserConfiguration(UserAccount user,
                          String key)

Description copied from interface: UserConfigurationService

Get the configuration for the given user and key. If there is no such configuration, a new one is created with empty value (returns null).

Specified by:

getUserConfiguration in interface UserConfigurationService

Parameters:

user - the user for whom to get the configuration

key - unique configuration key for lookup

Returns:

a configuration object with either the configured value or null as value

getUserListConfiguration

public List<Object> getUserListConfiguration(UserAccount user,
                                    String key)

Description copied from interface: UserConfigurationService

Return the list configuration value of the given key for the given user. If there is no value for the key, returns the empty list.

Specified by:

getUserListConfiguration in interface UserConfigurationService

getUserListConfiguration

public List<Object> getUserListConfiguration(UserAccount user,
                                    String key,
                                    List<Object> defaultValue)

Description copied from interface: UserConfigurationService

Return the list configuration value of the given key for the given user. Returns the given defaultValue if no configuration is found for the given key.

Specified by:

getUserListConfiguration in interface UserConfigurationService

removeUserConfiguration

public void removeUserConfiguration(UserAccount user,
                           String key)

Description copied from interface: UserConfigurationService

Remove the user configuration identified by "key" from the database.

Specified by:

removeUserConfiguration in interface UserConfigurationService

setUserListConfiguration

public void setUserListConfiguration(UserAccount user,
                            String key,
                            List<String> values)

Description copied from interface: UserConfigurationService

Set the configuration "key" to the string value "value".

Specified by:

setUserListConfiguration in interface UserConfigurationService

setUserConfiguration

public void setUserConfiguration(UserAccount user,
                        String key,
                        String value)

Description copied from interface: UserConfigurationService

Set the configuration "key" to the string value "value".

Specified by:

setUserConfiguration in interface UserConfigurationService

getUserConfiguration

public org.apache.commons.configuration.Configuration getUserConfiguration(UserAccount user)

save

public void save(UserAccount user)