summaryrefslogtreecommitdiffstats
path: root/pki/base/common/src/com/netscape/cmscore/logging/AuditEventFactory.java
blob: 46b42f0478f227b16b5535121ed8b85e2aaac176 (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
// --- 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.cmscore.logging;


import java.util.Properties;

import com.netscape.certsrv.logging.AuditEvent;
import com.netscape.certsrv.logging.IBundleLogEvent;
import com.netscape.certsrv.logging.ILogEvent;
import com.netscape.certsrv.logging.ILogEventFactory;
import com.netscape.certsrv.logging.ILogger;


/**
 * A log event object for handling audit messages
 * <P>
 *
 * @author mikep 
 * @author mzhao
 * @version $Revision$, $Date$
 */
public class AuditEventFactory implements ILogEventFactory {

    /**
     * List of supported properties.
     */
    public static final String PROP_BUNDLE = "bundleName";

    /**
     * Constructs a audit event factory.
     */
    public AuditEventFactory() {
    }

    /**
     * Creates an log event.
     * 
     * @param evtClass the event type
     * @param prop the resource bundle
     * @param source the subsystem ID who creates the log event
     * @param level the severity of the log event
     * @param multiline the log message has more than one line or not
     * @param msg the detail message of the log
     * @param params the parameters in the detail log message
     */
    public ILogEvent create(int evtClass, Properties prop, int source,
        int level, boolean multiline, String msg, Object params[]) {
        if (evtClass != ILogger.EV_AUDIT)
            return null;
        AuditEvent event = new AuditEvent(msg, params);

        event.setLevel(level);
        event.setSource(source);
        event.setMultiline(multiline);
        setProperties(prop, event);
        return event;
    }

    /**
     * Set the resource bundle of the log event.
     *
     * @param prop the properties 
     * @param event the log event
     */
    protected void setProperties(Properties prop, IBundleLogEvent event) {
        if (prop == null) {
            event.setBundleName(null);
        } else {
            String bundleName = (String) prop.get(PROP_BUNDLE);

            if (bundleName != null) {
                event.setBundleName(bundleName);
            }
        }
    }

    /**
     * Releases an log event.
     *
     * @param e the log event
     */
    public void release(ILogEvent e) {
        // do nothing
    }
}