edu.mit.stellar.api.user
Interface UserIdentity

All Superinterfaces:

java.security.Principal

All Known Subinterfaces:

UserIdentityM

public interface UserIdentity
extends java.security.Principal

UserIdentity

Version:

$Revision: 29988 $, $Date: 2008-02-09 22:10:42 -0500 (Sat, 09 Feb 2008) $

Author:

MIT Stellar team

Method Summary

java.lang.String	getActingAsUuid() 'acting as' guid (guid of another user), which may be used for impersonation Impersonation: the ability of a user to access as another user, is supported via the 'acting as' field.
java.lang.String	getAuthenticationProviderIdentifier() At runtime, this is set to the system identifier of the (probably Acegi) authentication provider which was used for authenticating the user.
java.util.Set<AuthenticationProviderInformation>	getAuthenticationProviderInformationList() List of authentication providers for this person, mapping user's identifier from that source to the corresponding AuthenticationProviderInformation.
java.lang.String	getCurrentUsername() Current exposed username for this application
java.lang.String	getDirectoryServiceId() Directory service (as an ID used in system configuration) used for getting Attributes for this user, e.g.
java.lang.String	getEnterpriseId() Any institutional ID for the local users, e.g.
java.lang.String	getInstance() 'instance' string, to allow for operations in a special mode Operating in a special mode: E.g.
java.lang.String	getMergedWithUuid() 'merged with' guid, in case a duplicate entry had been created and later reconciled
java.lang.String	getPrimaryEmailAddress() Primary and secondary email addresses are highlighted at this level to ensure being able to contact the user.
java.lang.String	getSecondaryEmailAddress() An alternative email address used in case primary address fails.
java.util.Set<DateRange>	getUsernameHistory() List of historic usernames and dates of applicability
java.lang.String	getUuid() internal guid of some form, uniquely identifying a person

Methods inherited from interface java.security.Principal

equals, getName, hashCode, toString

Method Detail

getUuid

java.lang.String getUuid()

internal guid of some form, uniquely identifying a person

Returns:

the uuid

getCurrentUsername

java.lang.String getCurrentUsername()

Current exposed username for this application

Returns:

the currentUsername

getEnterpriseId

java.lang.String getEnterpriseId()

Any institutional ID for the local users, e.g. an ID number, or null if user is not affilitated with this institution. This information may be more generally available as Attributes for any user, but the EnterpriseId used for reference to institutional Enterprise services may be useful and is accessed through this convenience function.

Returns:

the enterpriseId for the user, or null.

getDirectoryServiceId

java.lang.String getDirectoryServiceId()

Directory service (as an ID used in system configuration) used for getting Attributes for this user, e.g. via LDAP.

Returns:

the identifier of the directory service to be used

getUsernameHistory

java.util.Set<DateRange> getUsernameHistory()

List of historic usernames and dates of applicability

Returns:

the usernameHistory

getMergedWithUuid

java.lang.String getMergedWithUuid()

'merged with' guid, in case a duplicate entry had been created and later reconciled

Returns:

the mergedWithUuid

getInstance

java.lang.String getInstance()

'instance' string, to allow for operations in a special mode Operating in a special mode: E.g. using the kerberos /root or /extra principle, for an extra degree of access control for the user, requiring a special login. This is a transient field, set at runtime.

Returns:

the instance

getActingAsUuid

java.lang.String getActingAsUuid()

'acting as' guid (guid of another user), which may be used for impersonation Impersonation: the ability of a user to access as another user, is supported via the 'acting as' field. Applications or tools which support impersonation may make view and authorization decisions based on the combination of true user id and 'acting as' id, e.g. providing the ability for faculty to view a homework submission form as a particular student would see it, but denying the faculty the ability to submit a homework as that student. This is a transient field, set at runtime.

Returns:

the actingAsUuid

getPrimaryEmailAddress

java.lang.String getPrimaryEmailAddress()

Primary and secondary email addresses are highlighted at this level to ensure being able to contact the user.

Returns:

the primaryEmailAddress

getSecondaryEmailAddress

java.lang.String getSecondaryEmailAddress()

An alternative email address used in case primary address fails.

Returns:

the secondaryEmailAddress

getAuthenticationProviderIdentifier

java.lang.String getAuthenticationProviderIdentifier()

At runtime, this is set to the system identifier of the (probably Acegi) authentication provider which was used for authenticating the user.

Returns:

identifier for the AuthenticationProvider which authenticated this user in this session.

getAuthenticationProviderInformationList

java.util.Set<AuthenticationProviderInformation> getAuthenticationProviderInformationList()

List of authentication providers for this person, mapping user's identifier from that source to the corresponding AuthenticationProviderInformation.

Returns:

the authenticationProviderInformation