org.basex.core
Class Users

java.lang.Object
  extended by org.basex.core.Users

public final class Users
extends java.lang.Object

This class organizes all users.

Author:
BaseX Team 2005-12, BSD License, Christian Gruen

Constructor Summary
Users(Context ctx)
          Constructor for global users.
 
Method Summary
 boolean alter(java.lang.String usern, java.lang.String pass)
          Changes the password of a user.
 boolean create(java.lang.String usern, java.lang.String pass)
          Stores a user and encrypted password.
 boolean create(User user)
          Adds the specified user.
 boolean drop(User user)
          Drops a user from the list.
 java.lang.String[] find(java.util.regex.Pattern pattern)
          Returns all users that match the specified pattern.
 User get(java.lang.String usern)
          Returns a user reference with the specified name.
 Table info(Users users)
          Returns information on all users.
 void read(DataInput in)
          Reads users from disk.
 User[] users(Users users)
          Returns all users.
 void write()
          Writes global permissions to disk.
 void write(DataOutput out)
          Writes permissions to disk.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Users

public Users(Context ctx)
Constructor for global users.

Parameters:
ctx - database context (null if instance is local)
Method Detail

read

public void read(DataInput in)
          throws java.io.IOException
Reads users from disk.

Parameters:
in - input stream
Throws:
java.io.IOException - I/O exception

write

public void write()
Writes global permissions to disk.


create

public boolean create(java.lang.String usern,
                      java.lang.String pass)
Stores a user and encrypted password.

Parameters:
usern - user name
pass - password
Returns:
success of operation

create

public boolean create(User user)
Adds the specified user.

Parameters:
user - user to be added
Returns:
success of operation

alter

public boolean alter(java.lang.String usern,
                     java.lang.String pass)
Changes the password of a user.

Parameters:
usern - user name
pass - password
Returns:
success of operation

drop

public boolean drop(User user)
Drops a user from the list.

Parameters:
user - user reference
Returns:
success flag

get

public User get(java.lang.String usern)
Returns a user reference with the specified name.

Parameters:
usern - user name
Returns:
success of operation

find

public java.lang.String[] find(java.util.regex.Pattern pattern)
Returns all users that match the specified pattern.

Parameters:
pattern - user pattern
Returns:
user list

write

public void write(DataOutput out)
           throws java.io.IOException
Writes permissions to disk.

Parameters:
out - output stream; if set to null, the global rights are written
Throws:
java.io.IOException - I/O exception

info

public Table info(Users users)
Returns information on all users.

Parameters:
users - optional global user list (for ignoring obsolete local users)
Returns:
user information

users

public User[] users(Users users)
Returns all users.

Parameters:
users - optional second list
Returns:
user information