org.exist.xmldb
Interface UserManagementService

All Superinterfaces:

org.xmldb.api.base.Configurable, org.xmldb.api.base.Service

All Known Implementing Classes:

LocalUserManagementService, RemoteUserManagementService

public interface UserManagementService
extends org.xmldb.api.base.Service

An eXist-specific service which provides methods to manage users and permissions.

Author:

Wolfgang Meier Modified by {Marco.Tampucci, Massimo.Martinelli} @isti.cnr.it

Method Summary

void	addUser(User user) Add a new user to the database
void	addUserGroup(User user) Update the specified user without update user's password Method added by {Marco.Tampucci, Massimo.Martinelli} @isti.cnr.it
void	chmod(int mode)
void	chmod(org.xmldb.api.base.Resource resource, int mode) Change permissions for the specified resource.
void	chmod(org.xmldb.api.base.Resource resource, String modeStr) Change permissions for the specified resource.
void	chmod(String modeStr) Change permissions for the current collection
void	chown(org.xmldb.api.base.Resource res, User u, String group) Change owner and group of the specified resource.
void	chown(User u, String group) Change owner and group of the current collection.
String[]	getGroups() Retrieve a list of all existing groups.
String	getName() Get the name of this service
Permission	getPermissions(org.xmldb.api.base.Collection coll) Get permissions for the specified collections
Permission	getPermissions(org.xmldb.api.base.Resource res) Get permissions for the specified resource
String	getProperty(String property) Get a property defined by this service.
User	getUser(String name) Get a user record from the database
User[]	getUsers() Retrieve a list of all existing users.
String	getVersion() Get the version of this service
String	hasUserLock(org.xmldb.api.base.Resource res) Check if the resource has a user lock.
Permission[]	listCollectionPermissions() Get permissions for all child collections contained in the current collection.
Permission[]	listResourcePermissions() Get permissions for all resources contained in the current collection.
void	lockResource(org.xmldb.api.base.Resource res, User u) Lock the specified resource for the specified user.
void	removeGroup(User user, String rmgroup) Update the specified user removing a group from user's group Method added by {Marco.Tampucci, Massimo.Martinelli} @isti.cnr.it
void	removeUser(User user) Delete a user from the database
void	setCollection(org.xmldb.api.base.Collection collection) Set the current collection for this service
void	setPermissions(org.xmldb.api.base.Collection child, Permission perm) Set permissions for the specified collection.
void	setPermissions(org.xmldb.api.base.Resource resource, Permission perm) Set permissions for the specified resource.
void	setProperty(String property, String value) Set a property for this service.
void	unlockResource(org.xmldb.api.base.Resource res) Unlock the specified resource.
void	updateUser(User user) Update existing user information

Method Detail

getName

String getName()

Get the name of this service

Specified by:

getName in interface org.xmldb.api.base.Service

Returns:

The name

getVersion

String getVersion()

Get the version of this service

Specified by:

getVersion in interface org.xmldb.api.base.Service

Returns:

The version value

setPermissions

void setPermissions(org.xmldb.api.base.Collection child,
                    Permission perm)
                    throws org.xmldb.api.base.XMLDBException

Set permissions for the specified collection.

Parameters:

child -

perm -

Throws:

org.xmldb.api.base.XMLDBException

setPermissions

void setPermissions(org.xmldb.api.base.Resource resource,
                    Permission perm)
                    throws org.xmldb.api.base.XMLDBException

Set permissions for the specified resource.

Parameters:

resource -

perm -

Throws:

org.xmldb.api.base.XMLDBException

chown

void chown(User u,
           String group)
           throws org.xmldb.api.base.XMLDBException

Change owner and group of the current collection.

Parameters:

u - Description of the Parameter

group - Description of the Parameter

Throws:

org.xmldb.api.base.XMLDBException - Description of the Exception

chown

void chown(org.xmldb.api.base.Resource res,
           User u,
           String group)
           throws org.xmldb.api.base.XMLDBException

Change owner and group of the specified resource.

Parameters:

res - Description of the Parameter

u - Description of the Parameter

group - Description of the Parameter

Throws:

org.xmldb.api.base.XMLDBException - Description of the Exception

chmod

void chmod(org.xmldb.api.base.Resource resource,
           String modeStr)
           throws org.xmldb.api.base.XMLDBException

Change permissions for the specified resource. Permissions are specified in a string according to the following format:

[user|group|other]=[+|-][read|write|update]

For example, to grant all permissions to the group and deny everything to others: group=+write,+read,+update,other=-read The changes are applied to the permissions currently active for this resource.

Parameters:

resource - Description of the Parameter

modeStr - Description of the Parameter

Throws:

org.xmldb.api.base.XMLDBException - Description of the Exception

chmod

void chmod(String modeStr)
           throws org.xmldb.api.base.XMLDBException

Change permissions for the current collection

Parameters:

modeStr - String describing the permissions to grant or deny.

Throws:

org.xmldb.api.base.XMLDBException

chmod

void chmod(int mode)
           throws org.xmldb.api.base.XMLDBException

Throws:

org.xmldb.api.base.XMLDBException

chmod

void chmod(org.xmldb.api.base.Resource resource,
           int mode)
           throws org.xmldb.api.base.XMLDBException

Change permissions for the specified resource.

Throws:

org.xmldb.api.base.XMLDBException

lockResource

void lockResource(org.xmldb.api.base.Resource res,
                  User u)
                  throws org.xmldb.api.base.XMLDBException

