org.jboss.portal.portlet.spi
Interface UserContext

All Known Implementing Classes:
AbstractUserContext, ControllerUserContext, JSFUserContext, UserContextSupport

public interface UserContext

The user context valid during the scope of a single request.

Version:
$Revision: 5448 $
Author:
Julien Viet

Method Summary
 java.lang.String getId()
          Retrieves the user id or null if it is not known.
 java.util.Map getInformations()
          The user profile information keyed by P3PConstants
 java.util.Locale getLocale()
          Return the user locale.
 java.util.List getLocales()
          Retrieves the locales that the user is willing to receive information in.
 

Method Detail

getId

java.lang.String getId()
Retrieves the user id or null if it is not known.

Returns:
the user id

getInformations

java.util.Map getInformations()
The user profile information keyed by P3PConstants

Returns:
a map containing user profile informaton
See Also:
P3PConstants

getLocale

java.util.Locale getLocale()
Return the user locale.

Returns:
the user locale.

getLocales

java.util.List getLocales()
Retrieves the locales that the user is willing to receive information in.

Returns:
the locales ordered according to user preference (preferred first).