net.yacy.data

Class UserDB

java.lang.Object

net.yacy.data.UserDB

public final class UserDB
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	UserDB.AccessRight
class	UserDB.Entry
class	UserDB.userIterator

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.Map<java.lang.String,java.lang.Object>	cookieUsers
private java.util.Map<java.lang.String,java.lang.String>	ipUsers
private static int	USERNAME_MIN_LENGTH
private MapHeap	userTable
private java.io.File	userTableFile

Constructor Summary

Constructors

Constructor and Description
UserDB(java.io.File userTableFile)

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	addEntry(UserDB.Entry entry)
void	adminLogout(java.lang.String logintoken)
void	close()
boolean	cookieAdminAuth(java.lang.String cookieString)
UserDB.Entry	cookieAuth(java.lang.String cookieString)
UserDB.Entry	createEntry(java.lang.String userName, java.util.Map<java.lang.String,java.lang.String> userProps)
java.lang.String	getAdminCookie()
java.lang.String	getCookie(UserDB.Entry entry)
UserDB.Entry	getEntry(java.lang.String userName)
static java.lang.String	getLoginToken(java.lang.String cookies)
UserDB.Entry	getUser(RequestHeader header)
UserDB.Entry	getUser(java.lang.String auth, java.lang.String cookies)
boolean	hasAdminRight(java.lang.String auth, java.lang.String cookies) Determine if a user has admin rights from a authorisation http-headerfield.
UserDB.Entry	ipAuth(java.lang.String ip) Authenticate a user by ip, if he has used proxyAuth in the last 10 minutes.
java.util.Iterator<UserDB.Entry>	iterator(boolean up)
UserDB.Entry	md5Auth(java.lang.String user, java.lang.String md5)
UserDB.Entry	passwordAuth(java.lang.String user, java.lang.String password)
UserDB.Entry	passwordAuth(java.lang.String user, java.lang.String password, java.lang.String ip)
UserDB.Entry	proxyAuth(java.lang.String auth) Use a ProxyAuth Value to authenticate user.
UserDB.Entry	proxyAuth(java.lang.String auth, java.lang.String ip) Use ProxyAuth String to authenticate user and save IP/username for ipAuth.
void	removeEntry(java.lang.String hostName)
(package private) void	resetDatabase()
int	size()

Methods inherited from class java.lang.Object

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

Field Detail

USERNAME_MIN_LENGTH

private static final int USERNAME_MIN_LENGTH

See Also:

Constant Field Values

userTable

private MapHeap userTable

userTableFile

private final java.io.File userTableFile

ipUsers

private final java.util.Map<java.lang.String,java.lang.String> ipUsers

cookieUsers

private final java.util.Map<java.lang.String,java.lang.Object> cookieUsers

Constructor Detail

UserDB

public UserDB(java.io.File userTableFile)
       throws java.io.IOException

Throws:

java.io.IOException

Method Detail

resetDatabase

void resetDatabase()

close

public void close()

size

public int size()

removeEntry

public void removeEntry(java.lang.String hostName)

getEntry

public UserDB.Entry getEntry(java.lang.String userName)

createEntry

public UserDB.Entry createEntry(java.lang.String userName,
                       java.util.Map<java.lang.String,java.lang.String> userProps)
                         throws java.lang.IllegalArgumentException

Throws:

java.lang.IllegalArgumentException

addEntry

public java.lang.String addEntry(UserDB.Entry entry)

proxyAuth

public UserDB.Entry proxyAuth(java.lang.String auth)

Use a ProxyAuth Value to authenticate user.

Parameters:

auth - base64 Encoded String, which contains "username:pw".

getUser

public UserDB.Entry getUser(RequestHeader header)

getUser

public UserDB.Entry getUser(java.lang.String auth,
                   java.lang.String cookies)

hasAdminRight

public boolean hasAdminRight(java.lang.String auth,
                    java.lang.String cookies)

Determine if a user has admin rights from a authorisation http-headerfield. Tests both userDB and old style adminpw.

Parameters:

auth - http-headerline for authorisation.

cookies -

proxyAuth

public UserDB.Entry proxyAuth(java.lang.String auth,
                     java.lang.String ip)

Use ProxyAuth String to authenticate user and save IP/username for ipAuth.

Parameters:

auth - base64 Encoded String, which contains "username:pw".

ip - IP address.

ipAuth

public UserDB.Entry ipAuth(java.lang.String ip)

Authenticate a user by ip, if he has used proxyAuth in the last 10 minutes.

Parameters:

ip - IP address of user.

passwordAuth

public UserDB.Entry passwordAuth(java.lang.String user,
                        java.lang.String password)

passwordAuth

public UserDB.Entry passwordAuth(java.lang.String user,
                        java.lang.String password,
                        java.lang.String ip)

md5Auth

public UserDB.Entry md5Auth(java.lang.String user,
                   java.lang.String md5)

cookieAuth

public UserDB.Entry cookieAuth(java.lang.String cookieString)

cookieAdminAuth

public boolean cookieAdminAuth(java.lang.String cookieString)

getCookie

public java.lang.String getCookie(UserDB.Entry entry)

getAdminCookie

public java.lang.String getAdminCookie()

getLoginToken

public static java.lang.String getLoginToken(java.lang.String cookies)

adminLogout

public void adminLogout(java.lang.String logintoken)

iterator

public java.util.Iterator<UserDB.Entry> iterator(boolean up)