org.jasig.portal.security
Interface IPerson

All Superinterfaces:

IAdditionalDescriptor, IBasicEntity, Principal, Serializable

All Known Implementing Classes:

PersonImpl, RestrictedPerson

public interface IPerson
extends Principal, IAdditionalDescriptor, IBasicEntity, Serializable

Version:

$Revision: 19776 $

Author:

Bernie Durfee, bdurfee@interactivebusiness.com

Field Summary

static int	GUEST_ID The user id for guest users.
static int	SYSTEM_USER_ID The user id for the special system user.
static int	UNDEFINED_ID The default ID for person objects.
static String	USERNAME String used as a key for the eduPerson username attribute.

Method Summary

Object	getAttribute(String key) Gets an attribute associated with the user
Enumeration<String>	getAttributeNames() Returns the names of all of the attributes stored for the user
Enumeration<List<Object>>	getAttributes() Gets all of the attributes associated with the user
Object[]	getAttributeValues(String key) Gets multiple values of an attribute associated with the user
String	getFullName() Gets the full name of the user
int	getID() Gets the ID of the user
ISecurityContext	getSecurityContext() Gets the security context object associated with the user
String	getUserName()
boolean	isGuest() Checks to see if this user is considered a guest
void	setAttribute(String key, List<Object> values)
void	setAttribute(String key, Object value) Associates an attribute with the user
void	setAttributes(Map<String,List<Object>> attrs) Associates attributes with the user
void	setEntityIdentifier(EntityIdentifier ei) Explicitly set the entity identifier The default implementation enforces a one time setting so that the value can't be changed once explicitly set.
void	setFullName(String sFullName) Sets the full name of the user
void	setID(int sID) Sets the ID of the user
void	setSecurityContext(ISecurityContext securityContext) Associates a security context object with the user
void	setUserName(String userName)

Methods inherited from interface java.security.Principal

equals, getName, hashCode, toString

Methods inherited from interface org.jasig.portal.IBasicEntity

getEntityIdentifier

Field Detail

USERNAME

static final String USERNAME

String used as a key for the eduPerson username attribute.

See Also:

Constant Field Values

UNDEFINED_ID

static final int UNDEFINED_ID

The default ID for person objects.

See Also:

Constant Field Values

GUEST_ID

static final int GUEST_ID

The user id for guest users.

See Also:

Constant Field Values

SYSTEM_USER_ID

static final int SYSTEM_USER_ID

The user id for the special system user.

See Also:

Constant Field Values

Method Detail

setID

void setID(int sID)

Sets the ID of the user

Parameters:

sID -

getID

int getID()

Gets the ID of the user

Returns:

ID of the user

getUserName

String getUserName()

Returns:

The userName for the user.

setUserName

void setUserName(String userName)

Parameters:

userName - The userName to set for the user.

setFullName

void setFullName(String sFullName)

Sets the full name of the user

Parameters:

sFullName -

getFullName

String getFullName()

Gets the full name of the user

Returns:

full name of the user

getAttribute

Object getAttribute(String key)

Gets an attribute associated with the user

Parameters:

key -

Returns:

attribute associated with the user

getAttributeValues

Object[] getAttributeValues(String key)

Gets multiple values of an attribute associated with the user

Parameters:

key -

Returns:

attributes associated with the user

setAttribute

void setAttribute(String key,
                  Object value)

Associates an attribute with the user

Parameters:

key -

value -

setAttribute

void setAttribute(String key,
                  List<Object> values)

Parameters:

key -

values -

setAttributes

void setAttributes(Map<String,List<Object>> attrs)

Associates attributes with the user

Parameters:

attrs -

getAttributes

Enumeration<List<Object>> getAttributes()

Gets all of the attributes associated with the user

Returns:

all of the attributes associated with the user

getAttributeNames

Enumeration<String> getAttributeNames()

Returns the names of all of the attributes stored for the user

Returns:

names of all of the attributes stored for the user

setSecurityContext

void setSecurityContext(ISecurityContext securityContext)

Associates a security context object with the user

Parameters:

securityContext -

getSecurityContext

ISecurityContext getSecurityContext()

Gets the security context object associated with the user

Returns:

security context object associated with the user

isGuest

boolean isGuest()

Checks to see if this user is considered a guest

Returns:

true if user is considered a guest

setEntityIdentifier

void setEntityIdentifier(EntityIdentifier ei)

Explicitly set the entity identifier The default implementation enforces a one time setting so that the value can't be changed once explicitly set.

Parameters:

ei -