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
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
|
// --- 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.dbs;
import java.util.*;
import netscape.ldap.*;
import com.netscape.certsrv.base.*;
/**
* An interface represents the database session. Operations
* can be performed with a session.
*
* Transaction and Caching support can be integrated
* into session.
*
* @version $Revision$, $Date$
*/
public interface IDBSSession {
/**
* Returns database subsystem.
*
* @return subsystem
*/
public ISubsystem getDBSubsystem();
/**
* Closes this session.
*
* @exception EDBException failed to close session
*/
public void close() throws EDBException;
/**
* Adds object to backend database. For example,
* <PRE>
* session.add("cn=123459,o=certificate repository,o=airius.com",
* certRec);
* </PRE>
*
* @param name name of the object
* @param obj object to be added
* @exception EDBException failed to add object
*/
public void add(String name, IDBObj obj) throws EBaseException;
/**
* Reads an object from the database.
*
* @param name name of the object that is to be read
* @return database object
* @exception EBaseException failed to read object
*/
public IDBObj read(String name) throws EBaseException;
/**
* Reads an object from the database, and only populates
* the selected attributes.
*
* @param name name of the object that is to be read
* @param attrs selected attributes
* @return database object
* @exception EBaseException failed to read object
*/
public IDBObj read(String name, String attrs[])
throws EBaseException;
/**
* Deletes object from database.
*
* @param name name of the object that is to be deleted
* @exception EBaseException failed to delete object
*/
public void delete(String name) throws EBaseException;
/**
* Modify an object in the database.
*
* @param name name of the object that is to be modified
* @param mods modifications
* @exception EBaseException failed to modify
*/
public void modify(String name, ModificationSet mods)
throws EBaseException;
/**
* Searchs for a list of objects that match the
* filter.
*
* @param base starting point of the search
* @param filter search filter
* @return search results
* @exception EBaseException failed to search
*/
public IDBSearchResults search(String base, String filter)
throws EBaseException;
/**
* Searchs for a list of objects that match the
* filter.
*
* @param base starting point of the search
* @param filter search filter
* @param maxSize max number of entries
* @return search results
* @exception EBaseException failed to search
*/
public IDBSearchResults search(String base, String filter, int maxSize)
throws EBaseException;
/**
* Searchs for a list of objects that match the
* filter.
*
* @param base starting point of the search
* @param filter search filter
* @param maxSize max number of entries
* @param timeLimit timeout limit
* @return search results
* @exception EBaseException failed to search
*/
public IDBSearchResults search(String base, String filter, int maxSize,
int timeLimit) throws EBaseException;
/**
* Retrieves a list of object that satifies the given
* filter.
*
* @param base starting point of the search
* @param filter search filter
* @param attrs selected attributes
* @return search results
* @exception EBaseException failed to search
*/
public IDBSearchResults search(String base, String filter,
String attrs[]) throws EBaseException;
/**
* Retrieves a list of objects.
*
* @param base starting point of the search
* @param filter search filter
* @param attrs selected attributes
* @return search results in virtual list
* @exception EBaseException failed to search
*/
public IDBVirtualList createVirtualList(String base, String filter,
String attrs[]) throws EBaseException;
/**
* Sets persistent search to retrieve modified
* certificate records.
*
* @param base starting point of the search
* @param filter search filter
* @param attrs selected attributes
* @return LDAP search results
* @exception EBaseException failed to search
*/
public LDAPSearchResults persistentSearch(String base, String filter,
String attrs[]) throws EBaseException;
/**
* Retrieves a list of objects.
*
* @param base starting point of the search
* @param filter search filter
* @param attrs selected attributes
* @param sortKey key used to sort the list
* @param pageSize page size in the virtual list
* @return search results in virtual list
* @exception EBaseException failed to search
*/
public IDBVirtualList createVirtualList(String base, String filter,
String attrs[], String sortKey, int pageSize)
throws EBaseException;
/**
* Retrieves a list of objects.
*
* @param base starting point of the search
* @param filter search filter
* @param attrs selected attributes
* @param startFrom starting point
* @param sortKey key used to sort the list
* @param pageSize page size in the virtual list
* @return search results in virtual list
* @exception EBaseException failed to search
*/
public IDBVirtualList createVirtualList(String base, String filter,
String attrs[], String startFrom,
String sortKey, int pageSize)
throws EBaseException;
}
|
