org.exoplatform.services.security

Class Identity

java.lang.Object

org.exoplatform.services.security.Identity

public class Identity
extends Object

Created by The eXo Platform SAS
User Session encapsulates user's principals such as name, groups along with JAAS subject (useful in J2EE environment) as well as other optional attributes

Author:

Gennady Azarenkov

Level API:

Platform

Constructor Summary

Constructors

Constructor and Description
Identity(String userId)
Identity(String userId, Collection<MembershipEntry> memberships)
Identity(String userId, Collection<MembershipEntry> memberships, Collection<String> roles)

Method Summary

Methods

Modifier and Type	Method and Description
Set<String>	getGroups()
Collection<MembershipEntry>	getMemberships()
Collection<String>	getRoles()
Subject	getSubject() Deprecated. Do not need store subject any more. It was used before to perform logout, since tomcat 6.0.21 logout implemented in web-container.
String	getUserId()
boolean	isMemberOf(MembershipEntry me)
boolean	isMemberOf(String group) Check is user member of group.
boolean	isMemberOf(String group, String membershipType)
void	setMemberships(Collection<MembershipEntry> memberships) Deprecated. for back compatibility.
void	setRoles(Collection<String> roles) Sets the roles for J2EE environment using.
void	setSubject(Subject subject) Deprecated. See getSubject()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Identity

public Identity(String userId)

Parameters:

userId - the user's identifier.

Identity

public Identity(String userId,
        Collection<MembershipEntry> memberships)

Parameters:

userId - the user's identifier.

memberships - the memberships.

Identity

public Identity(String userId,
        Collection<MembershipEntry> memberships,
        Collection<String> roles)

Parameters:

userId - the user's identifier.

memberships - the memberships.

roles - the user's roles.

Method Detail

getUserId

public String getUserId()

Returns:

user identifier.

isMemberOf

public boolean isMemberOf(String group,
                 String membershipType)

Parameters:

group - the group.

membershipType - the MembershipType.

Returns:

true if user has given membershipType for given group, false otherwise

isMemberOf

public boolean isMemberOf(MembershipEntry me)

Parameters:

me - the MembershipEntry.

Returns:

true if user has given MembershipEntry, false otherwise.

isMemberOf

public boolean isMemberOf(String group)

Check is user member of group.

Parameters:

group - the group.

Returns:

true if user has any membershipType for given group, false otherwise.

getGroups

public Set<String> getGroups()

Returns:

set of groups to which this user belongs to.

setMemberships

@Deprecated
public void setMemberships(Collection<MembershipEntry> memberships)

Deprecated. for back compatibility.

getMemberships

public Collection<MembershipEntry> getMemberships()

Returns:

user's memberships.

setRoles

public void setRoles(Collection<String> roles)

Sets the roles for J2EE environment using.

Parameters:

roles - the roles.

getRoles

public Collection<String> getRoles()

Returns:

roles users roles.

getSubject

public Subject getSubject()

Deprecated. Do not need store subject any more. It was used before to perform logout, since tomcat 6.0.21 logout implemented in web-container.

Returns:

@see Subject .

setSubject

public void setSubject(Subject subject)

Deprecated. See getSubject()

Parameters:

subject - @see Subject .