org.dlese.dpc.schemedit.security.user

Class User

java.lang.Object

org.dlese.dpc.schemedit.security.user.User

public class User
extends java.lang.Object

Class that represents a registered DCS User, including attributes, roles and preferences.

Note: passwords are not stored with the User objects.

Author:

ostwald

Constructor Summary

Constructors

Constructor and Description
User() No-argument Constructor for the User object
User(java.io.File source) Constructor for the User object

Method Summary

Modifier and Type	Method and Description
boolean	controls(Roles.Role role, java.lang.String collection) Does this user have a role higher than the provided for the specified collection
void	deletePref(java.lang.String name) Delete a rref (if the collection is not the default collection)
void	deleteRole(java.lang.String collection) Delete a role (if the collection is not the default collection)
void	destroy() Destroy the datastructures for this User object
void	flush() Write this User to disk and reset data structures so they will be reloaded from disk.
Roles.Role	getAssignedRole(java.lang.String collection) Return the role that has been explicitly assigned to the specified collection.
java.lang.String	getDepartment() Gets the department attribute of the User object
java.lang.String	getEmail() Return the from address.
java.lang.String	getFirstName() Gets the firstName attribute of the User object
java.lang.String	getFullName() Gets the fullName attribute of the User object
java.lang.String	getInstitution() Gets the institution attribute of the User object
boolean	getIsAdminUser() Returns true of this user is an admin
java.lang.String	getLastName() Gets the lastName attribute of the User object
Roles.Role	getMaxRole() Gets the maxRole attribute of the User object
java.lang.String	getPref(java.lang.String prefname) Gets the pref attribute of the User object
java.util.Map	getPrefMap() Gets the roleMap attribute of the User object
Roles.Role	getRole(java.lang.String collection) Gets the effective role for this collection, meaning if there is no explicit role assigned, use the default.
java.util.Map	getRoleMap() Gets the roleMap attribute of the User object
java.io.File	getSource() Gets the file for this user object
java.lang.String	getUsername() Return the username.
boolean	hasRole(Roles.Role role) Returns true if this User has a role statisfying provided Role in any collection.
boolean	hasRole(Roles.Role role, java.lang.String collection) Returns true if this User has at least the specified role in the specified collection
boolean	hasRole(java.lang.String roleStr) NOT YET DOCUMENTED
boolean	hasRole(java.lang.String roleStr, java.lang.String collection) Returns true if this User has a role statisfying provided Role in the specified collection.
boolean	isAdminUser() Returns true of this user is an admin
static void	main(java.lang.String[] args) The main program for the User class
java.lang.String	nonNullValue(java.lang.String s) NOT YET DOCUMENTED
protected static void	prtln(java.lang.String s) NOT YET DOCUMENTED
void	setAdminUser(boolean isAdmin) Sets the adminUser attribute of the User object
void	setDepartment(java.lang.String department) Sets the department attribute of the User object
void	setEmail(java.lang.String email) Set the from address.
void	setFirstName(java.lang.String firstName) Sets the firstName attribute of the User object
void	setInstitution(java.lang.String institution) Sets the institution attribute of the User object
void	setLastName(java.lang.String lastName) Sets the lastName attribute of the User object
void	setPref(java.lang.String name, java.lang.String val) Set the User's rref for specified collection.
void	setRole(java.lang.String collection, Roles.Role role) Set the User's role for specified collection.
void	setSource(java.io.File file) Sets the file path for this object (where it is flushed).
void	setUsername(java.lang.String username) Set the username.
java.lang.String	toString() NOT YET DOCUMENTED

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

User

public User(java.io.File source)
     throws java.lang.Exception

Constructor for the User object

Parameters:

source - User data file

Throws:

java.lang.Exception - if the user cannot be instantiated

User

public User()
     throws java.lang.Exception

No-argument Constructor for the User object

Throws:

java.lang.Exception - Description of the Exception

Method Detail

getSource

public java.io.File getSource()

Gets the file for this user object

Returns:

The source value

setSource

public void setSource(java.io.File file)

Sets the file path for this object (where it is flushed).

Parameters:

file - The new source value

getUsername

public java.lang.String getUsername()

Return the username.

Returns:

The username value

setUsername

public void setUsername(java.lang.String username)

Set the username.

Parameters:

username - The new username

getEmail

public java.lang.String getEmail()

Return the from address.

Returns:

The email value

setEmail

public void setEmail(java.lang.String email)

Set the from address.

Parameters:

email - The new from address

getFirstName

public java.lang.String getFirstName()

Gets the firstName attribute of the User object

Returns:

The firstName value

setFirstName

public void setFirstName(java.lang.String firstName)

Sets the firstName attribute of the User object

Parameters:

firstName - The new firstName value

getLastName

public java.lang.String getLastName()

Gets the lastName attribute of the User object

Returns:

The lastName value

setLastName

public void setLastName(java.lang.String lastName)

Sets the lastName attribute of the User object

Parameters:

lastName - The new lastName value

getFullName