Lock the specified resource for the specified user. A locked resource cannot be changed by other users (except users in group DBA) until the lock is released. Users with admin privileges can always change a resource.

Parameters:

res -

u -

Throws:

org.xmldb.api.base.XMLDBException

hasUserLock

String hasUserLock(org.xmldb.api.base.Resource res)
                   throws org.xmldb.api.base.XMLDBException

Check if the resource has a user lock. Returns the name of the owner of the lock or null if no lock has been set on the resource.

Parameters:

res -

Returns:

Name of the owner of the lock

Throws:

org.xmldb.api.base.XMLDBException

unlockResource

void unlockResource(org.xmldb.api.base.Resource res)
                    throws org.xmldb.api.base.XMLDBException

Unlock the specified resource. The current user has to be same who locked the resource. Exception: admin users can always unlock a resource.

Parameters:

res -

Throws:

org.xmldb.api.base.XMLDBException

addUser

void addUser(User user)
             throws org.xmldb.api.base.XMLDBException

Add a new user to the database

Parameters:

user - The feature to be added to the User attribute

Throws:

org.xmldb.api.base.XMLDBException - Description of the Exception

updateUser

void updateUser(User user)
                throws org.xmldb.api.base.XMLDBException

Update existing user information

Parameters:

user - Description of the Parameter

Throws:

org.xmldb.api.base.XMLDBException - Description of the Exception

getUser

User getUser(String name)
             throws org.xmldb.api.base.XMLDBException

Get a user record from the database

Parameters:

name - Description of the Parameter

Returns:

The user value

Throws:

org.xmldb.api.base.XMLDBException - Description of the Exception

getUsers

User[] getUsers()
                throws org.xmldb.api.base.XMLDBException

Retrieve a list of all existing users.

Returns:

The users value

Throws:

org.xmldb.api.base.XMLDBException - Description of the Exception

getGroups

String[] getGroups()
                   throws org.xmldb.api.base.XMLDBException

Retrieve a list of all existing groups. Please note: new groups are created automatically if a new group is assigned to a user. You can't add or remove them.

Returns:

List of all existing groups.

Throws:

org.xmldb.api.base.XMLDBException

getProperty

String getProperty(String property)
                   throws org.xmldb.api.base.XMLDBException

Get a property defined by this service.

Specified by:

getProperty in interface org.xmldb.api.base.Configurable

Parameters:

property - Description of the Parameter

Returns:

The property value

Throws:

org.xmldb.api.base.XMLDBException - Description of the Exception

setProperty

void setProperty(String property,
                 String value)
                 throws org.xmldb.api.base.XMLDBException

Set a property for this service.

Specified by:

setProperty in interface org.xmldb.api.base.Configurable

Parameters:

property - The new property value

value - The new property value

Throws:

org.xmldb.api.base.XMLDBException - Description of the Exception

setCollection

void setCollection(org.xmldb.api.base.Collection collection)
                   throws org.xmldb.api.base.XMLDBException

Set the current collection for this service

Specified by:

setCollection in interface org.xmldb.api.base.Service

Parameters:

collection - The new collection value

Throws:

org.xmldb.api.base.XMLDBException - Description of the Exception

getPermissions

Permission getPermissions(org.xmldb.api.base.Collection coll)
                          throws org.xmldb.api.base.XMLDBException

Get permissions for the specified collections

Parameters:

coll - Description of the Parameter

Returns:

The permissions value

Throws:

org.xmldb.api.base.XMLDBException - Description of the Exception

getPermissions

Permission getPermissions(org.xmldb.api.base.Resource res)
                          throws org.xmldb.api.base.XMLDBException

Get permissions for the specified resource

Parameters:

res - Description of the Parameter

Returns:

The permissions value

Throws:

org.xmldb.api.base.XMLDBException - Description of the Exception

listResourcePermissions

Permission[] listResourcePermissions()
                                     throws org.xmldb.api.base.XMLDBException

Get permissions for all resources contained in the current collection. Returns a list of permissions in the same order as Collection.listResources().

Returns:

Permission[]

Throws:

org.xmldb.api.base.XMLDBException

listCollectionPermissions

Permission[] listCollectionPermissions()
                                       throws org.xmldb.api.base.XMLDBException

Get permissions for all child collections contained in the current collection. Returns a list of permissions in the same order as Collection.listChildCollections().

Returns:

Permission[]

Throws:

org.xmldb.api.base.XMLDBException

removeUser

void removeUser(User user)
                throws org.xmldb.api.base.XMLDBException

Delete a user from the database

Parameters:

user - User

Throws:

org.xmldb.api.base.XMLDBException

addUserGroup

void addUserGroup(User user)
                  throws org.xmldb.api.base.XMLDBException

Update the specified user without update user's password Method added by {Marco.Tampucci, Massimo.Martinelli} @isti.cnr.it

Parameters:

user - Description of the Parameter

Throws:

org.xmldb.api.base.XMLDBException - Description of the Exception

removeGroup

void removeGroup(User user,
                 String rmgroup)
                 throws org.xmldb.api.base.XMLDBException

Update the specified user removing a group from user's group Method added by {Marco.Tampucci, Massimo.Martinelli} @isti.cnr.it

Parameters:

user - Description of the Parameter

rmgroup - Description of group to remove

Throws:

org.xmldb.api.base.XMLDBException - Description of the Exception