blob: a9fb6a2d214695190e4ffc49fae07aa2fb6dc3ab (
plain)
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
|
// --- 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.policy;
import java.util.Enumeration;
import com.netscape.certsrv.request.IRequest;
import com.netscape.certsrv.request.PolicyResult;
/**
* Represents a set of policy rules. Policy rules are ordered from
* lowest priority to highest priority. The priority assignment for rules
* is not enforced by this interface. Various implementation may
* use different mechanisms such as a linear ordering of rules
* in a configuration file or explicit assignment of priority levels ..etc.
* The policy system initialization needs to deal with reading the rules, sorting
* them in increasing order of priority and presenting an ordered vector of rules
* via the IPolicySet interface.
* <P>
*
* <PRE>
* NOTE: The Policy Framework has been replaced by the Profile Framework.
* </PRE>
* <P>
*
* @deprecated
* @version $Revision$, $Date$
*/
public interface IPolicySet {
/**
* Returns the name of the rule set.
* <P>
*
* @return The name of the rule set.
*/
String getName();
/**
* Returns the no of rules in a set.
* <P>
*
* @return the no of rules.
*/
int count();
/**
* Add a policy rule.
* <P>
*
* @param ruleName The name of the rule to be added.
* @param rule The rule to be added.
*/
void addRule(String ruleName, IPolicyRule rule);
/**
* Removes a policy rule identified by the given name.
*
* @param ruleName The name of the rule to be removed.
*/
void removeRule(String ruleName);
/**
* Returns the rule identified by a given name.
* <P>
*
* @param ruleName The name of the rule to be return.
* @return The rule identified by the given name or null if none exists.
*/
IPolicyRule getRule(String ruleName);
/**
* Returns an enumeration of rules.
* <P>
*
* @return An enumeration of rules.
*/
Enumeration<IPolicyRule> getRules();
/**
* Apply policy rules on a request. This call may modify
* the request content.
*
* @param req The request to apply policies on.
*
* <P>
* @return The policy result.
*/
PolicyResult apply(IRequest req);
}
|