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
|
// --- 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.logging;
import java.util.LinkedHashMap;
import java.util.Map;
/**
* The log event object that carries message detail of a log event
* that goes into the Signed Audit Event log. This log has the
* property of being digitally signed for security considerations.
*
*
* @version $Revision$, $Date$
* @see java.text.MessageFormat
* @see com.netscape.certsrv.logging.LogResources
*/
public class SignedAuditEvent extends LogEvent {
private static final long serialVersionUID = 4287822756516673931L;
protected Map<String, Object> attributes = new LinkedHashMap<>();
/**
* Constructs a SignedAuditEvent message event.
* <P>
*
* @param msgFormat The message string.
*/
public SignedAuditEvent(String msgFormat) {
super(msgFormat);
}
/**
* Constructs a message with a parameter. For example,
*
* <PRE>
* new SignedAuditEvent("failed to load {0}", fileName);
* </PRE>
* <P>
*
* @param msgFormat Details in message string format.
* @param param Message string parameter.
*/
public SignedAuditEvent(String msgFormat, String param) {
super(msgFormat, param);
}
/**
* Constructs a message from an exception. It can be used to carry
* a signed audit exception that may contain information about
* the context. For example,
*
* <PRE>
* try {
* ...
* } catch (IOExeption e) {
* logHandler.log(new SignedAuditEvent("Encountered Signed Audit Error {0}", e);
* }
* </PRE>
* <P>
*
* @param msgFormat Exception details in message string format.
* @param exception System exception.
*/
public SignedAuditEvent(String msgFormat, Exception exception) {
super(msgFormat, exception);
}
/**
* Constructs a message from a base exception. This will use the msgFormat
* from the exception itself.
*
* <PRE>
* try {
* ...
* } catch (Exception e) {
* logHandler.log(new SignedAuditEvent(e));
* }
* </PRE>
* <P>
*
* @param e CMS exception.
*/
public SignedAuditEvent(Exception e) {
super(e);
}
/**
* Constructs a message event with a list of parameters
* that will be substituted into the message format.
* <P>
*
* @param msgFormat Message string format.
* @param params List of message format parameters.
*/
public SignedAuditEvent(String msgFormat, Object params[]) {
super(msgFormat, params);
}
public void setAttribute(String name, Object value) {
attributes.put(name, value);
}
public Object getAttribute(String name) {
return attributes.get(name);
}
public Map<String, Object> getAttributes() {
return attributes;
}
public String getAttributeList() {
StringBuilder sb = new StringBuilder();
for (String name : attributes.keySet()) {
Object value = attributes.get(name);
sb.append("[");
sb.append(name);
sb.append("=");
sb.append(value == null ? ILogger.SIGNED_AUDIT_EMPTY_VALUE : value);
sb.append("]");
}
return sb.toString();
}
}
|
