UserSql

java.lang.Object
- util.PropertyContainer
- - util.PropertyResources
  - - mysql.AbstractSql
    - - mysql.UserSql

All Implemented Interfaces:

Cloneable, ExitCleaning, Initializable, PropertySupplying, ResourceSupplying
```
public class UserSql
extends AbstractSql
```
A class that allows access to a database containing the different users on STELLA. It contains contact information for the automatic notification system as well as some default settings in terms of color
```
 CREATE TABLE "user"
 user | character varying(255) | not null
 affil | character varying(255) |
 pubkey | text |
 email | character varying(255) |
 farbe | character varying(255) |
 notify | text |
 passwd | character varying(255) |
 Indexes:
 "user_pkey" PRIMARY KEY, btree ("user")
 Triggers:
 _st1_logtrigger_8 AFTER INSERT OR DELETE OR UPDATE ON "user" FOR EACH ROW
 EXECUTE PROCEDURE _st1.logtrigger('_st1', '8', 'kvvvvvv')
 
```
In this setup, the columns have the following meanings:
- user: The name of the user, not necessarly a login name. This user name is the same as the ProposalSql PI. It is given in the target-xml as the User element.
- affil: The abreviation of the user-group the user is allocated to. This is used for calculating time-shares of the different participating institutes and thus has a limited number of values possible. Possible values are stored in KEY_AFFILALLOWED, currently Core, AIP, IAC, International, and Engineering. It can be overriden in the target-xml file as the Institution element.
- pubkey: If the user provides his/her ssh-dsa.pub key, it is stored in the database and can be used for authorization. Not present in the target file.
- email: A valid e-mail address of the user. Automatic notifications are sent to this address. Is a required element (Email) in the target-xml.
- farbe: On graphical displays, shares of this user are highlighted with this color. The name should be a parsable name in MyColor.
- notify: A comma-separated list of strings identifying notification events that should be sent via e-mail to the user. Possible values are in KEY_NOTIFYALLOWED, currently the values in the Notify element in the target-xml file are supported. It can be overriden in the target-xml file as the Institution element.
- passwd: If the user provides his/her password, it is stored in plain ASCII. Recommended action is to supply the pubkey.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`UserSql.AddUser` Adds a new user with the command line.
`static class`	`UserSql.Circular` Mails to a number of stella users simultaneously.
`static class`	`UserSql.Recolor` Recalculates colors after too many users have been encountered.
`static class`	`UserSql.ResetPassword`
`static class`	`UserSql.RGB` Read all profiles and updates the farbe string.
`private static class`	`UserSql.SqlProfile` A user profile that is constructed from a database entry.

Nested classes/interfaces inherited from class mysql.AbstractSql
AbstractSql.Columns, AbstractSql.Extract

Nested classes/interfaces inherited from class util.PropertyResources
PropertyResources.Load, PropertyResources.URLResource

Field Summary

Fields
Modifier and Type	Field and Description
`private static EnumSet<DataPermission.Access>`	`AFFILACCESS` The default action on affil-data.
`private EnumSet<UserProfile.Affil>`	`affilallow` The set of allowed affiliations.
`private static String`	`DEFAFFILALLOWED` The coma-separated list of allowed affiliations.
`private static String`	`DEFAFFILFIELD` The key to the object name in the database.
`private static String`	`DEFCOLORFIELD` The key to the object name in the database.
`private static String`	`DEFEMAILFIELD` The key to the object name in the database.
`private static String`	`DEFNOTIFYALLOWED` The coma-separated list of allowed notification triggers.
`private static String`	`DEFNOTIFYFIELD` The key to the object name in the database.
`private static String`	`DEFPASSWDFIELD` The key to the object name in the database.
`private static String`	`DEFPUBKEYFIELD` The key to the object name in the database.
`private static String`	`DEFTABLE` The default table name.
`private static String`	`DEFUSERFIELD` The key to the object name in the database.
`static String`	`KEY_AFFILALLOWED` The key to the allowed affiliations.
`static String`	`KEY_AFFILFIELD` The key to the object name in the database.
`static String`	`KEY_COLORFIELD` The key to the object name in the database.
`static String`	`KEY_EMAILFIELD` The key to the object name in the database.
`static String`	`KEY_NOTIFYALLOWED` The key to the allowed notify actions.
`static String`	`KEY_NOTIFYFIELD` The key to the object name in the database.
`static String`	`KEY_PASSWDFIELD` The key to the object name in the database.
`static String`	`KEY_PUBKEYFIELD` The key to the object name in the database.
`static String`	`KEY_USERFIELD` The key to the object name in the database.
`private EnumSet<UserProfile.Notifies>`	`notifyallow` The set of allowed notifications.

