1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
|
// --- BEGIN COPYRIGHT BLOCK ---
// This program is free software; you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation; version 2 of the License.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License along
// with this program; if not, write to the Free Software Foundation, Inc.,
// 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
//
// (C) 2007 Red Hat, Inc.
// All rights reserved.
// --- END COPYRIGHT BLOCK ---
package com.netscape.certsrv.usrgrp;
import java.util.*;
import com.netscape.certsrv.base.*;
import netscape.ldap.*;
/**
* This interface defines the basic capabilities of
* a usr/group manager. (get/add/modify/remove users or groups)
*
* @version $Revision$, $Date$
*/
public interface IUsrGrp extends IIdEvaluator {
/**
* Retrieves usr/grp manager identifier.
* @return id
*/
public String getId();
/**
* Retrieves the description
* @return description
*/
public String getDescription();
/**
* Retrieves an identity
* @param userid the user id for the given user
* @return user interface
*/
public IUser getUser(String userid) throws EUsrGrpException;
/**
* Adds a user identity to the LDAP server. For example,
* <code>
* User user = new User("joe");
* user.setFullName("joe doe");
* user.setPassword("secret");
* usrgrp.addUser(user);
* </code>
* @param user an user interface
* @exception EUsrGrpException thrown when some of the user attribute values
* are null
* @exception LDAPException thrown when the LDAP internal database is not
* available, or the add operation failed
*/
public void addUser(IUser user) throws EUsrGrpException, LDAPException;
/**
* Removes a user.
* @param userid the user id for the given user
* @exception EUsrGrpException thrown when failed to remove user
*/
public void removeUser(String userid) throws EUsrGrpException;
/**
* Modifies user.
* @param user the user interface which contains the modified information
* @exception EUsrGrpException thrown when failed to modify user
*/
public void modifyUser(IUser user) throws EUsrGrpException;
/**
* Retrieves an identity group
* @param groupid the given group id.
* @return the group interface
*/
public IGroup getGroup(String groupid);
/**
* Adds a group
* @param group the given group
* @exception EUsrGrpException thrown when failed to add the group.
*/
public void addGroup(IGroup group) throws EUsrGrpException;
/**
* Modifies a group
* @param group the given group contains the new information for modification.
* @exception EUsrGrpException thrown when failed to modify the group.
*/
public void modifyGroup(IGroup group) throws EUsrGrpException;
/**
* Removes a group
* @param name the group name
* @exception EUsrGrpException thrown when failed to remove the given
* group.
*/
public void removeGroup(String name) throws EUsrGrpException;
}
|
