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.util.function.calculation;
22 import java.util.function.Function;
24 import org.onap.dcae.analytics.model.TcaModelConstants;
25 import org.onap.dcae.analytics.model.ecomplogger.AnalyticsErrorType;
26 import org.onap.dcae.analytics.tca.core.service.TcaExecutionContext;
27 import org.onap.dcae.analytics.tca.core.service.TcaProcessingContext;
28 import org.onap.dcae.analytics.tca.core.util.TcaUtils;
29 import org.onap.dcae.utils.eelf.logger.api.info.ErrorLogInfo;
30 import org.onap.dcae.utils.eelf.logger.api.info.TargetServiceLogInfo;
31 import org.onap.dcae.utils.eelf.logger.api.log.EELFLogFactory;
32 import org.onap.dcae.utils.eelf.logger.api.log.EELFLogger;
33 import org.onap.dcae.utils.eelf.logger.model.info.ErrorLogInfoImpl;
34 import org.onap.dcae.utils.eelf.logger.model.info.RequestIdLogInfoImpl;
35 import org.onap.dcae.utils.eelf.logger.model.info.TargetServiceLogInfoImpl;
36 import org.onap.dcae.utils.eelf.logger.model.spec.DebugLogSpecImpl;
37 import org.onap.dcae.utils.eelf.logger.model.spec.ErrorLogSpecImpl;
40 * Functional interface which all TCA calculation functions should implement
42 * @author Rajiv Singla
45 public interface TcaCalculationFunction extends Function<TcaExecutionContext, TcaExecutionContext> {
47 EELFLogger logger = EELFLogFactory.getLogger(TcaCalculationFunction.class);
49 TcaExecutionContext calculate(TcaExecutionContext tcaExecutionContext);
51 default TcaExecutionContext preCalculation(TcaExecutionContext tcaExecutionContext) {
53 return tcaExecutionContext;
56 default TcaExecutionContext postCalculation(TcaExecutionContext tcaExecutionContext) {
58 return tcaExecutionContext;
62 default TcaExecutionContext apply(TcaExecutionContext tcaExecutionContext) {
63 // triggers pre calculate, calculate nad post calculate
64 return postCalculation(calculate(preCalculation(tcaExecutionContext)));
68 * Updates TCA Processing context with early terminating message or error message
70 * @param terminatingMessage terminating message to be set in processing context
71 * @param tcaExecutionContext current tca execution context
72 * @param isErrorMessage specifies if terminating message is an error message
74 * @return updated tca execution context with early termination or error message and continue processing flag as
77 default TcaExecutionContext setTerminatingMessage(final String terminatingMessage,
78 final TcaExecutionContext tcaExecutionContext,
79 final boolean isErrorMessage) {
80 final TcaProcessingContext tcaProcessingContext = tcaExecutionContext.getTcaProcessingContext();
82 final RequestIdLogInfoImpl requestIdLogInfo = new RequestIdLogInfoImpl(tcaExecutionContext.getRequestId());
85 final TargetServiceLogInfo targetServiceLogInfo = new TargetServiceLogInfoImpl(
86 "DCAE-TCA", TcaModelConstants.TCA_SERVICE_NAME, "");
87 final ErrorLogInfo errorLogInfo =
88 new ErrorLogInfoImpl(AnalyticsErrorType.SCHEMA_ERROR.getErrorCode(),
89 AnalyticsErrorType.SCHEMA_ERROR.getErrorDescription());
90 final ErrorLogSpecImpl errorLogSpec = new ErrorLogSpecImpl(requestIdLogInfo,
91 TcaUtils.TCA_SERVICE_LOG_INFO, targetServiceLogInfo, errorLogInfo);
92 logger.errorLog().error("Request Id: {}. Error Message: {}",
93 errorLogSpec, tcaExecutionContext.getRequestId(), terminatingMessage);
94 tcaProcessingContext.setErrorMessage(terminatingMessage);
96 final DebugLogSpecImpl debugLogSpec = new DebugLogSpecImpl(requestIdLogInfo);
97 logger.debugLog().debug("Request Id: {}. Early Termination Message: {}",
98 debugLogSpec, tcaExecutionContext.getRequestId(), terminatingMessage);
99 tcaProcessingContext.setEarlyTerminationMessage(terminatingMessage);
101 tcaProcessingContext.setContinueProcessing(false);
102 return tcaExecutionContext;