public java.lang.String getFullName()

Gets the fullName attribute of the User object

Returns:

The fullName value

getInstitution

public java.lang.String getInstitution()

Gets the institution attribute of the User object

Returns:

The institution value

setInstitution

public void setInstitution(java.lang.String institution)

Sets the institution attribute of the User object

Parameters:

institution - The new institution value

getDepartment

public java.lang.String getDepartment()

Gets the department attribute of the User object

Returns:

The department value

setDepartment

public void setDepartment(java.lang.String department)

Sets the department attribute of the User object

Parameters:

department - The new department value

getPrefMap

public java.util.Map getPrefMap()

Gets the roleMap attribute of the User object

Returns:

The prefMap value

getPref

public java.lang.String getPref(java.lang.String prefname)

Gets the pref attribute of the User object

Parameters:

prefname - Description of the Parameter

Returns:

The pref value

setPref

public void setPref(java.lang.String name,
                    java.lang.String val)

Set the User's rref for specified collection.

If the rref to set is the same as the User's default rref, then delete the rref for the specified collection (effectively setting it, since calls to getPref for that collection will return the default rref).

Parameters:

name - The new pref value

val - The new pref value

deletePref

public void deletePref(java.lang.String name)

Delete a rref (if the collection is not the default collection)

Parameters:

name - Description of the Parameter

getMaxRole

public Roles.Role getMaxRole()

Gets the maxRole attribute of the User object

Returns:

The maxRole value

getAssignedRole

public Roles.Role getAssignedRole(java.lang.String collection)

Return the role that has been explicitly assigned to the specified collection. Returns null if there is no assignment.

Parameters:

collection - NOT YET DOCUMENTED

Returns:

The assignedRole value

getRole

public Roles.Role getRole(java.lang.String collection)

Gets the effective role for this collection, meaning if there is no explicit role assigned, use the default.

Parameters:

collection - the collection

Returns:

The role value

hasRole

public boolean hasRole(java.lang.String roleStr)

NOT YET DOCUMENTED

Parameters:

roleStr - NOT YET DOCUMENTED

Returns:

NOT YET DOCUMENTED

hasRole

public boolean hasRole(java.lang.String roleStr,
                       java.lang.String collection)

Returns true if this User has a role statisfying provided Role in the specified collection.

Parameters:

roleStr - specified role (as string)

collection - the collection

Returns:

true if the user has permission for this collection

hasRole

public boolean hasRole(Roles.Role role)

Returns true if this User has a role statisfying provided Role in any collection.

Parameters:

role - specified role

Returns:

true if this User has a role statisfying provided Role in any collection

hasRole

public boolean hasRole(Roles.Role role,
                       java.lang.String collection)

Returns true if this User has at least the specified role in the specified collection

Parameters:

role - the role

collection - the collection

Returns:

NOT YET DOCUMENTED

setAdminUser

public void setAdminUser(boolean isAdmin)

Sets the adminUser attribute of the User object

Parameters:

isAdmin - The new adminUser value

isAdminUser

public boolean isAdminUser()

Returns true of this user is an admin

Returns:

The adminUser value

getIsAdminUser

public boolean getIsAdminUser()

Returns true of this user is an admin

Returns:

The isAdminUser value

controls

public boolean controls(Roles.Role role,
                        java.lang.String collection)

Does this user have a role higher than the provided for the specified collection

Parameters:

role - NOT YET DOCUMENTED

collection - NOT YET DOCUMENTED

Returns:

NOT YET DOCUMENTED

setRole

public void setRole(java.lang.String collection,
                    Roles.Role role)

Set the User's role for specified collection.

If the role to set is the same as the User's default role, then delete the role for the specified collection (effectively setting it, since calls to getRole for that collection will return the default role).

Parameters:

collection - The new role value

role - The new role value

deleteRole

public void deleteRole(java.lang.String collection)

Delete a role (if the collection is not the default collection)

Parameters:

collection - NOT YET DOCUMENTED

getRoleMap

public java.util.Map getRoleMap()

Gets the roleMap attribute of the User object

Returns:

The roleMap value

nonNullValue

public java.lang.String nonNullValue(java.lang.String s)

NOT YET DOCUMENTED

Parameters:

s - NOT YET DOCUMENTED

Returns:

NOT YET DOCUMENTED

toString

public java.lang.String toString()

NOT YET DOCUMENTED

Overrides:

toString in class java.lang.Object

Returns:

NOT YET DOCUMENTED

flush

public void flush()
           throws java.lang.Exception

Write this User to disk and reset data structures so they will be reloaded from disk.

Throws:

java.lang.Exception - Description of the Exception

destroy

public void destroy()

Destroy the datastructures for this User object

main

public static void main(java.lang.String[] args)
                 throws java.lang.Exception

The main program for the User class

Parameters:

args - The command line arguments

Throws:

java.lang.Exception - Description of the Exception

prtln

protected static void prtln(java.lang.String s)

NOT YET DOCUMENTED

Parameters:

s - NOT YET DOCUMENTED