Fields inherited from class mysql.AbstractSql
KEY_TABLE, SQLBATCHDIR, SQLFAILDIR

Fields inherited from class util.PropertyResources
KEY_NOINITONCREATE, POSTFIX_ALPHABET, POSTFIX_BYTES, POSTFIX_DIR, POSTFIX_EXT, POSTFIX_FILE, POSTFIX_LIST, POSTFIX_MODTIME, POSTFIX_URL

Fields inherited from class util.PropertyContainer
KEY_LISTSEPARATOR, KEY_MAPKEYVALUECHAR, KEY_MAPSEPARATOR

Fields inherited from interface util.ResourceSupplying
KEY_URLRESOURCES, KEY_URLUSECONFIG, KEY_URLUSECURRENT, KEY_URLUSEHOME

Fields inherited from interface util.PropertySupplying
CONFIG, KEY_CLASS

Constructor Summary

Constructors
Constructor and Description

UserSql(Map<String,String> prop)
Constructs a new proposal sql.

Constructors
Constructor and Description
`UserSql(Map<String,String> prop)` Constructs a new proposal sql.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`PermissionCollection`	`addUserPermissions(PermissionCollection permit, String user)` Add to a `PermissionCollection` the permissions for the user of the given name.
`boolean`	`addUserProfile(String username, List<UserProfile.Affil> aa, javax.mail.Address email, Collection<UserProfile.Notifies> notify)` Adds a new user to the table.
`boolean`	`addUserProfile(String username, List<UserProfile.Affil> aa, javax.mail.Address email, Collection<UserProfile.Notifies> notify, boolean mail)` Adds a new user to the table.
`boolean`	`addUserProfile(String username, List<UserProfile.Affil> affil, javax.mail.Address email, Collection<UserProfile.Notifies> notify, Color paint, boolean mail)` Adds a new user to the table.
`private boolean`	`addUserProfile(String username, List<UserProfile.Affil> affil, javax.mail.Address email, Collection<UserProfile.Notifies> notify, Color paint, String asciipass, boolean mail)` Adds a new user to the table.
`private UserProfile`	`fromNextRow(ResultSet single)` Returns the next user profile parsed from the result set.
`private static UserProfile`	`fromNextRow(ResultSet single, String f1, String f2, String f3, String f4, String f5, String f6, String f7)` Returns the next user profile parsed from the result set.
`static List<UserProfile>`	`getAllUserProfiles()` Returns all user profiles found.
`static List<UserProfile>`	`getAllUserProfiles(String table)` Returns all user profiles found.
`javax.mail.Address`	`getEmail(String name)`
`String`	`getInsertText(Map<String,Object> uu)`
`private int`	`getMemberCount(UserProfile.Affil affil)` Returns the number of entries to the queried affiliation.
`Color`	`getNextAffilColor(UserProfile.Affil aa)`
`String`	`getPendingText(Map<String,Object> uu)`
`private static String`	`getSubject(String username)`
`private static String`	`getText(String username, UserProfile.Affil affil, Collection<UserProfile.Notifies> notify, Color paint, String asciipass)`
`String`	`getUpdateText(Map<String,Object> uu)`
`UserProfile`	`getUserProfile(String name)` Returns the user profile from the user name.
`void`	`init()` Convert the properties of allowed affiliations and notifications into enum-sets.
`private String`	`resetPassword(String username)` For the stated user, auto-generate a password, MD5 encode and encrpyt it, store the encrypted versions in the DB and return the plain password (e.g., for sending e-mail to the user).
`private UserProfile`	`singleProfile(String where)` Convenience method returning just a single user profile.
`boolean`	`updatePassword(String username, String md5, String key)` For the stated user, update the password-relevant fields to the respective values.
`private List<UserProfile>`	`userProfiles(String where)`

