2 * ================================================================================
3 * Copyright (c) 2018 AT&T Intellectual Property. All rights reserved.
4 * ================================================================================
5 * Licensed under the Apache License, Version 2.0 (the "License");
6 * you may not use this file except in compliance with the License.
7 * You may obtain a copy of the License at
9 * http://www.apache.org/licenses/LICENSE-2.0
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
16 * ============LICENSE_END=========================================================
20 package org.onap.dcae.analytics.tca.core.service;
22 import org.onap.dcae.analytics.tca.model.policy.TcaPolicy;
25 * TCA Execution context captures various fields required to calculate a TCA threshold violation calculation execution
27 * @author Rajiv Singla
29 public interface TcaExecutionContext {
32 * Provides request id associated with execution context
34 * @return request id associated with execution context
36 String getRequestId();
40 * Provides transaction id associated with execution context
42 * @return transaction id associated with execution context
44 String getTransactionId();
48 * Provides message order number inside a execution batch
50 * @return message order number inside a execution batch
52 int getMessageIndex();
56 * Provides common event format message as JSON string that is being analyzed
58 * @return common event format message as JSON string that is being analyzed
60 String getCefMessage();
64 * Provides TCA Policy associated with the processing context
66 * @return TCA Policy associated with processing context
68 TcaPolicy getTcaPolicy();
72 * Provides TCA Processing Context captures various mutable fields that are computed during TCA execution
74 * @return TCA Processing Context captures various mutable fields that are computed during TCA execution
76 TcaProcessingContext getTcaProcessingContext();
80 * Provides TCA Processing Result Context which captures outputs of TCA execution
82 * @return TCA Processing Result Context which captures outputs of TCA execution
84 TcaResultContext getTcaResultContext();
88 * Provides TCA Abatement context containing abstractions for TCA Abatement processing calculations
90 * @return TCA abatement context containing abstractions for TCA Abatement processing calculations
92 TcaAbatementContext getTcaAbatementContext();
96 * Provides TCA AAI Enrichment Context
98 * @return TCA AAI enrichment context
100 TcaAaiEnrichmentContext getTcaAaiEnrichmentContext();