org.hawkular.accounts.api

Interface UserSettingsService

All Known Implementing Classes:

UserSettingsServiceImpl

public interface UserSettingsService

Provides a facility for managing user-related settings.

Author:

Juraci Paixão Kröhling

Method Summary

Modifier and Type	Method and Description
UserSettings	get(String id) Deprecated. Use getById(UUID) instead
UserSettings	getById(UUID id) Retrieves a UserSettings object based on its ID.
UserSettings	getByUser() Retrieves a UserSettings object for the currently logged in user or null if none exist.
UserSettings	getByUser(HawkularUser user) Retrieves a UserSettings object for the given user or null if none exist.
UserSettings	getOrCreateByUser() Retrieves a UserSettings object for the currently logged in user or a new one if none exists.
UserSettings	getOrCreateByUser(HawkularUser user) Retrieves a UserSettings object for the given user or a new one if none exists.
String	getSettingByKey(HawkularUser user, String key) Retrieves a setting with the given key for the specified user.
String	getSettingByKey(HawkularUser user, String key, String defaultValue) Retrieves a setting with the given key for the specified user, returning the value specified in 'default' if no setting is available for the key.
String	getSettingByKey(String key) Retrieves a setting with the given key for the currently logged in user.
String	getSettingByKey(String key, String defaultValue) Retrieves a setting with the given key for the currently logged in user, returning the value specified in 'default' if no setting is available for the key.
String	produceSettingByName(javax.enterprise.inject.spi.InjectionPoint injectionPoint) CDI producer method for beans annotated with NamedSetting.
UserSettings	remove(HawkularUser user, String key) Removes the specified setting value under the given key, for the specified user.
UserSettings	remove(String key) Removes the specified setting value under the given key, for the currently logged in user.
UserSettings	store(HawkularUser user, String key, String value) Stores the specified setting value under the given key, for the specified user.
UserSettings	store(String key, String value) Stores the specified setting value under the given key, for the currently logged in user.

Method Detail

get

@Deprecated
UserSettings get(String id)

Deprecated. Use getById(UUID) instead

Retrieves a UserSettings object based on its ID.

Parameters:

id - the UserSettings ID

Returns:

the UserSettings for the given ID or null if none exists.

getById

UserSettings getById(UUID id)

Retrieves a UserSettings object based on its ID.

Parameters:

id - the UserSettings ID

Returns:

the UserSettings for the given ID or null if none exists.

getByUser

UserSettings getByUser()

Retrieves a UserSettings object for the currently logged in user or null if none exist.

Returns:

the existing UserSettings or null

getByUser

UserSettings getByUser(HawkularUser user)

Retrieves a UserSettings object for the given user or null if none exist.

Parameters:

user - the user that the settings belong to

Returns:

the existing UserSettings or null

getOrCreateByUser

UserSettings getOrCreateByUser()

Retrieves a UserSettings object for the currently logged in user or a new one if none exists.

Returns:

the existing UserSettings or null

getOrCreateByUser

UserSettings getOrCreateByUser(HawkularUser user)

Retrieves a UserSettings object for the given user or a new one if none exists.

Parameters:

user - the user that the settings belong to

Returns:

the existing UserSettings or null

getSettingByKey

String getSettingByKey(String key)

Retrieves a setting with the given key for the currently logged in user.

Parameters:

key - the setting's key

Returns:

the value for the given key

getSettingByKey

String getSettingByKey(String key,
                       String defaultValue)

Retrieves a setting with the given key for the currently logged in user, returning the value specified in 'default' if no setting is available for the key.

Parameters:

key - the setting's key

defaultValue - the value to be returned should the key not exist for the user

Returns:

the value for the given key or the default value, if a value doesn't exist

getSettingByKey

String getSettingByKey(HawkularUser user,
                       String key)

Retrieves a setting with the given key for the specified user.

Parameters:

user - the user to retrieve the setting from

key - the setting's key

Returns:

the value for the given key

getSettingByKey

String getSettingByKey(HawkularUser user,
                       String key,
                       String defaultValue)

Retrieves a setting with the given key for the specified user, returning the value specified in 'default' if no setting is available for the key.

Parameters:

user - the user to retrieve the setting from

key - the setting's key

defaultValue - the value to be returned should the key not exist for the user

Returns:

the value for the given key or the default value, if a value doesn't exist

store

UserSettings store(HawkularUser user,
                   String key,
                   String value)

Stores the specified setting value under the given key, for the specified user.

Parameters:

user - the user which the setting refers to

key - the setting's key

value - the setting's value

store

UserSettings store(String key,
                   String value)

Stores the specified setting value under the given key, for the currently logged in user.

Parameters:

key - the setting's key

value - the setting's value

remove

UserSettings remove(HawkularUser user,
                    String key)

Removes the specified setting value under the given key, for the specified user.

Parameters:

user - the user which the setting refers to

key - the setting's key

remove

UserSettings remove(String key)

Removes the specified setting value under the given key, for the currently logged in user.

Parameters:

key - the setting's key

produceSettingByName

String produceSettingByName(javax.enterprise.inject.spi.InjectionPoint injectionPoint)

CDI producer method for beans annotated with NamedSetting. This method is not intended to be called by consumers of the API.

Parameters:

injectionPoint - the CDI InjectionPoint

Returns:

the value for the key on the annotation