xsul.xpola.groupman
Interface GroupManager

All Known Implementing Classes:

GroupmanAbstractImpl, GroupManagerImpl, GroupmanClient

public interface GroupManager

Method Summary

void	addGroup(java.lang.String gname, java.lang.String[] metadata)
void	addUsersToGroup(java.lang.String[] unames, java.lang.String gname, java.lang.String[] metadata) Method addUsersToGroup adds userdns to a group.
void	deleteGroups(java.lang.String[] gnames)
java.lang.String[]	listGroups(java.lang.String[] metadata) Method listGroups lists all the groups that match the corresponding metadata.
java.lang.String[]	listUsersOfGroup(java.lang.String gname, boolean recursive)
void	removeUsersFromGroup(java.lang.String[] unames, java.lang.String gname)

Method Detail

addGroup

public void addGroup(java.lang.String gname,
                     java.lang.String[] metadata)
              throws java.lang.Exception

Throws:

java.lang.Exception

addUsersToGroup

public void addUsersToGroup(java.lang.String[] unames,
                            java.lang.String gname,
                            java.lang.String[] metadata)
                     throws java.lang.Exception

Method addUsersToGroup adds userdns to a group. Users must be existing users. If the group does not exist, it will be created.

Parameters:

unames - a String[] for a list of user DNs

gname - a String for the group name

metadata - a String[] for the metadata of the group. For the time being, metadata[0] is the description of the group. Futher information can be added as metadata[1], [2] ... if needed.

Throws:

java.lang.Exception

deleteGroups

public void deleteGroups(java.lang.String[] gnames)
                  throws java.lang.Exception

Throws:

java.lang.Exception

listGroups

public java.lang.String[] listGroups(java.lang.String[] metadata)
                              throws java.lang.Exception

Method listGroups lists all the groups that match the corresponding metadata. Metadata could be null.

Parameters:

metadata - a String[]

Returns:

a String[] for the list of group names

Throws:

java.lang.Exception

listUsersOfGroup

public java.lang.String[] listUsersOfGroup(java.lang.String gname,
                                           boolean recursive)
                                    throws java.lang.Exception

Throws:

java.lang.Exception

removeUsersFromGroup

public void removeUsersFromGroup(java.lang.String[] unames,
                                 java.lang.String gname)
                          throws java.lang.Exception

Throws:

java.lang.Exception