com.sas.edir
Interface User

All Superinterfaces:

Caching, Entity, TrackedObject

All Known Subinterfaces:

DeliveryUser

public interface User

extends Entity

A user is an enterprise entity that is a description of an individual. A user provides:

• Access to user properties: EmailAddress, Name.
• Access to user iterations: Group.

Version:

1.0

Author:

SAS

Fields inherited from interface com.sas.edir.Entity

PROPERTY_CHANGED, SUBPROPERTY_CHANGED

Method Summary

java.lang.String	getCredentials() Returns the user's credentials.
java.lang.String	getEmailAddress() Returns this user's email address.
GroupFilter	getGroupFilter() Returns the user's group filter.
java.lang.String	getIdentity() Returns the user's identity.
java.lang.String	getSurname() Returns this user's surname.
java.lang.String	getUid() Returns the user's uid attribute.
java.lang.String	getUserPassword() Return the value for the userPassword attribute.
java.util.Iterator	groupIterator() Returns a filtered iteration of groups this user belongs to.
java.util.Iterator	groupIterator(java.util.Comparator compare) Returns a filtered and sorted iteration of all the groups this user belongs to.
void	setCredentials(java.lang.String credentials) Sets the user's credentials.
void	setEmailAddress(java.lang.String address) Sets this user's email address.
void	setGroupFilter(GroupFilter filter) Sets the user's group filter.
void	setIdentity(java.lang.String identity) Sets the user's identity.
void	setSurname(java.lang.String surname) Sets this user's surname.
void	setUid(java.lang.String uid) Sets the user's uid attribute.
void	setUserPassword(java.lang.String password) Sets the user's password.

Methods inherited from interface com.sas.edir.Entity

addPropertyChangeListener, getContext, getCreateTime, getCreatorsName, getDescription, getEnterpriseDirectory, getGuid, getModifiersName, getModifyTime, getName, getObjectclass, removeModificationItems, removePropertyChangeListener, setDescription, setGuid, setName, setObjectclass

Methods inherited from interface com.sas.edir.Caching

edirUpdateStore, getTimeToLive, isExpired, refreshCache, refreshCachedObjects, releaseCache, setDirty, setTimeToLive, setTimeToLive, updateStore

Methods inherited from interface com.sas.edir.TrackedObject

getTrackingId, getUserData, setUserData

Method Detail

getCredentials

public java.lang.String getCredentials()

Returns the user's credentials.

Returns:

The user's credentials.

setCredentials

public void setCredentials(java.lang.String credentials)

Sets the user's credentials.

Parameters:

credentials - The credentials that validate the user's identity.

getEmailAddress

public java.lang.String getEmailAddress()

Returns this user's email address.

Returns:

The email address.

setEmailAddress

public void setEmailAddress(java.lang.String address)

Sets this user's email address.

This change is not persisted to the enterprise directory until updateStore is called.

Parameters:

address - The email address.

getGroupFilter

public GroupFilter getGroupFilter()

Returns the user's group filter.

Returns:

The group filter.

setGroupFilter

public void setGroupFilter(GroupFilter filter)

Sets the user's group filter.

The group filter is used to subset the list of groups retrieved from the enterprise directory. The groupIterator(...) methods will only iterate over the groups retrived from the enterprise directory.

Parameters:

filter - The group filter.

groupIterator

public java.util.Iterator groupIterator()

Returns a filtered iteration of groups this user belongs to.

Filtering is based on the GroupFilter set with setGroupFilter(...).

Returns:

A Group iteration.

groupIterator

public java.util.Iterator groupIterator(java.util.Comparator compare)

Returns a filtered and sorted iteration of all the groups this user belongs to.

Filtering is based on the GroupFilter set with setGroupFilter(...).

Parameters:

comparator - A Comparator for sorting, or null for no sorting.

Returns:

A Group iteration.

getIdentity

public java.lang.String getIdentity()

Returns the user's identity.

Returns:

The user's enterprise directory identity.

setIdentity

public void setIdentity(java.lang.String identity)

Sets the user's identity.

Parameters:

identity - The user's enterprise directory identity.

getSurname

public java.lang.String getSurname()

Returns this user's surname.

Returns:

The surname.

setSurname

public void setSurname(java.lang.String surname)

Sets this user's surname.

This change is not persisted to the enterprise directory until updateStore is called.

Parameters:

surname - The surname.

setUserPassword

public void setUserPassword(java.lang.String password)

Sets the user's password.

This allows the user's password to be updated. This is somewhat different from other updates because the password is not cached, and there is no explicit get function for the password. Since the password should be hashed, though, there should be no reason to want to get it.

Parameters:

password - The new password.

getUserPassword

public java.lang.String getUserPassword()

Return the value for the userPassword attribute.

Returns:

The user password string

getUid

public java.lang.String getUid()

Returns the user's uid attribute.

Returns:

The uid.

setUid

public void setUid(java.lang.String uid)

Sets the user's uid attribute.

Parameters:

uid - The new uid.