com.caucho.portal.generic
Interface UserAttributeStore

All Known Implementing Classes:

AbstractUserAttributeStore

public interface UserAttributeStore

Factory that returns a Map of user attribute values for a particular client. The factory is used once for each connection if needed.

Method Summary

void	finish(java.util.Map<java.lang.String,java.lang.String> userAttributeMap) Called when a Map previously returned by getUserAttributeMap() is no longer needed.
java.util.Map<java.lang.String,java.lang.String>	getUserAttributeMap(PortletRequest request, java.util.Set<java.lang.String> names) Return a map of user attributes.

Method Detail

getUserAttributeMap

java.util.Map<java.lang.String,java.lang.String> getUserAttributeMap(PortletRequest request,
                                                                     java.util.Set<java.lang.String> names)
                                                                     throws java.io.IOException

Return a map of user attributes. Implementing classes use the information available from request to determine the identity of the user.

Parameters:

names - a Set of names indicating the user attributes that should be returned, may be null in which case all user attributes for the user should be returned.

Returns:

a Map of attribute names to values, or null if no user attributes are available.

Throws:

java.io.IOException

finish

void finish(java.util.Map<java.lang.String,java.lang.String> userAttributeMap)
            throws java.io.IOException

Called when a Map previously returned by getUserAttributeMap() is no longer needed. A call to finish() is not guaranteed to occur for every Map returned by getUserAttributeMap(). If an error occurs when processing a request, the portal may not have an opportunity to call finish().

Throws:

java.io.IOException