com.netscape.certsrv.usrgrp

Interface IUsrGrp

All Superinterfaces:

IIdEvaluator, java.io.Serializable

All Known Subinterfaces:

IUGSubsystem

public interface IUsrGrp
extends IIdEvaluator, java.io.Serializable

This interface defines the basic capabilities of a usr/group manager. (get/add/modify/remove users or groups)

Version:

$Revision$, $Date$

Method Summary

Modifier and Type	Method and Description
void	addGroup(IGroup group) Adds a group
void	addUser(IUser user) Adds a user identity to the LDAP server.
java.lang.String	getDescription() Retrieves the description
IGroup	getGroup(java.lang.String groupid) Retrieves an identity group
java.lang.String	getId() Retrieves usr/grp manager identifier.
IUser	getUser(java.lang.String userid) Retrieves an identity
void	modifyGroup(IGroup group) Modifies a group
void	modifyUser(IUser user) Modifies user.
void	removeGroup(java.lang.String name) Removes a group
void	removeUser(java.lang.String userid) Removes a user.

Methods inherited from interface com.netscape.certsrv.usrgrp.IIdEvaluator

evaluate

Method Detail

getId

java.lang.String getId()

Retrieves usr/grp manager identifier.

Returns:

id

getDescription

java.lang.String getDescription()

Retrieves the description

Returns:

description

getUser

IUser getUser(java.lang.String userid)
       throws EUsrGrpException

Retrieves an identity

Parameters:

userid - the user id for the given user

Returns:

user interface

Throws:

EUsrGrpException

addUser

void addUser(IUser user)
      throws EUsrGrpException

Adds a user identity to the LDAP server. For example, User user = new User("joe"); user.setFullName("joe doe"); user.setPassword("secret"); usrgrp.addUser(user);

Parameters:

user - an user interface

Throws:

EUsrGrpException - thrown when some of the user attribute values are null

removeUser

void removeUser(java.lang.String userid)
         throws EUsrGrpException

Removes a user.

Parameters:

userid - the user id for the given user

Throws:

EUsrGrpException - thrown when failed to remove user

modifyUser

void modifyUser(IUser user)
         throws EUsrGrpException

Modifies user.

Parameters:

user - the user interface which contains the modified information

Throws:

EUsrGrpException - thrown when failed to modify user

getGroup

IGroup getGroup(java.lang.String groupid)

Retrieves an identity group

Parameters:

groupid - the given group id.

Returns:

the group interface

addGroup

void addGroup(IGroup group)
       throws EUsrGrpException

Adds a group

Parameters:

group - the given group

Throws:

EUsrGrpException - thrown when failed to add the group.

modifyGroup

void modifyGroup(IGroup group)
          throws EUsrGrpException

Modifies a group

Parameters:

group - the given group contains the new information for modification.

Throws:

EUsrGrpException - thrown when failed to modify the group.

removeGroup

void removeGroup(java.lang.String name)
          throws EUsrGrpException

Removes a group

Parameters:

name - the group name

Throws:

EUsrGrpException - thrown when failed to remove the given group.