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
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
|
// --- 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.base;
import java.util.*;
import java.io.*;
import netscape.security.pkcs.*;
import java.security.*;
import java.math.BigInteger;
import com.netscape.certsrv.base.EBaseException;
import com.netscape.certsrv.base.BaseResources;
/**
* This interface defines the abstraction for the generic collection
* of attributes indexed by string names.
* Set of cooperating implementations of this interface may exploit
* dot-separated attribute names to provide seamless access to the
* attributes of attribute value which also implements AttrSet
* interface as if it was direct attribute of the container
* E.g., ((AttrSet)container.get("x")).get("y") is equivalent to
* container.get("x.y");
* <p>
*
* @version $Revision$, $Date$
**/
public interface IArgBlock extends Serializable {
/**
* Checks if this argument block contains the given key.
*
* @param n key
* @return true if key is present
*/
public boolean isValuePresent(String n);
/**
* Adds string-based value into this argument block.
*
* @param n key
* @param v value
* @return value
*/
public Object addStringValue(String n, String v);
/**
* Retrieves argument value as string.
*
* @param n key
* @return argument value as string
* @exception EBaseException failed to retrieve value
*/
public String getValueAsString(String n) throws EBaseException;
/**
* Retrieves argument value as string.
*
* @param n key
* @param def default value to be returned if key is not present
* @return argument value as string
*/
public String getValueAsString(String n, String def);
/**
* Retrieves argument value as integer.
*
* @param n key
* @return argument value as int
* @exception EBaseException failed to retrieve value
*/
public int getValueAsInt(String n) throws EBaseException;
/**
* Retrieves argument value as integer.
*
* @param n key
* @param def default value to be returned if key is not present
* @return argument value as int
*/
public int getValueAsInt(String n, int def);
/**
* Retrieves argument value as big integer.
*
* @param n key
* @return argument value as big integer
* @exception EBaseException failed to retrieve value
*/
public BigInteger getValueAsBigInteger(String n) throws EBaseException;
/**
* Retrieves argument value as big integer.
*
* @param n key
* @param def default value to be returned if key is not present
* @return argument value as big integer
*/
public BigInteger getValueAsBigInteger(String n, BigInteger def);
/**
* Retrieves argument value as object
*
* @param n key
* @return argument value as object
* @exception EBaseException failed to retrieve value
*/
public Object getValue(Object n) throws EBaseException;
/**
* Retrieves argument value as object
*
* @param n key
* @param def default value to be returned if key is not present
* @return argument value as object
*/
public Object getValue(Object n, Object def);
/**
* Gets boolean value. They should be "true" or "false".
*
* @param name name of the input type
* @return boolean type: <code>true</code> or <code>false</code>
* @exception EBaseException failed to retrieve value
*/
public boolean getValueAsBoolean(String name) throws EBaseException;
/**
* Gets boolean value. They should be "true" or "false".
*
* @param name name of the input type
* @param def Default value to return.
* @return boolean type: <code>true</code> or <code>false</code>
*/
public boolean getValueAsBoolean(String name, boolean def);
/**
* Gets KeyGenInfo
*
* @param name name of the input type
* @param def default value to return
* @exception EBaseException On error.
* @return KeyGenInfo object
*/
public KeyGenInfo getValueAsKeyGenInfo(String name, KeyGenInfo def) throws EBaseException;
/**
* Gets PKCS10 request. This pkcs10 attribute does not
* contain header information.
*
* @param name name of the input type
* @return pkcs10 request
* @exception EBaseException failed to retrieve value
*/
public PKCS10 getValueAsRawPKCS10(String name) throws EBaseException;
/**
* Gets PKCS10 request. This pkcs10 attribute does not
* contain header information.
*
* @param name name of the input type
* @param def default PKCS10
* @return pkcs10 request
* @exception EBaseException failed to retrieve value
*/
public PKCS10 getValueAsRawPKCS10(String name, PKCS10 def) throws EBaseException;
/**
* Retrieves PKCS10
*
* @param name name of the input type
* @param checkheader true if header must be present
* @return PKCS10 object
* @exception EBaseException failed to retrieve value
*/
public PKCS10 getValueAsPKCS10(String name, boolean checkheader) throws EBaseException;
/**
* Retrieves PKCS10
*
* @param name name of the input type
* @param checkheader true if header must be present
* @param def default PKCS10
* @return PKCS10 object
* @exception EBaseException on error
*/
public PKCS10 getValueAsPKCS10(String name, boolean checkheader, PKCS10 def) throws EBaseException;
/**
* Retrieves PKCS10
*
* @param name name of the input type
* @param def default PKCS10
* @return PKCS10 object
* @exception EBaseException on error
*/
public PKCS10 getValuePKCS10(String name, PKCS10 def) throws EBaseException;
/**
* Retrieves a list of argument keys.
*
* @return a list of string-based keys
*/
public Enumeration elements();
/**
* Adds long-type arguments to this block.
*
* @param n key
* @param v value
* @return value
*/
public Object addLongValue(String n, long v);
/**
* Adds integer-type arguments to this block.
*
* @param n key
* @param v value
* @return value
*/
public Object addIntegerValue(String n, int v);
/**
* Adds boolean-type arguments to this block.
*
* @param n key
* @param v value
* @return value
*/
public Object addBooleanValue(String n, boolean v);
/**
* Adds integer-type arguments to this block.
*
* @param n key
* @param v value
* @param radix radix
* @return value
*/
public Object addBigIntegerValue(String n, BigInteger v, int radix);
/**
* Sets argument into this block.
*
* @param name key
* @param obj value
*/
public void set(String name, Object obj);
/**
* Retrieves argument.
*
* @param name key
* @return object value
*/
public Object get(String name);
/**
* Deletes argument by the given key.
*
* @param name key
*/
public void delete(String name);
/**
* Retrieves a list of argument keys.
*
* @return a list of string-based keys
*/
public Enumeration getElements();
}
|
