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
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
|
/* -*- C++ -*- */
// $Id$
// ============================================================================
// = LIBRARY
// orbsvcs
//
// = FILENAME
// Log_i.h
//
// = DESCRIPTION
// Implementation of the DsLogAdmin::Log interface.
//
// = AUTHOR
// Matthew Braun (mjb2@cs.wustl.edu) and Pradeep Gore <pradeep@cs.wustl.edu>
//
// ============================================================================
#ifndef TLS_LOG_I_H
#define TLS_LOG_I_H
#include "orbsvcs/Log/LogRecordStore.h"
#include "orbsvcs/DsLogAdminS.h"
#include "ace/Reactor.h"
#if !defined (ACE_LACKS_PRAGMA_ONCE)
# pragma once
#endif /* ACE_LACKS_PRAGMA_ONCE */
// Bug in MSVC 5, See KB article Q167350
#if defined (_MSC_VER) && (_MSC_VER == 1100)
using DsLogAdmin::wrap;
#endif /* (_MSC_VER) && (_MSC_VER == 1100) */
class Log_i : public virtual POA_DsLogAdmin::Log
{
// = TITLE
// Used to log events to a logging server
//
// = DESCRIPTION
// This implementation attempts to conform to the telecom
// logging specification.
public:
// = Initialization and Termination
Log_i (DsLogAdmin::LogMgr_ptr factory,
DsLogAdmin::LogId id,
DsLogAdmin::LogFullAction log_full_action = DsLogAdmin::wrap,
CORBA::ULongLong max_size = 0,
ACE_Reactor *reactor = ACE_Reactor::instance ());
// Constructor.
~Log_i ();
// Destructor.
void init (CORBA::Environment &ACE_TRY_ENV);
// Initlialize the Log.
// = DsLogAdmin::Log methods
DsLogAdmin::LogMgr_ptr my_factory (CORBA::Environment &ACE_TRY_ENV)
ACE_THROW_SPEC ((CORBA::SystemException));
// Return the factory of the log
DsLogAdmin::LogId id (CORBA::Environment &ACE_TRY_ENV)
ACE_THROW_SPEC ((CORBA::SystemException));
// Return the id of the log
DsLogAdmin::QoSList_ptr
get_qos (CORBA::Environment &ACE_TRY_ENV)
ACE_THROW_SPEC ((CORBA::SystemException));
// Get the list of the QoS properties supported by the log
void set_qos (const DsLogAdmin::QoSList & qos,
CORBA::Environment &ACE_TRY_ENV)
ACE_THROW_SPEC ((CORBA::SystemException,
DsLogAdmin::UnsupportedQoS));
// Set the list of the QoS properties supported by the log.
CORBA::ULong
get_max_record_life (CORBA::Environment &ACE_TRY_ENV)
ACE_THROW_SPEC ((CORBA::SystemException));
// Get the record life in seconds (0 infinite)
void
set_max_record_life (CORBA::ULong life,
CORBA::Environment &ACE_TRY_ENV)
ACE_THROW_SPEC ((CORBA::SystemException));
// Set the record life in seconds (0 infinite)
CORBA::ULongLong
get_max_size (CORBA::Environment &ACE_TRY_ENV)
ACE_THROW_SPEC ((CORBA::SystemException));
// Get the maximum size in octets
void
set_max_size (CORBA::ULongLong size,
CORBA::Environment &ACE_TRY_ENV)
ACE_THROW_SPEC ((CORBA::SystemException,
DsLogAdmin::InvalidParam));
// Set the maximum size in octets.
CORBA::ULongLong
get_current_size (CORBA::Environment &ACE_TRY_ENV)
ACE_THROW_SPEC ((CORBA::SystemException));
// Get the current size of the log in octets.
CORBA::ULongLong
get_n_records (CORBA::Environment &ACE_TRY_ENV)
ACE_THROW_SPEC ((CORBA::SystemException));
// Return the number of records in the log
DsLogAdmin::LogFullAction
get_log_full_action (CORBA::Environment &ACE_TRY_ENV)
ACE_THROW_SPEC ((CORBA::SystemException));
// Get the action to be taken when the log reaches its maximum size
void
set_log_full_action (DsLogAdmin::LogFullAction action,
CORBA::Environment &ACE_TRY_ENV)
ACE_THROW_SPEC ((CORBA::SystemException));
// Set the action to be taken when the log reaches its maximum size
DsLogAdmin::AdministrativeState
get_administrative_state (CORBA::Environment &ACE_TRY_ENV)
ACE_THROW_SPEC ((CORBA::SystemException));
// Get the administrative state of the log.
void
set_administrative_state (DsLogAdmin::AdministrativeState state,
CORBA::Environment &ACE_TRY_ENV)
ACE_THROW_SPEC ((CORBA::SystemException));
// Set the administrative state of the log.
virtual DsLogAdmin::ForwardingState
get_forwarding_state (CORBA::Environment &ACE_TRY_ENV)
ACE_THROW_SPEC ((CORBA::SystemException));
// Get the forwarding state of the log.
// @@ Note: is it ok to make this method virtual?
void
set_forwarding_state (DsLogAdmin::ForwardingState state,
CORBA::Environment &ACE_TRY_ENV)
ACE_THROW_SPEC ((CORBA::SystemException));
// Set the forwarding state of the log.
// @@ Note: is it ok to make this method virtual?
DsLogAdmin::OperationalState
get_operational_state (CORBA::Environment &ACE_TRY_ENV)
ACE_THROW_SPEC ((CORBA::SystemException));
// Get the operational state of the log.
DsLogAdmin::TimeInterval
get_interval (CORBA::Environment &ACE_TRY_ENV)
ACE_THROW_SPEC ((CORBA::SystemException));
// Get the log duration
void
set_interval (const DsLogAdmin::TimeInterval & interval,
CORBA::Environment &ACE_TRY_ENV)
ACE_THROW_SPEC ((CORBA::SystemException,
DsLogAdmin::InvalidTime,
DsLogAdmin::InvalidTimeInterval));
// Set the log duration.
DsLogAdmin::AvailabilityStatus
get_availability_status (CORBA::Environment &ACE_TRY_ENV)
ACE_THROW_SPEC ((CORBA::SystemException));
// Get the availability status
DsLogAdmin::CapacityAlarmThresholdList_ptr
get_capacity_alarm_thresholds (CORBA::Environment &ACE_TRY_ENV)
ACE_THROW_SPEC ((CORBA::SystemException));
// Get the capacity alarm threshold
void
set_capacity_alarm_thresholds
(const DsLogAdmin::CapacityAlarmThresholdList & threshs,
CORBA::Environment &ACE_TRY_ENV)
ACE_THROW_SPEC ((CORBA::SystemException,
DsLogAdmin::InvalidThreshold));
// Set the capacity alarm threshold. Threshold values represent
// percentage levels at which the log should emit events to signal
// that a log full or log wrap condition is approaching. If the log
// is set to wrap, the thresholds are relative to the log size
// between wraps (after a wrap, the percentage full resets to
// 0).
DsLogAdmin::WeekMask_ptr
get_week_mask (CORBA::Environment &ACE_TRY_ENV)
ACE_THROW_SPEC ((CORBA::SystemException));
// Get the weekly scheduling parameters
void
set_week_mask (const DsLogAdmin::WeekMask & masks,
CORBA::Environment &ACE_TRY_ENV)
ACE_THROW_SPEC ((CORBA::SystemException,
DsLogAdmin::InvalidTime,
DsLogAdmin::InvalidTimeInterval,
DsLogAdmin::InvalidMask));
// Set the weekly scheduling parameters.
DsLogAdmin::RecordList_ptr
query (const char * grammar,
const char * c,
DsLogAdmin::Iterator_out i,
CORBA::Environment &ACE_TRY_ENV)
ACE_THROW_SPEC ((CORBA::SystemException,
DsLogAdmin::InvalidGrammar,
DsLogAdmin::InvalidConstraint));
// Returns all records in the log that match the given constraint
// <c>.
DsLogAdmin::RecordList_ptr
retrieve (DsLogAdmin::TimeT from_time,
CORBA::Long how_many,
DsLogAdmin::Iterator_out i,
CORBA::Environment &ACE_TRY_ENV)
ACE_THROW_SPEC ((CORBA::SystemException));
// Retrieve <how_many> records from time <from_time> using iterator
// <i>.
CORBA::ULong
match (const char * grammar,
const char * c,
CORBA::Environment &ACE_TRY_ENV)
ACE_THROW_SPEC ((CORBA::SystemException,
DsLogAdmin::InvalidGrammar,
DsLogAdmin::InvalidConstraint));
// Returns the number of records matching constraint <c>.
CORBA::ULong
delete_records (const char * grammar,
const char * c,
CORBA::Environment &ACE_TRY_ENV)
ACE_THROW_SPEC ((CORBA::SystemException,
DsLogAdmin::InvalidGrammar,
DsLogAdmin::InvalidConstraint));
// Delete records matching constraint <c>.
CORBA::ULong
delete_records_by_id (const DsLogAdmin::RecordIdList & ids,
CORBA::Environment &ACE_TRY_ENV)
ACE_THROW_SPEC ((CORBA::SystemException));
// Delete records matching ids in <ids>
void
write_records (const DsLogAdmin::Anys & records,
CORBA::Environment &ACE_TRY_ENV)
ACE_THROW_SPEC ((CORBA::SystemException,
DsLogAdmin::LogFull,
DsLogAdmin::LogLocked));
// Write records to the log storage.
void
write_recordlist (const DsLogAdmin::RecordList & list,
CORBA::Environment &ACE_TRY_ENV)
ACE_THROW_SPEC ((CORBA::SystemException,
DsLogAdmin::LogFull,
DsLogAdmin::LogLocked));
// Write a list of record ids to storage. Raises DsLogAdmin::LogFull
// and DsLogAdmin::LogLocked
void
set_record_attribute (DsLogAdmin::RecordId id,
const DsLogAdmin::NVList & attr_list,
CORBA::Environment &ACE_TRY_ENV)
ACE_THROW_SPEC ((CORBA::SystemException,
DsLogAdmin::InvalidRecordId,
DsLogAdmin::InvalidAttribute));
// Set single record attributes.
CORBA::ULong
set_records_attribute (const char * grammar,
const char * c,
const DsLogAdmin::NVList & attr_list,
CORBA::Environment &ACE_TRY_ENV)
ACE_THROW_SPEC ((CORBA::SystemException,
DsLogAdmin::InvalidGrammar,
DsLogAdmin::InvalidConstraint,
DsLogAdmin::InvalidAttribute));
// Set the attributes of all records that matches the
// constraints with same attr_list.
DsLogAdmin::NVList_ptr
get_record_attribute (DsLogAdmin::RecordId id,
CORBA::Environment &ACE_TRY_ENV)
ACE_THROW_SPEC ((CORBA::SystemException,
DsLogAdmin::InvalidRecordId));
// Get the attributes of the record with id <id>. Raises
// DsLogAdmin::InvalidRecordId
DsLogAdmin::Log_ptr
copy (DsLogAdmin::LogId_out id,
CORBA::Environment &ACE_TRY_ENV)
ACE_THROW_SPEC ((CORBA::SystemException));
// Copy the log on which the operation was invoked.
DsLogAdmin::Log_ptr
copy_with_id (DsLogAdmin::LogId id,
CORBA::Environment &ACE_TRY_ENV)
ACE_THROW_SPEC ((CORBA::SystemException,
DsLogAdmin::LogIdAlreadyExists));
// Copy the log on which the operation was invoked and assign it the
// given id.
void
flush (CORBA::Environment &ACE_TRY_ENV)
ACE_THROW_SPEC ((CORBA::SystemException,
DsLogAdmin::UnsupportedQoS));
// Causes all pending events to be written to storage. Raises
// DsLogAdmin::UnsupportedQos
protected:
// = Helper methods
DsLogAdmin::RecordList_ptr query_i (const char *constraint,
DsLogAdmin::Iterator_out &iter_out,
CORBA::ULong how_many,
CORBA::Environment &ACE_TRY_ENV)
ACE_THROW_SPEC ((CORBA::SystemException,
DsLogAdmin::InvalidConstraint));
CORBA::ULong match_i (const char *constraint,
CORBA::Boolean delete_rec,
CORBA::Environment &ACE_TRY_ENV)
ACE_THROW_SPEC ((CORBA::SystemException,
DsLogAdmin::InvalidConstraint));
void check_grammar (const char* grammar, CORBA::Environment &ACE_TRY_ENV)
ACE_THROW_SPEC ((CORBA::SystemException,
DsLogAdmin::InvalidGrammar));
// Throws DsLogAdmin::InvalidGrammar if we don't support this grammar.
void check_threshold_list (void);
// This method checks to see if any threshold limit is reached.
CORBA::Boolean scheduled (void);
// Tells if the Log is scheduled to run now.
// = Data Members
DsLogAdmin::LogMgr_var factory_;
// The factory of the log
DsLogAdmin::LogFullAction log_full_action_;
// The action to take if the log reaches max capacity
DsLogAdmin::LogId logid_;
// The id of the log
CORBA::ULong max_record_life_;
// The maximum record lifetime
DsLogAdmin::AdministrativeState admin_state_;
// The administrative state of the log
DsLogAdmin::ForwardingState forward_state_;
// The forwarding state of the log
DsLogAdmin::OperationalState op_state_;
// The operational state of the log
DsLogAdmin::TimeInterval interval_;
// The interval during which the log should be in operation
DsLogAdmin::AvailabilityStatus avail_status_;
// The availability of the log
DsLogAdmin::CapacityAlarmThresholdList thresholds_;
// The list of points at which the log should generate events
// indicating approaching full capacity
DsLogAdmin::WeekMask weekmask_;
// The days of the week that the log should be operational
DsLogAdmin::QoSList qoslist_;
// The QoS list of the log
ACE_Reactor *reactor_;
// The reactor used for timing (startup and shutdown), etc
LogRecordStore recordstore_;
// The storage for all the records
CORBA::ULong max_rec_list_len_;
// Max count to return in queries.
};
#endif /* TLS_LOG_I_H */
|
