gerrit.onap Code Review - policy/drools-pdp.git/blob

   1 /*\r
   2  * ============LICENSE_START=======================================================\r
   3  * feature-controller-logging\r
   4  * ================================================================================\r
   5  * Copyright (C) 2019 AT&T Intellectual Property. All rights reserved.\r
   6  * ================================================================================\r
   7  * Licensed under the Apache License, Version 2.0 (the "License");\r
   8  * you may not use this file except in compliance with the License.\r
   9  * You may obtain a copy of the License at\r
  10  *\r
  11  *      http://www.apache.org/licenses/LICENSE-2.0\r
  12  *\r
  13  * Unless required by applicable law or agreed to in writing, software\r
  14  * distributed under the License is distributed on an "AS IS" BASIS,\r
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r
  16  * See the License for the specific language governing permissions and\r
  17  * limitations under the License.\r
  18  * ============LICENSE_END=========================================================\r
  19  */\r
  20 \r
  21 package org.onap.policy.drools.controller.logging;\r
  22 \r
  23 import org.onap.policy.common.endpoints.event.comm.Topic.CommInfrastructure;\r
  24 import org.onap.policy.common.endpoints.event.comm.TopicSink;\r
  25 import org.onap.policy.drools.controller.DroolsController;\r
  26 import org.onap.policy.drools.features.DroolsControllerFeatureAPI;\r
  27 import org.onap.policy.drools.features.PolicyControllerFeatureAPI;\r
  28 import org.onap.policy.drools.features.PolicyEngineFeatureAPI;\r
  29 import org.onap.policy.drools.protocol.configuration.ControllerConfiguration;\r
  30 import org.onap.policy.drools.protocol.configuration.PdpdConfiguration;\r
  31 import org.onap.policy.drools.system.PolicyController;\r
  32 import org.onap.policy.drools.system.PolicyEngine;\r
  33 import org.slf4j.Logger;\r
  34 import org.slf4j.LoggerFactory;\r
  35 \r
  36 /**\r
  37  * This class hooks the network logging implementation into DroolsPDP. It will disable the\r
  38  * default network logger where all topic traffic is logged and segregates the topic\r
  39  * traffic by controller for each supported control loop use case.\r
  40  */\r
  41 \r
  42 /*\r
  43  * PolicyControllerFeatureAPI - the 'beforeStart' hook is used to shut off the default\r
  44  * network logger and the 'beforeOffer' hook is used to log incoming topic messages\r
  45  *\r
  46  * DroolsControllerFeatureAPI - the 'afterDeliver' hook is where the outgoing topic\r
  47  * messages are logged\r
  48  *\r
  49  */\r
  50 public class ControllerLoggingFeature\r
  51                 implements PolicyEngineFeatureAPI, DroolsControllerFeatureAPI, PolicyControllerFeatureAPI {\r
  52 \r
  53     @Override\r
  54     public int getSequenceNumber() {\r
  55         return 1000;\r
  56     }\r
  57 \r
  58     /**\r
  59      * The 'beforeOffer' hook will intercept an incoming topic message and append it to\r
  60      * the log file that is configured for the controller logger.\r
  61      */\r
  62     @Override\r
  63     public boolean beforeOffer(PolicyController controller, CommInfrastructure protocol, String topic, String event) {\r
  64         Logger controllerLogger = LoggerFactory.getLogger(controller.getName());\r
  65         controllerLogger.info("[IN|{}|{}]{}{}", protocol, topic, System.lineSeparator(), event);\r
  66         return false;\r
  67     }\r
  68 \r
  69     /**\r
  70      * The 'afterDeliver' hook will intercept an outgoing topic message and append it to\r
  71      * the log file that is configured for the controller logger.\r
  72      */\r
  73     @Override\r
  74     public boolean afterDeliver(DroolsController controller, TopicSink sink, Object fact, String json,\r
  75                     boolean success) {\r
  76         if (success) {\r
  77             Logger controllerLogger = LoggerFactory.getLogger(PolicyController.factory.get(controller).getName());\r
  78             controllerLogger.info("[OUT|{}|{}]{}{}", sink.getTopicCommInfrastructure(), sink.getTopic(),\r
  79                             System.lineSeparator(), json);\r
  80         }\r
  81         return false;\r
  82     }\r
  83 \r
  84     /**\r
  85      * The 'afterOnTopicEvent' hook will determine which controllers were updated and log\r
  86      * the event to the appropriate controller logs.\r
  87      */\r
  88     @Override\r
  89     public boolean afterOnTopicEvent(PolicyEngine engine, PdpdConfiguration configuration, CommInfrastructure commType,\r
  90                     String topic, String event) {\r
  91         for (ControllerConfiguration controller : configuration.getControllers()) {\r
  92             Logger controllerLogger = LoggerFactory.getLogger(controller.getName());\r
  93             controllerLogger.info("[IN|{}|{}]{}{}", commType, topic, System.lineSeparator(), event);\r
  94         }\r
  95         return false;\r
  96     }\r
  97 }\r