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
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
|
/*-
* ============LICENSE_START=======================================================
* policy-core
* ================================================================================
* Copyright (C) 2017 AT&T Intellectual Property. All rights reserved.
* ================================================================================
* 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.
* ============LICENSE_END=========================================================
*/
package org.openecomp.policy.drools.core;
import java.util.concurrent.ConcurrentHashMap;
import org.kie.api.event.rule.AfterMatchFiredEvent;
import org.kie.api.event.rule.AgendaEventListener;
import org.kie.api.event.rule.AgendaGroupPoppedEvent;
import org.kie.api.event.rule.AgendaGroupPushedEvent;
import org.kie.api.event.rule.BeforeMatchFiredEvent;
import org.kie.api.event.rule.MatchCancelledEvent;
import org.kie.api.event.rule.MatchCreatedEvent;
import org.kie.api.event.rule.ObjectDeletedEvent;
import org.kie.api.event.rule.ObjectInsertedEvent;
import org.kie.api.event.rule.ObjectUpdatedEvent;
import org.kie.api.event.rule.RuleFlowGroupActivatedEvent;
import org.kie.api.event.rule.RuleFlowGroupDeactivatedEvent;
import org.kie.api.event.rule.RuleRuntimeEventListener;
import org.kie.api.runtime.KieSession;
import org.openecomp.policy.common.logging.eelf.MessageCodes;
import org.openecomp.policy.common.logging.flexlogger.FlexLogger;
import org.openecomp.policy.common.logging.flexlogger.Logger;
import org.openecomp.policy.drools.core.jmx.PdpJmx;
/**
* This class is a wrapper around 'KieSession', which adds the following:
*
* 1) A thread running 'KieSession.fireUntilHalt()'
* 2) Access to UEB
* 3) Logging of events
*/
public class PolicySession
implements AgendaEventListener, RuleRuntimeEventListener
{
// get an instance of logger
private static Logger logger = FlexLogger.getLogger(PolicySession.class);
// name of the 'PolicySession' and associated 'KieSession'
private String name;
// the associated 'PolicyContainer', which may have additional
// 'PolicySession' instances in addition to this one
private PolicyContainer container;
// maps feature objects to per-PolicyContainer data
private ConcurrentHashMap<Object, Object> adjuncts =
new ConcurrentHashMap<Object, Object>();
// associated 'KieSession' instance
private KieSession kieSession;
// if not 'null', this is the thread model processing the 'KieSession'
private ThreadModel threadModel = null;
// supports 'getCurrentSession()' method
static private ThreadLocal<PolicySession> policySession =
new ThreadLocal<PolicySession>();
/**
* Internal constructor - create a 'PolicySession' instance
*
* @param name the name of this 'PolicySession' (and 'kieSession')
* @param container the 'PolicyContainer' instance containing this session
* @param kieSession the associated 'KieSession' instance
*/
protected PolicySession(String name,
PolicyContainer container, KieSession kieSession)
{
this.name = name;
this.container = container;
this.kieSession = kieSession;
kieSession.addEventListener((AgendaEventListener)this);
kieSession.addEventListener((RuleRuntimeEventListener)this);
}
/**
* @return the 'PolicyContainer' object containing this session
*/
public PolicyContainer getPolicyContainer()
{
return(container);
}
/**
* @return the associated 'KieSession' instance
*/
public KieSession getKieSession()
{
return(kieSession);
}
/**
* @return the local name of this session, which should either match the
* name specified in 'kmodule.xml' file associated with this session, or the
* name passed on the 'PolicyContainer.adoptKieSession' method.
*/
public String getName()
{
return(name);
}
/**
* @return the 'PolicyContainer' name, followed by ':', followed by the
* local name of the session. It should be useful in log messages.
*/
public String getFullName()
{
return(container.getName() + ":" + name);
}
/**
* If no 'ThreadModel' is currently running, this method will create one,
* and invoke it's 'start()' method. Features implementing
* 'PolicySessionFeatureAPI.selectThreadModel(...)' get a chance to create
* the ThreadModel instance.
*/
public synchronized void startThread()
{
if (threadModel == null)
{
// loop through all of the features, and give each one
// a chance to create the 'ThreadModel'
for (PolicySessionFeatureAPI feature :
PolicySessionFeatureAPI.impl.getList())
{
try
{
if ((threadModel = feature.selectThreadModel(this)) != null)
break;
}
catch (Exception e)
{
logger.error("ERROR: Feature API: "
+ feature.getClass().getName(), e);
}
}
if (threadModel == null)
{
// no feature created a ThreadModel -- select the default
threadModel = new DefaultThreadModel(this);
}
logger.info("starting ThreadModel for session " + getFullName());
threadModel.start();
}
}
/**
* If a 'ThreadModel' is currently running, this calls the 'stop()' method,
* and sets the 'threadModel' reference to 'null'.
*/
public synchronized void stopThread()
{
if (threadModel != null)
{
threadModel.stop();
threadModel = null;
}
}
/**
* Notification that 'updateToVersion' was called on the container
*/
void updated()
{
if (threadModel != null)
{
// notify the 'ThreadModel', which may change one or more Thread names
threadModel.updated();
}
}
/**
* Set this 'PolicySession' instance as the one associated with the
* currently-running thread.
*/
public void setPolicySession()
{
// this sets a 'ThreadLocal' variable
policySession.set(this);
}
/**
* @return the 'PolicySession' instance associated with the current thread
* (Note that this only works if the current thread is the one running
* 'kieSession.fireUntilHalt()'.)
*/
public static PolicySession getCurrentSession()
{
return(policySession.get());
}
/**
* Fetch the adjunct object associated with a given feature
*
* @param object this is typically the singleton feature object that is
* used as a key, but it might also be useful to use nested objects
* within the feature as keys.
* @return a feature-specific object associated with the key, or 'null'
* if it is not found.
*/
public Object getAdjunct(Object object)
{
return(adjuncts.get(object));
}
/**
* Store the adjunct object associated with a given feature
*
* @param object this is typically the singleton feature object that is
* used as a key, but it might also be useful to use nested objects
* within the feature as keys.
* @param value a feature-specific object associated with the key, or 'null'
* if the feature-specific object should be removed
*/
public void setAdjunct(Object object, Object value)
{
if (value == null)
{
adjuncts.remove(object);
}
else
{
adjuncts.put(object, value);
}
}
/***********************************/
/* 'AgendaEventListener' interface */
/***********************************/
/**
* {@inheritDoc}
*/
@Override
public void afterMatchFired(AfterMatchFiredEvent event)
{
if (logger.isDebugEnabled())
{
logger.debug("afterMatchFired: " + getFullName()
+ ": AgendaEventListener.afterMatchFired(" + event + ")");
}
PdpJmx.getInstance().ruleFired();
}
/**
* {@inheritDoc}
*/
@Override
public void afterRuleFlowGroupActivated(RuleFlowGroupActivatedEvent event)
{
if (logger.isDebugEnabled())
{
logger.debug("afterRuleFlowGroupActivated: " + getFullName()
+ ": AgendaEventListener.afterRuleFlowGroupActivated("
+ event + ")");
}
}
/**
* {@inheritDoc}
*/
@Override
public void afterRuleFlowGroupDeactivated
(RuleFlowGroupDeactivatedEvent event)
{
if (logger.isDebugEnabled())
{
logger.debug("afterRuleFlowGroupDeactivated: " + getFullName()
+ ": AgendaEventListener.afterRuleFlowGroupDeactivated("
+ event + ")");
}
}
/**
* {@inheritDoc}
*/
@Override
public void agendaGroupPopped(AgendaGroupPoppedEvent event)
{
if (logger.isDebugEnabled())
{
logger.debug("agendaGroupPopped: " + getFullName()
+ ": AgendaEventListener.agendaGroupPopped("
+ event + ")");
}
}
/**
* {@inheritDoc}
*/
@Override
public void agendaGroupPushed(AgendaGroupPushedEvent event)
{
if (logger.isDebugEnabled())
{
logger.debug("agendaGroupPushed: " + getFullName()
+ ": AgendaEventListener.agendaGroupPushed("
+ event + ")");
}
}
/**
* {@inheritDoc}
*/
@Override
public void beforeMatchFired(BeforeMatchFiredEvent event)
{
if (logger.isDebugEnabled())
{
logger.debug("beforeMatchFired: " + getFullName()
+ ": AgendaEventListener.beforeMatchFired("
+ event + ")");
}
}
/**
* {@inheritDoc}
*/
@Override
public void beforeRuleFlowGroupActivated
(RuleFlowGroupActivatedEvent event)
{
if (logger.isDebugEnabled())
{
logger.debug("beforeRuleFlowGroupActivated: " + getFullName()
+ ": AgendaEventListener.beforeRuleFlowGroupActivated("
+ event + ")");
}
}
/**
* {@inheritDoc}
*/
@Override
public void beforeRuleFlowGroupDeactivated
(RuleFlowGroupDeactivatedEvent event)
{
if (logger.isDebugEnabled())
{
logger.debug("beforeRuleFlowGroupDeactivated: " + getFullName()
+ ": AgendaEventListener.beforeRuleFlowGroupDeactivated("
+ event + ")");
}
}
/**
* {@inheritDoc}
*/
@Override
public void matchCancelled(MatchCancelledEvent event)
{
if (logger.isDebugEnabled())
{
logger.debug("matchCancelled: " + getFullName()
+ ": AgendaEventListener.matchCancelled(" + event + ")");
}
}
/**
* {@inheritDoc}
*/
@Override
public void matchCreated(MatchCreatedEvent event)
{
if (logger.isDebugEnabled())
{
logger.debug("matchCreated: " + getFullName()
+ ": AgendaEventListener.matchCreated(" + event + ")");
}
}
/****************************************/
/* 'RuleRuntimeEventListener' interface */
/****************************************/
/**
* {@inheritDoc}
*/
@Override
public void objectDeleted(ObjectDeletedEvent event)
{
if (logger.isDebugEnabled())
{
logger.debug("objectDeleted: " + getFullName()
+ ": AgendaEventListener.objectDeleted(" + event + ")");
}
}
/**
* {@inheritDoc}
*/
@Override
public void objectInserted(ObjectInsertedEvent event)
{
if (logger.isDebugEnabled())
{
logger.debug("objectInserted: " + getFullName()
+ ": AgendaEventListener.objectInserted(" + event + ")");
}
}
/**
* {@inheritDoc}
*/
@Override
public void objectUpdated(ObjectUpdatedEvent event)
{
if (logger.isDebugEnabled())
{
logger.debug("objectUpdated: " + getFullName()
+ ": AgendaEventListener.objectUpdated(" + event + ")");
}
}
/* ============================================================ */
/**
* This interface helps support the ability for features to choose the
* thread or threads that processes the 'KieSession'.
*/
public interface ThreadModel
{
/**
* Start the thread or threads that do the 'KieSession' processing
*/
public void start();
/**
* Stop the thread or threads that do the 'KieSession' processing
*/
public void stop();
/**
* This method is called to notify the running session that
* 'KieContainer.updateToVersion(...)' has been called (meaning the
* full name of this session has changed).
*/
default public void updated() {}
}
/* ============================================================ */
/**
* This 'ThreadModel' variant uses 'KieSession.fireUntilHalt()'.
*/
public static class DefaultThreadModel implements Runnable,ThreadModel
{
// session associated with this persistent thread
PolicySession session;
// the session thread
Thread thread;
// controls whether the thread loops or terminates
volatile boolean repeat = true;
/**
* Constructor - initialize 'session' and create thread
*
* @param session the 'PolicySession' instance
*/
public DefaultThreadModel(PolicySession session)
{
this.session = session;
thread = new Thread(this,getThreadName());
}
/**
* @return the String to use as the thread name
*/
private String getThreadName()
{
return("Session " + session.getFullName());
}
/***************************/
/* 'ThreadModel' interface */
/***************************/
/**
* {@inheritDoc}
*/
@Override
public void start()
{
repeat = true;
thread.start();
}
/**
* {@inheritDoc}
*/
@Override
public void stop()
{
repeat = false;
// this should cause the thread to exit
session.getKieSession().halt();
try
{
// wait up to 10 seconds for the thread to stop
thread.join(10000);
// one more interrupt, just in case the 'kieSession.halt()'
// didn't work for some reason
thread.interrupt();
}
catch (Exception e)
{
logger.error(MessageCodes.EXCEPTION_ERROR, e, "stopThread", "thread.join");
}
}
/**
* {@inheritDoc}
*/
@Override
public void updated()
{
// the container artifact has been updated -- adjust the thread name
thread.setName(getThreadName());
}
/************************/
/* 'Runnable' interface */
/************************/
/**
* {@inheritDoc}
*/
@Override
public void run()
{
// set thread local variable
session.setPolicySession();
// We want to continue looping, despite any exceptions that occur
// while rules are fired.
KieSession kieSession = session.getKieSession();
while (repeat)
{
try
{
kieSession.fireUntilHalt();
// if we fall through, it means 'KieSession.halt()' was called
repeat = false;
}
catch (Throwable e)
{
logger.error(MessageCodes.EXCEPTION_ERROR, e, "startThread", "kieSession.fireUntilHalt");
}
}
logger.info("fireUntilHalt() returned");
}
}
}
|