stella.util
Interface UserProfile

All Known Implementing Classes:
SimpleUserProfile, UserProperty, UserSql.SqlProfile

public interface UserProfile

An interface combining the different user profiles and gather some information.


Nested Class Summary
static class UserProfile.Affil
          Affiliation to the different time slots.
static class UserProfile.Notifies
          A enumeration of notification events.
 
Field Summary
static Color[][] AFFILCOLOR
          According to the affiliations, we have some colors.
static String SYSTEM
          The system user.
 
Method Summary
 Collection<UserProfile.Affil> getAllowedInstitutions()
          Returns all allowed billing institutions for this user.
 Color getColor()
          Returns the user color.
 Collection<? extends javax.mail.Address> getEmail()
          Returns the e-mail collection.
 UserProfile.Affil getInstitution()
          Returns one of the recognized institutions.
 PublicKey getKey()
          Returns the public key of this user, if any.
 Collection<UserProfile.Notifies> getNotify()
          Returns the notification list.
 PasswordAuthentication getPassword()
          Returns a password authentication, that is a user name and a password.
 String getUser()
          Returns the user name.
 boolean setInstitution(UserProfile.Affil billing)
          Sets the billing organisation to something different from the default.
 

Field Detail

SYSTEM

static final String SYSTEM
The system user.

See Also:
Constant Field Values

AFFILCOLOR

static final Color[][] AFFILCOLOR
According to the affiliations, we have some colors.

Method Detail

getUser

String getUser()
Returns the user name.


getInstitution

UserProfile.Affil getInstitution()
Returns one of the recognized institutions. This is the billing institution, to cahnge that call setInstitution(stella.util.UserProfile.Affil).


getAllowedInstitutions

Collection<UserProfile.Affil> getAllowedInstitutions()
Returns all allowed billing institutions for this user.


setInstitution

boolean setInstitution(UserProfile.Affil billing)
Sets the billing organisation to something different from the default. If this is not allowed, false should be returned here.


getEmail

Collection<? extends javax.mail.Address> getEmail()
Returns the e-mail collection.


getNotify

Collection<UserProfile.Notifies> getNotify()
Returns the notification list.


getColor

Color getColor()
Returns the user color.


getKey

PublicKey getKey()
                 throws SecurityException
Returns the public key of this user, if any.

Throws:
SecurityException - if access to the key is not granted.

getPassword

PasswordAuthentication getPassword()
                                   throws SecurityException
Returns a password authentication, that is a user name and a password.

Throws:
SecurityException - if access to the password is not granted.