Methods inherited from class mysql.AbstractSql
delete, distinct, distinct, exit, getAccess, getDefaultArchive, getDefaultFormat, getTable, insert, isEntry, release, release, replace, retrieve, retrieve, retrieve, single, single

Methods inherited from class util.PropertyResources
clone, createFrom, createFrom, createFrom, createInstance, getApplet, getAsResources, getLocate, getPropertiesToKey, getPropertiesToKey, getResource, getResourceAsStream, getResourceFromKey, getResources, hasLocalURLs, initProperties, keyCreate, keyCreate, reload, setApplet

Methods inherited from class util.PropertyContainer
augment, augment, augment, augment, augment, defaultBoolean, defaultChar, defaultDouble, defaultFloat, defaultInt, defaultLong, defaultObject, defaultObject, defaultProperties, defaultProperty, getAsBoolean, getAsChar, getAsDouble, getAsEnums, getAsFloat, getAsInt, getAsList, getAsLong, getAsMap, getAsMap, getAsObject, getAsObject, getProperties, getProperty, has, isNew, parseObject, parseObject, reload, removeProperty, requires, rescanned, setObject, setProperties, setProperty, stringProperties, toString

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface util.PropertySupplying
defaultBoolean, defaultChar, defaultDouble, defaultFloat, defaultInt, defaultLong, defaultObject, defaultObject, defaultProperties, defaultProperty, getAsBoolean, getAsChar, getAsDouble, getAsFloat, getAsInt, getAsList, getAsLong, getAsMap, getAsObject, getAsObject, getProperties, getProperty, has, parseObject, removeProperty, setObject, setProperty, stringProperties

Field Detail
- KEY_USERFIELD
```
public static final String KEY_USERFIELD
```
  The key to the object name in the database.
  
  See Also:
  
  Constant Field Values
- KEY_AFFILFIELD
```
public static final String KEY_AFFILFIELD
```
  The key to the object name in the database.
  
  See Also:
  
  Constant Field Values
- KEY_PUBKEYFIELD
```
public static final String KEY_PUBKEYFIELD
```
  The key to the object name in the database.
  
  See Also:
  
  Constant Field Values
- KEY_EMAILFIELD
```
public static final String KEY_EMAILFIELD
```
  The key to the object name in the database.
  
  See Also:
  
  Constant Field Values
- KEY_COLORFIELD
```
public static final String KEY_COLORFIELD
```
  The key to the object name in the database.
  
  See Also:
  
  Constant Field Values
- KEY_NOTIFYFIELD
```
public static final String KEY_NOTIFYFIELD
```
  The key to the object name in the database.
  
  See Also:
  
  Constant Field Values
- KEY_PASSWDFIELD
```
public static final String KEY_PASSWDFIELD
```
  The key to the object name in the database.
  
  See Also:
  
  Constant Field Values
- KEY_AFFILALLOWED
```
public static final String KEY_AFFILALLOWED
```
  The key to the allowed affiliations.
  
  See Also:
  
  Constant Field Values
- KEY_NOTIFYALLOWED
```
public static final String KEY_NOTIFYALLOWED
```
  The key to the allowed notify actions.
  
  See Also:
  
  Constant Field Values
- DEFTABLE
```
private static final String DEFTABLE
```
  The default table name. Fuckin' reserved word used.
  
  See Also:
  
  Constant Field Values
- DEFUSERFIELD
```
private static final String DEFUSERFIELD
```
  The key to the object name in the database. Reserved word used.
  
  See Also:
  
  Constant Field Values
- DEFAFFILFIELD
```
private static final String DEFAFFILFIELD
```
  The key to the object name in the database.
  
  See Also:
  
  Constant Field Values
- DEFPUBKEYFIELD
```
private static final String DEFPUBKEYFIELD
```
  The key to the object name in the database.
  
  See Also:
  
  Constant Field Values
