summaryrefslogtreecommitdiffstats
path: root/pki/base/common/src/com/netscape/certsrv/request/IPolicy.java
blob: 06262fee3596a71623c6617b03724cc4b463d0d2 (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
// --- 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.request;

/**
 * Interface to a policy. The policy evaluates the request for correctness and
 * completeness. It may change or add to values stored in the request. The
 * policy object also decides whether a request should be queue to await
 * approval by an agent. FUTURE: In this case, the policy should set the
 * 'agentGroup' entry in the request to indicate the group of agents allowed to
 * perform further processing. If none is set, a default value
 * ("defaultAgentGroup") will be set instead.
 * 
 * @version $Revision$, $Date$
 */
public interface IPolicy {

    /**
     * Applies the policy check to the request. The policy should determine
     * whether the request can be processed immediately, or should be held
     * pending manual approval.
     * <p>
     * The policy can update fields in the request, to add additional values or
     * to restrict the values to pre-determined ranges.
     * <p>
     * 
     * @param request the request to check
     * @return a result code indicating the result of the evaluation. The
     *         processor will determine the next request processing step based
     *         on this value
     */
    PolicyResult apply(IRequest request);
}