org.eaglei.repository.auth
Interface AuthUser

All Known Implementing Classes:

AuthUserTomcat

public interface AuthUser

Outline of instance in pluggable authentication user database

Author:

Larry Stone Started March 2011

See Also:

AuthUserTomcat

Method Summary

boolean	authenticate(java.lang.String s) authentication test
void	commit() Commit all changes to java model objects into actual DB (actual effect varies with implementation)
void	create() Create entry for this model of a user in the auth database
void	delete() Obliterate all record of this authentication user
java.lang.String	getPassword() Getter for password
java.lang.String	getUsername() Getter for username
boolean	isSuperuser() Getter for Administrator state
void	setIsSuperuser(boolean b) Setter for isSuperuser flag
void	setPassword(java.lang.String s) Setter for password

Method Detail

getUsername

java.lang.String getUsername()

Getter for username

Returns:

the login name

getPassword

java.lang.String getPassword()

Getter for password

Returns:

the password or null if not used by this implementation

isSuperuser

boolean isSuperuser()

Getter for Administrator state

Returns:

true if this is an Administrator user (Superuesr)

setPassword

void setPassword(java.lang.String s)

Setter for password

Parameters:

s - new value, must be a string if this implementation uses passwords

setIsSuperuser

void setIsSuperuser(boolean b)

Setter for isSuperuser flag

Parameters:

b - new value, true means superuser

authenticate

boolean authenticate(java.lang.String s)

authentication test

Parameters:

s - credential value, i.e. password

Returns:

true if credential matches

delete

void delete()

Obliterate all record of this authentication user

create

void create()

Create entry for this model of a user in the auth database

commit

void commit()
            throws javax.servlet.ServletException

Commit all changes to java model objects into actual DB (actual effect varies with implementation)

Throws:

javax.servlet.ServletException