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
|
// --- 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.profile;
import java.util.Enumeration;
import java.util.Locale;
import com.netscape.certsrv.base.IConfigStore;
import com.netscape.certsrv.property.EPropertyException;
import com.netscape.certsrv.property.IConfigTemplate;
import com.netscape.certsrv.property.IDescriptor;
import com.netscape.certsrv.request.IRequest;
/**
* This interface represents a input policy which
* provides information on how to create the
* end-user enrollment page.
*
* @version $Revision$, $Date$
*/
public interface IProfileInput extends IConfigTemplate {
/**
* Initializes this default policy.
*
* @param profile owner of this input
* @param config configuration store
* @exception EProfileException failed to initialize
*/
public void init(IProfile profile, IConfigStore config)
throws EProfileException;
/**
* Returns configuration store.
*
* @return configuration store
*/
public IConfigStore getConfigStore();
/**
* Populates the request with this policy default.
*
* @param ctx profile context
* @param request request
* @exception EProfileException failed to populate
*/
public void populate(IProfileContext ctx, IRequest request)
throws EProfileException;
/**
* Retrieves the localizable name of this policy.
*
* @param locale user locale
* @return localized input name
*/
public String getName(Locale locale);
/**
* Retrieves the localizable description of this policy.
*
* @param locale user locale
* @return localized input description
*/
public String getText(Locale locale);
/**
* Retrieves a list of names of the property.
*
* @return a list of property names
*/
public Enumeration<String> getValueNames();
/**
* Retrieves the descriptor of the given value
* property by name.
*
* @param locale user locale
* @param name property name
* @return descriptor of the property
*/
public IDescriptor getValueDescriptor(Locale locale, String name);
/**
* Retrieves value from the request.
*
* @param name property name
* @param locale user locale
* @param request request
* @exception EProfileException failed to get value
*/
public String getValue(String name, Locale locale, IRequest request)
throws EProfileException;
/**
* Sets the value of the given property by name.
*
* @param name property name
* @param locale user locale
* @param request request
* @param value value
* @exception EProfileException failed to get value
*/
public void setValue(String name, Locale locale, IRequest request,
String value) throws EPropertyException;
}
|
