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
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
|
/*
* Copyright © 2016-2018 European Support Limited
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.openecomp.sdc.logging.api;
/**
* Builder to populate <i>audit</i> data. This includes only data known to an application, and not otherwise available
* to the logging framework. As opposed, for example, to local runtime, host address, etc.
*
* @author KATYR, evitaliy
* @since February 15, 2018
*/
public class AuditData {
// don't inherit from MetricsData because it has a very different meaning
private final long startTime;
private final long endTime;
private final StatusCode statusCode;
private final String responseCode;
private final String responseDescription;
private final String clientIpAddress;
private AuditData(final AuditDataBuilder builder) {
this.startTime = builder.startTime;
this.endTime = builder.endTime;
this.statusCode = builder.statusCode;
this.responseCode = builder.responseCode;
this.responseDescription = builder.responseDescription;
this.clientIpAddress = builder.clientIpAddress;
}
/**
* Begin timestamp of an API invocation.
*
* @return timestamp
*/
public long getStartTime() {
return startTime;
}
/**
* End timestamp of an API invocation.
*
* @return timestamp
*/
public long getEndTime() {
return endTime;
}
/**
* Result status of an API invocation.
*
* @return protocol and application agnostic status code
*/
public StatusCode getStatusCode() {
return statusCode;
}
/**
* Application/protocol specific response status of an API invocation.
*
* @return response code
*/
public String getResponseCode() {
return responseCode;
}
/**
* Application/protocol specific response in a human-friendly way.
*
* @return human-friendly response description
*/
public String getResponseDescription() {
return responseDescription;
}
/**
* IP address of the invoking client when available.
*
* @return IP address
*/
public String getClientIpAddress() {
return clientIpAddress;
}
@Override
public String toString() {
return "AuditData{startTime=" + startTime + ", endTime=" + endTime + ", statusCode=" + statusCode
+ ", responseCode=" + responseCode + ", responseDescription=" + responseDescription
+ ", clientIpAddress=" + clientIpAddress + '}';
}
public static AuditDataBuilder builder() {
return new AuditDataBuilder();
}
/**
* Fluent API for building audit data.
*/
public static class AuditDataBuilder {
private long startTime;
private long endTime;
private StatusCode statusCode;
private String responseCode;
private String responseDescription;
private String clientIpAddress;
AuditDataBuilder() { /* package-private default constructor to hide the public one */ }
/**
* Begin timestamp of an activity being audited.
*
* @param startTime local timestamp, usually received from {@link System#currentTimeMillis()}
* @return this builder for fluent API
*/
public AuditDataBuilder startTime(final long startTime) {
this.startTime = startTime;
return this;
}
/**
* End timestamp of an activity being audited.
*
* @param endTime local timestamp, usually received from {@link System#currentTimeMillis()}
* @return this builder for fluent API
*/
public AuditDataBuilder endTime(final long endTime) {
this.endTime = endTime;
return this;
}
/**
* Indicate whether an invocation was successful. It is up the the application to decide if a particular result
* must be treated as a success or a failure.
*
* @param statusCode invocation status success/failure
* @return this builder for fluent API
*/
public AuditDataBuilder statusCode(final StatusCode statusCode) {
this.statusCode = statusCode;
return this;
}
/**
* Application/protocol specific response code. For a Web API, it is likely a standard HTTP response code.
*
* @param responseCode response code that depends on application and invocation protocol
* @return this builder for fluent API
*/
public AuditDataBuilder responseCode(final String responseCode) {
this.responseCode = responseCode;
return this;
}
/**
* Response description that explains {@link #responseCode(String)} in a human-friendly way. For a Web API, it
* is likely to be a standard HTTP response phrase.
*
* @param responseDescription human-friendly response description
* @return this builder for fluent API
*/
public AuditDataBuilder responseDescription(final String responseDescription) {
this.responseDescription = responseDescription;
return this;
}
/**
* IP address of an invoking client.
*
* @param clientIpAddress IP address
* @return this builder for fluent API
*/
public AuditDataBuilder clientIpAddress(final String clientIpAddress) {
this.clientIpAddress = clientIpAddress;
return this;
}
/**
* Create an instance of {@link AuditData}.
*
* @return a populated instance of audit data
*/
public AuditData build() {
return new AuditData(this);
}
}
}
|
