org.jwarp.service.groups
Interface IGroupManager

All Known Implementing Classes:

FileGroupManager

public interface IGroupManager

Method Summary

void	addGroup(IGroup group, java.lang.String name) Create a new group with the setings given.
void	addItem(IItem item, java.lang.String name) Create a new user with the setings given.
void	addMember(int newMember, int target) Add a user to a group
IItem	getItem(int id) Returns the user with the given id.
IItem	getItemByName(java.lang.String name) Returns an item by its name.
java.util.Iterator	getItems() Returns all defined items.
java.util.Iterator	getMembers(int ref) Returns all members of a group.
boolean	isMember(int item, int group) Is an item member of a group or one of its subgroups.
IItem	removeItem(int item) Removes the item.
void	removeMember(int member, int target) Remove a user from a group

Method Detail

addItem

public void addItem(IItem item,
                    java.lang.String name)

Create a new user with the setings given. The relationID is used to have a reference to whatever data the user needs, e.g. the primary key in the enterpise's personal db or a more complex string containing several infos.

Parameters:

uid - The user's identification

pwd - The user's password

name - The user's name

description - An optional description

relationID - An optional relation ID

admin - The user who tries to create the new user

Throws:

java.lang.SecurityException - If the creation failed.

removeItem

public IItem removeItem(int item)

Removes the item. If the item was removed its instance is returned.

Parameters:

item - The item to be removed

Returns:

The item removed or null

addGroup

public void addGroup(IGroup group,
                     java.lang.String name)

Create a new group with the setings given. The relationID is used to have a reference to whatever data the user needs, e.g. the primary key in the enterpise's db or a more complex string containing several infos.

Parameters:

name - The user's name

description - An optional description

relationID - An optional relation ID

admin - The user who tries to create the new user

Throws:

java.lang.SecurityException - If the creation failed.

addMember

public void addMember(int newMember,
                      int target)

Add a user to a group

Parameters:

user - The user

group - The group

admin - The admin user

Throws:

java.lang.SecurityException - If the setting failed.

removeMember

public void removeMember(int member,
                         int target)

Remove a user from a group

Parameters:

user - The user

group - The group

admin - The admin user

Throws:

java.lang.SecurityException - If the setting failed.

getItem

public IItem getItem(int id)

Returns the user with the given id.

Returns:

The corresponding user or null

getItems

public java.util.Iterator getItems()

Returns all defined items.

getItemByName

public IItem getItemByName(java.lang.String name)

Returns an item by its name.

getMembers

public java.util.Iterator getMembers(int ref)

Returns all members of a group.

Parameters:

ref - The group reference

isMember

public boolean isMember(int item,
                        int group)

Is an item member of a group or one of its subgroups.

Parameters:

item - The item to be lookedup

group - The group

Returns:

true If the item is a member of the group