common-app-api/src/main/java/org/openecomp/sdc/common/log/api/ILogFieldsHandler.java

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  * SDC
   4  * ================================================================================
   5  * Copyright (C) 2019 AT&T Intellectual Property. All rights reserved.
   6  * ================================================================================
   7  * Licensed under the Apache License, Version 2.0 (the "License");
   8  * you may not use this file except in compliance with the License.
   9  * You may obtain a copy of the License at
  10  *
  11  *      http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  * Unless required by applicable law or agreed to in writing, software
  14  * distributed under the License is distributed on an "AS IS" BASIS,
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  * See the License for the specific language governing permissions and
  17  * limitations under the License.
  18  * ============LICENSE_END=========================================================
  19  */
  20
  21 package org.openecomp.sdc.common.log.api;
  22
  23 import org.openecomp.sdc.common.log.enums.Severity;
  24
  25 /**
  26  * Created by dd4296 on 12/25/2017.
  27  */
  28 public interface ILogFieldsHandler {
  29     void startAuditTimer();
  30
  31     void startMetricTimer();
  32
  33     void stopAuditTimer();
  34
  35     void stopMetricTimer();
  36
  37     void setClassName(String className);
  38
  39     void setServerFQDN(String serverFQDN);
  40
  41     void setServerIPAddress(String serverIPAddress);
  42
  43     // intended for setting this parameter in a given thread
  44     void setServerFQDNInternally();
  45
  46     // intended for setting this parameter in a given thread
  47     void setServerIPAddressInternally();
  48
  49     void setInstanceUUID(String instanceUUID);
  50
  51     void setProcessKey(String processKey);
  52
  53     void setAlertSeverity(Severity alertSeverity);
  54
  55     void setOptCustomField1(String customField1);
  56
  57     void setOptCustomField2(String customField2);
  58
  59     void setOptCustomField3(String customField3);
  60
  61     void setOptCustomField4(String customField4);
  62
  63     void setKeyRequestId(String keyRequestId);
  64
  65     void setRemoteHost(String remoteHost);
  66
  67     void setServiceName(String serviceName);
  68
  69     void setStatusCode(String statusCode);
  70
  71     void setPartnerName(String partnerName);
  72
  73     void setResponseCode(int responseCode);
  74
  75     void setResponseDesc(String responseDesc);
  76
  77     void setServiceInstanceId(String serviceInstanceId);
  78
  79     void setTargetEntity(String targetEntity);
  80
  81     void setTargetServiceName(String targetServiceName);
  82
  83     void setTargetVirtualEntity(String targetVirtualEntity);
  84
  85     void setErrorCode(int errorCode);
  86
  87     void setErrorCategory(String errorCategory);
  88
  89     String getErrorCode();
  90
  91     String getServiceName();
  92
  93     String getErrorCategory();
  94
  95     void clear();
  96
  97     boolean isMDCParamEmpty(String mdcKeyName);
  98
  99     String getFqdn();
 100
 101     String getHostAddress();
 102
 103     String getKeyRequestId();
 104
 105     void removeStatusCode();
 106
 107     void removePartnerName();
 108
 109     void removeResponseCode();
 110
 111     void removeResponseDesc();
 112
 113     void removeServiceInstanceId();
 114
 115     void removeTargetEntity();
 116
 117     void removeTargetServiceName();
 118
 119     void removeTargetVirtualEntity();
 120
 121     void removeErrorCode();
 122
 123     void removeErrorCategory();
 124
 125     void removeErrorDescription();
 126
 127     void setAuditMessage(String message);
 128
 129     String getAuditMessage();
 130
 131 }