TCA: Replace any openecomp reference by onap
[dcaegen2/analytics/tca.git] / dcae-analytics-tca / src / main / java / org / onap / dcae / apod / analytics / tca / processor / TCACEFProcessorContext.java
-/*\r
- * ===============================LICENSE_START======================================\r
- *  dcae-analytics\r
- * ================================================================================\r
- *    Copyright © 2017 AT&T Intellectual Property. All rights reserved.\r
- * ================================================================================\r
- *  Licensed under the Apache License, Version 2.0 (the "License");\r
- *  you may not use this file except in compliance with the License.\r
- *   You may obtain a copy of the License at\r
- *\r
- *          http://www.apache.org/licenses/LICENSE-2.0\r
- *\r
- *  Unless required by applicable law or agreed to in writing, software\r
- *  distributed under the License is distributed on an "AS IS" BASIS,\r
- *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r
- *  See the License for the specific language governing permissions and\r
- *  limitations under the License.\r
- *  ============================LICENSE_END===========================================\r
- */\r
-\r
-package org.openecomp.dcae.apod.analytics.tca.processor;\r
-\r
-import org.openecomp.dcae.apod.analytics.common.service.processor.AbstractProcessorContext;\r
-import org.openecomp.dcae.apod.analytics.model.domain.cef.EventListener;\r
-import org.openecomp.dcae.apod.analytics.model.domain.policy.tca.MetricsPerEventName;\r
-import org.openecomp.dcae.apod.analytics.model.domain.policy.tca.TCAPolicy;\r
-\r
-/**\r
- *  TCA CEF Policy Processor Context\r
- *\r
- * @author Rajiv Singla . Creation Date: 11/7/2016.\r
- */\r
-public class TCACEFProcessorContext extends AbstractProcessorContext {\r
-\r
-    private static final long serialVersionUID = 1L;\r
-\r
-    private final TCAPolicy tcaPolicy;\r
-    private EventListener eventListener;\r
-    private MetricsPerEventName metricsPerEventName;\r
-\r
-    public TCACEFProcessorContext(final String message, boolean canProcessingContinue, final TCAPolicy tcaPolicy) {\r
-        super(message, canProcessingContinue);\r
-        this.tcaPolicy = tcaPolicy;\r
-        // present only if cef incoming message can be parsed successfully to Event Listener Object\r
-        this.eventListener = null;\r
-        // present only if there are any threshold violations are detected\r
-        this.metricsPerEventName = null;\r
-    }\r
-\r
-    // Auxiliary Constructor which default canProcessingContinue Flag to true\r
-    public TCACEFProcessorContext(final String message, final TCAPolicy tcaPolicy) {\r
-        this(message, true, tcaPolicy);\r
-    }\r
-\r
-    /**\r
-     * Returns {@link TCAPolicy} Object\r
-     *\r
-     * @return TCA Policy\r
-     */\r
-    public TCAPolicy getTCAPolicy() {\r
-        return tcaPolicy;\r
-    }\r
-\r
-    /**\r
-     * Returns Common Event Format {@link EventListener} if present else null\r
-     *\r
-     * @return CEF Event Listener\r
-     */\r
-    public EventListener getCEFEventListener() {\r
-        return eventListener;\r
-    }\r
-\r
-\r
-    /**\r
-     * Sets new {@link EventListener}\r
-     *\r
-     * @param eventListener set new value for CEF event listener\r
-     */\r
-    public void setCEFEventListener(final EventListener eventListener) {\r
-        this.eventListener = eventListener;\r
-    }\r
-\r
-\r
-    /**\r
-     * Returns TCA Policy {@link MetricsPerEventName} which was has violated Threshold for the CEF Message if\r
-     * present else null\r
-     *\r
-     * @return Violated Threshold\r
-     */\r
-    public MetricsPerEventName getMetricsPerEventName() {\r
-        return metricsPerEventName;\r
-    }\r
-\r
-    /**\r
-     * Assign new TCA Policy {@link MetricsPerEventName} which was has violated Threshold for the CEF Message\r
-     *\r
-     * @param metricsPerEventName new value for Metrics Per Functional Role with violated threshold\r
-     */\r
-    public void setMetricsPerEventName(MetricsPerEventName metricsPerEventName) {\r
-        this.metricsPerEventName = metricsPerEventName;\r
-    }\r
-\r
-}\r
+/*
+ * ===============================LICENSE_START======================================
+ *  dcae-analytics
+ * ================================================================================
+ *    Copyright © 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.onap.dcae.apod.analytics.tca.processor;
+
+import org.onap.dcae.apod.analytics.common.service.processor.AbstractProcessorContext;
+import org.onap.dcae.apod.analytics.model.domain.cef.EventListener;
+import org.onap.dcae.apod.analytics.model.domain.policy.tca.MetricsPerEventName;
+import org.onap.dcae.apod.analytics.model.domain.policy.tca.TCAPolicy;
+
+/**
+ *  TCA CEF Policy Processor Context
+ *
+ * @author Rajiv Singla . Creation Date: 11/7/2016.
+ */
+public class TCACEFProcessorContext extends AbstractProcessorContext {
+
+    private static final long serialVersionUID = 1L;
+
+    private final TCAPolicy tcaPolicy;
+    private EventListener eventListener;
+    private MetricsPerEventName metricsPerEventName;
+
+    public TCACEFProcessorContext(final String message, boolean canProcessingContinue, final TCAPolicy tcaPolicy) {
+        super(message, canProcessingContinue);
+        this.tcaPolicy = tcaPolicy;
+        // present only if cef incoming message can be parsed successfully to Event Listener Object
+        this.eventListener = null;
+        // present only if there are any threshold violations are detected
+        this.metricsPerEventName = null;
+    }
+
+    // Auxiliary Constructor which default canProcessingContinue Flag to true
+    public TCACEFProcessorContext(final String message, final TCAPolicy tcaPolicy) {
+        this(message, true, tcaPolicy);
+    }
+
+    /**
+     * Returns {@link TCAPolicy} Object
+     *
+     * @return TCA Policy
+     */
+    public TCAPolicy getTCAPolicy() {
+        return tcaPolicy;
+    }
+
+    /**
+     * Returns Common Event Format {@link EventListener} if present else null
+     *
+     * @return CEF Event Listener
+     */
+    public EventListener getCEFEventListener() {
+        return eventListener;
+    }
+
+
+    /**
+     * Sets new {@link EventListener}
+     *
+     * @param eventListener set new value for CEF event listener
+     */
+    public void setCEFEventListener(final EventListener eventListener) {
+        this.eventListener = eventListener;
+    }
+
+
+    /**
+     * Returns TCA Policy {@link MetricsPerEventName} which was has violated Threshold for the CEF Message if
+     * present else null
+     *
+     * @return Violated Threshold
+     */
+    public MetricsPerEventName getMetricsPerEventName() {
+        return metricsPerEventName;
+    }
+
+    /**
+     * Assign new TCA Policy {@link MetricsPerEventName} which was has violated Threshold for the CEF Message
+     *
+     * @param metricsPerEventName new value for Metrics Per Functional Role with violated threshold
+     */
+    public void setMetricsPerEventName(MetricsPerEventName metricsPerEventName) {
+        this.metricsPerEventName = metricsPerEventName;
+    }
+
+}