senselogic.sitevision.api.user

Interface UserDataUtil

@Requireable(value="UserDataUtil")
public interface UserDataUtil

User data utility interface.

The portlet specification allows access of user-specific data via a read-only java.util.Map that can be obtained as request attribute using the PortletRequest.USER_INFO constant. This utility is a convenience to get such user data, but it also extends it by allowing write operations and access other user's data. Data written via this utility can be accesses via the Map exposed via the PortletRequest.USER_INFO constant and vice versa. Hence, with this utility there are no need to use the portlet specification mechanism for accessing user data.

Mutating data operations (set/remove) on other users requires certain permissions, see individual method documentation.

Important note! The user data mechanism is closely tied to a specific user object and is intended to handle basic user information and user preferences. Adding "too much" (count) or "too large" (size) user data might cause persistence implications and performance implications.

An instance of the SiteVision class implementing this interface can be obtained via UserFactory.getUserDataUtil(). See UserFactory for how to obtain an instance of the UserFactory interface.

Since:

SiteVision 4.1

Author:

Magnus Lövgren

Method Summary

Modifier and Type	Method and Description
java.util.Set<String>	getReadOnlyKeys() The read-only keys.
java.io.Serializable	getUserData(Node aUserNode, String aUserDataKey) Gets user data for a user.
java.io.Serializable	getUserData(String aUserDataKey) Gets user data for current user.
void	removeUserData(Node aUserNode, String aUserDataKey) Removes user data for a user.
void	removeUserData(String aUserDataKey) Removes user data.
void	setUserData(Node aUserNode, String aUserDataKey, java.io.Serializable aSerializableValue) Sets user data for a user.
void	setUserData(String aUserDataKey, java.io.Serializable aSerializableValue) Sets user data for current user.

Method Detail

getReadOnlyKeys

java.util.Set<String> getReadOnlyKeys()

The read-only keys.

Mutating operations (set/remove) with any of these keys will be ignored.

Note that internal-only properties are not included in the returned set, but they will also be ignored in mutating operations.

Returns:

a set of keys that are read-only

getUserData

java.io.Serializable getUserData(String aUserDataKey)

Gets user data for current user.

This read operation is equivalent to using the user info mechanism of the portlet specification.

Parameters:

aUserDataKey - the data key

Returns:

the value for aUserDataKey (typically a String), or null

getUserData

java.io.Serializable getUserData(Node aUserNode,
                                 String aUserDataKey)

Gets user data for a user.

Parameters:

aUserNode - the user node (typically a sv:user or sv:simpleUser)

aUserDataKey - the data key

Returns:

the value for aUserDataKey (typically a String), or null

setUserData

void setUserData(String aUserDataKey,
                 java.io.Serializable aSerializableValue)

Sets user data for current user.

This write operation is equivalent to using the SiteVision-specific user info mechanism of the portlet specification.

Important note! The set/write operation will be ignored if aUserDataKey is null, whitespace-only or read-only (see getReadOnlyKeys()). The set operation will also be ignored if aSerializableValue is null. Use removeUserData(String) to remove data instead.

Parameters:

aUserDataKey - the data key

aSerializableValue - the data value (typically a String)

setUserData

void setUserData(Node aUserNode,
                 String aUserDataKey,
                 java.io.Serializable aSerializableValue)

Sets user data for a user.

Important note! The set/write operation will be ignored if aUserDataKey is null, whitespace-only or read-only (see getReadOnlyKeys()). The set operation will also be ignored if aSerializableValue is null. Use removeUserData(String) to remove data instead.

Permission note! Current user (as of PortletContextUtil.getCurrentUser()) must have PermissionUtil.Permission.WRITE on current site (as of ResourceLocatorUtil.getSite()), otherwise the set/write operation will be ignored.

Parameters:

aUserNode - the user node (typically a sv:user or sv:simpleUser)

aUserDataKey - the data key

aSerializableValue - the data value (typically a String)

removeUserData

void removeUserData(String aUserDataKey)

Removes user data.

Important note! The remove/delete operation will be ignored if aUserDataKey is null, whitespace-only or read-only (see getReadOnlyKeys()).

Parameters:

aUserDataKey - the data key

removeUserData

void removeUserData(Node aUserNode,
                    String aUserDataKey)

Removes user data for a user.

Important note! The remove/delete operation will be ignored if aUserDataKey is null, whitespace-only or read-only (see getReadOnlyKeys()).

Permission note! Current user (as of PortletContextUtil.getCurrentUser()) must have PermissionUtil.Permission.WRITE on current site (as of ResourceLocatorUtil.getSite()), otherwise the remove/delete operation will be ignored.

Parameters:

aUserNode - the user node (typically a sv:user or sv:simpleUser)

aUserDataKey - the data key