org.apache.cocoon.portal.profile.impl
Class UserInfo

java.lang.Object
  extended by org.apache.cocoon.portal.profile.impl.UserInfo
All Implemented Interfaces:
Serializable, PortalUser
Direct Known Subclasses:
AuthenticationFWUserInfoProvider.AFWUserInfo, UserInfoProviderImpl.PortalUserInfo

public abstract class UserInfo
extends Object
implements PortalUser, Serializable

Information about the current user. This data object is used for loading the profile. It decouples the portal from the used authentication method.

Version:
CVS $Id: UserInfo.html 1304258 2012-03-23 10:09:27Z ilgrosso $
Author:
Carsten Ziegeler
See Also:
Serialized Form

Field Summary
protected  Map configurations
           
protected  String group
           
protected  String layoutKey
           
protected  String portalName
           
protected  String userName
           
 
Constructor Summary
UserInfo(String portalName, String layoutKey)
           
 
Method Summary
 Map getConfigurations()
           
 String getGroup()
           
 String getLayoutKey()
           
 String getPortalName()
           
 String getUserName()
           
abstract  boolean isUserInRole(String role)
           
 void setConfigurations(Map configurations)
           
 void setGroup(String group)
           
 void setUserName(String userName)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

userName

protected String userName

group

protected String group

portalName

protected String portalName

layoutKey

protected String layoutKey

configurations

protected Map configurations
Constructor Detail

UserInfo

public UserInfo(String portalName,
                String layoutKey)
Method Detail

getGroup

public String getGroup()
Specified by:
getGroup in interface PortalUser
Returns:
Returns the group.

setGroup

public void setGroup(String group)
Parameters:
group - The group to set.

getUserName

public String getUserName()
Specified by:
getUserName in interface PortalUser
Returns:
Returns the userName.

setUserName

public void setUserName(String userName)
Parameters:
userName - The userName to set.

getConfigurations

public Map getConfigurations()
Returns:
Returns the configurations.

setConfigurations

public void setConfigurations(Map configurations)
Parameters:
configurations - The configurations to set.

getLayoutKey

public String getLayoutKey()
Returns:
Returns the layoutKey.

getPortalName

public String getPortalName()
Returns:
Returns the portalName.

isUserInRole

public abstract boolean isUserInRole(String role)
Specified by:
isUserInRole in interface PortalUser


Copyright © 1999-2010 The Apache Software Foundation. All Rights Reserved.