- DEFEMAILFIELD
```
private static final String DEFEMAILFIELD
```
  The key to the object name in the database.
  
  See Also:
  
  Constant Field Values
- DEFCOLORFIELD
```
private static final String DEFCOLORFIELD
```
  The key to the object name in the database.
  
  See Also:
  
  Constant Field Values
- DEFNOTIFYFIELD
```
private static final String DEFNOTIFYFIELD
```
  The key to the object name in the database.
  
  See Also:
  
  Constant Field Values
- DEFPASSWDFIELD
```
private static final String DEFPASSWDFIELD
```
  The key to the object name in the database.
  
  See Also:
  
  Constant Field Values
- DEFAFFILALLOWED
```
private static final String DEFAFFILALLOWED
```
  The coma-separated list of allowed affiliations.
- DEFNOTIFYALLOWED
```
private static final String DEFNOTIFYALLOWED
```
  The coma-separated list of allowed notification triggers.
- AFFILACCESS
```
private static final EnumSet<DataPermission.Access> AFFILACCESS
```
  The default action on affil-data.
- affilallow
```
private EnumSet<UserProfile.Affil> affilallow
```
  The set of allowed affiliations.
- notifyallow
```
private EnumSet<UserProfile.Notifies> notifyallow
```
  The set of allowed notifications.

Constructor Detail
- UserSql
```
public UserSql(Map<String,String> prop)
```
  Constructs a new proposal sql.

Method Detail

init
```
public void init()
          throws InitException
```
Convert the properties of allowed affiliations and notifications into enum-sets.

Specified by:

init in interface Initializable

Overrides:

init in class AbstractSql

Throws:

InitException

addUserPermissions
```
public PermissionCollection addUserPermissions(PermissionCollection permit,
                                               String user)
```
Add to a PermissionCollection the permissions for the user of the given name. Uses a global permission on user's PI targets plus specific permissions found in the permission table. Additionally adds the group-specific affiliations.

Returns:

The augmented permission collection.

Throws:

SecurityException - if the permission collection is read-only.

getEmail

public javax.mail.Address getEmail(String name)
                            throws SQLException

Throws:: SQLException

getUserProfile
```
public UserProfile getUserProfile(String name)
```
Returns the user profile from the user name.

singleProfile
```
private UserProfile singleProfile(String where)
```
Convenience method returning just a single user profile. If where clause returns more than a single row, result is unspecified.

Parameters:

where -

Returns:

userProfiles

private List<UserProfile> userProfiles(String where)

fromNextRow
```
private UserProfile fromNextRow(ResultSet single)
                         throws SQLException
```
Returns the next user profile parsed from the result set. The result set is advanced to the next row. Null is returned if no more data has been encountered.

Throws:

SQLException

fromNextRow

private static UserProfile fromNextRow(ResultSet single,
                                       String f1,
                                       String f2,
                                       String f3,
                                       String f4,
                                       String f5,
                                       String f6,
                                       String f7)
                                throws SQLException

Returns the next user profile parsed from the result set. The result set is advanced to the next row. Null is returned if no more data has been encountered.

Throws:: SQLException

getAllUserProfiles

public static List<UserProfile> getAllUserProfiles()

Returns all user profiles found.

getAllUserProfiles

public static List<UserProfile> getAllUserProfiles(String table)

Returns all user profiles found.

updatePassword
```
public boolean updatePassword(String username,
                              String md5,
                              String key)
                       throws SQLException
```
For the stated user, update the password-relevant fields to the respective values. Encryption has already commenced.

Parameters:

username - The name of the user, not the e-mail.

md5 - The md5-coded password (hex-string, lower case)

key - The unix-MD5 encrypted password for /etc/shadow

Returns:

True on success

Throws:

SQLException

resetPassword
```
private String resetPassword(String username)
                      throws SQLException
```
For the stated user, auto-generate a password, MD5 encode and encrpyt it, store the encrypted versions in the DB and return the plain password (e.g., for sending e-mail to the user).

Parameters:

username - The name of the user, not the e-mail.

Returns:

The plain password

Throws:

SQLException

