summaryrefslogtreecommitdiffstats
path: root/pki/base/common/src/com/netscape/cms/policy/constraints/AgentPolicy.java
blob: 2a98f12fda9b1ba2fa71901fc4054beb4b42089f (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
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
// --- 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.cms.policy.constraints;


import java.util.Vector;

import com.netscape.certsrv.apps.CMS;
import com.netscape.certsrv.base.IConfigStore;
import com.netscape.certsrv.base.ISubsystem;
import com.netscape.certsrv.policy.EPolicyException;
import com.netscape.certsrv.policy.IEnrollmentPolicy;
import com.netscape.certsrv.request.AgentApprovals;
import com.netscape.certsrv.request.IRequest;
import com.netscape.certsrv.request.PolicyResult;
import com.netscape.cms.policy.APolicyRule;


/**
 * AgentPolicy is an enrollment policy wraps another policy module.
 *   Requests are sent first to the contained module, but if the
 *   policy indicates that the request should be deferred, a check
 *   for agent approvals is done.  If any are found, the request
 *   is approved.
 * <P>
 * <PRE>
 * NOTE:  The Policy Framework has been replaced by the Profile Framework.
 * </PRE>
 * <P>
 *
 * @deprecated
 * @version $Revision$, $Date$
 */
public class AgentPolicy extends APolicyRule
    implements IEnrollmentPolicy {
    public AgentPolicy() {
        NAME = "AgentPolicy";
        DESC = "Agent Approval Policy";
    }

    /**
     * Initializes this policy rule.
     * <P>
     *
     * The entries may be of the form:
     *
     *      ra.Policy.rule.<ruleName>.implName=AgentPolicy
     *      ra.Policy.rule.<ruleName>.enable=true
     *      ra.Policy.rule.<ruleName>.predicate= ou == engineering AND o == netscape.com
     *      ra.Policy.rule.<ruleName>.class=xxxx
     *      ra.Policy.rule.<ruleName>.params.*
     *
     * @param config	The config store reference
     */
    public void init(ISubsystem owner, IConfigStore config)
        throws EPolicyException {

        // Create subordinate object
        String className = (String) config.get("class");

        System.err.println("Creating agent policy with class " + className);
        if (className != null) {
            IConfigStore substore = config.getSubStore("params");

            try {
                Class c = Class.forName(className);

                Object o = c.newInstance();

                if (!(o instanceof APolicyRule)) {
                    throw new EPolicyException(
                            CMS.getUserMessage("CMS_POLICY_INVALID_POLICY_CLASS", 
                                getInstanceName(), className));
                }

                APolicyRule pr = (APolicyRule) o;

                pr.init(owner, substore);
                mPolicy = pr;
            } catch (EPolicyException e) {
                System.err.println("Agent Policy Error: " + e);
                throw e;
            } catch (Exception e) {
                System.err.println("Agent Policy Error: " + e);
                throw new EPolicyException(
                        CMS.getUserMessage("CMS_POLICY_LOADING_POLICY_ERROR",
                            getInstanceName(), className));
            }
        }
    }

    /**
     * Applies the policy on the given Request.
     * <P>
     *
     * @param req	The request on which to apply policy.
     * @return The policy result object.
     */
    public PolicyResult apply(IRequest req) {

        // The default is to require manual approval for everything
        PolicyResult result = PolicyResult.DEFERRED;

        // Give the underlying object a chance
        if (mPolicy != null) {
            result = mPolicy.apply(req);
            System.err.println("Subordinate policy returns " + result);
        }

        if (result == PolicyResult.DEFERRED) {
            System.err.println("Checking agent approvals");
            // Try to find an agent approval
            AgentApprovals aa = AgentApprovals.fromStringVector(
                    req.getExtDataInStringVector(AgentApprovals.class.getName()));

            //Object o = req.get("agentApprovals");

            // Any approvals causes success
            if (aa != null && aa.elements().hasMoreElements()) //if (o != null)
            {
                System.err.println("Agent approval found");
                result = PolicyResult.ACCEPTED;
            }
        }
        System.err.println("Agent policy returns " + result);
        return result;
    }

    /**
     * Return configured parameters for a policy rule instance.
     *
     * @return nvPairs A Vector of name/value pairs.
     */
    public Vector getInstanceParams() {
        return null;
    }

    /**
     * Return default parameters for a policy implementation.
     *
     * @return nvPairs A Vector of name/value pairs.
     */
    public Vector getDefaultParams() {
        return null;
    }

    APolicyRule mPolicy = null; 
}