addUserProfile
```
public boolean addUserProfile(String username,
                              List<UserProfile.Affil> aa,
                              javax.mail.Address email,
                              Collection<UserProfile.Notifies> notify)
```
Adds a new user to the table. If the color is not specified, we try to guess it from the affiliation. This method sends notification to the user on first entry.

Returns:

true, if user was added.

Throws:

IllegalArgumentException - If any of the input is not allowed. This applies to affil, email and notify.

addUserProfile

public boolean addUserProfile(String username,
                              List<UserProfile.Affil> aa,
                              javax.mail.Address email,
                              Collection<UserProfile.Notifies> notify,
                              boolean mail)

Adds a new user to the table. If the color is not specified, we try to guess it from the affiliation.

Returns:: true, if user was added.
Throws:: IllegalArgumentException - If any of the input is not allowed. This applies to affil, email and notify.

getNextAffilColor

public Color getNextAffilColor(UserProfile.Affil aa)

addUserProfile

public boolean addUserProfile(String username,
                              List<UserProfile.Affil> affil,
                              javax.mail.Address email,
                              Collection<UserProfile.Notifies> notify,
                              Color paint,
                              boolean mail)

Adds a new user to the table. If the color is not specified, we try to guess it from the affiliation.

Returns:: true, if user was added.
Throws:: IllegalArgumentException - If any of the input is not allowed. This applies to affil, email and notify.

addUserProfile

private boolean addUserProfile(String username,
                               List<UserProfile.Affil> affil,
                               javax.mail.Address email,
                               Collection<UserProfile.Notifies> notify,
                               Color paint,
                               String asciipass,
                               boolean mail)

Adds a new user to the table. If the color is not specified, we try to guess it from the affiliation.

Returns:: true, if user was added.
Throws:: IllegalArgumentException - If any of the input is not allowed. This applies to affil, email and notify.

getSubject

private static String getSubject(String username)

getText

private static String getText(String username,
                              UserProfile.Affil affil,
                              Collection<UserProfile.Notifies> notify,
                              Color paint,
                              String asciipass)

getUpdateText

public String getUpdateText(Map<String,Object> uu)

getInsertText

public String getInsertText(Map<String,Object> uu)

getPendingText

public String getPendingText(Map<String,Object> uu)

getMemberCount
```
private int getMemberCount(UserProfile.Affil affil)
```
Returns the number of entries to the queried affiliation.

Class UserSql

Nested Class Summary

Nested classes/interfaces inherited from class mysql.AbstractSql

Nested classes/interfaces inherited from class util.PropertyResources

Field Summary

Fields inherited from class mysql.AbstractSql

Fields inherited from class util.PropertyResources

Fields inherited from class util.PropertyContainer

Fields inherited from interface util.ResourceSupplying

Fields inherited from interface util.PropertySupplying

Constructor Summary

Method Summary

Methods inherited from class mysql.AbstractSql

Methods inherited from class util.PropertyResources

Methods inherited from class util.PropertyContainer

Methods inherited from class java.lang.Object

Methods inherited from interface util.PropertySupplying

Field Detail

KEY_USERFIELD

KEY_AFFILFIELD

KEY_PUBKEYFIELD

KEY_EMAILFIELD

KEY_COLORFIELD

KEY_NOTIFYFIELD

KEY_PASSWDFIELD

KEY_AFFILALLOWED

KEY_NOTIFYALLOWED

DEFTABLE

DEFUSERFIELD

DEFAFFILFIELD

DEFPUBKEYFIELD

DEFEMAILFIELD

DEFCOLORFIELD

DEFNOTIFYFIELD

DEFPASSWDFIELD

DEFAFFILALLOWED

DEFNOTIFYALLOWED

AFFILACCESS

affilallow

notifyallow

Constructor Detail

UserSql

Method Detail

init

addUserPermissions

getEmail

getUserProfile

singleProfile

userProfiles

fromNextRow

fromNextRow

getAllUserProfiles

getAllUserProfiles

updatePassword

resetPassword

addUserProfile

addUserProfile

getNextAffilColor

addUserProfile

addUserProfile

getSubject

getText

getUpdateText

getInsertText

getPendingText

getMemberCount