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

   1 package org.openecomp.sdc.common.log.api;
   2
   3 import org.openecomp.sdc.common.log.enums.Severity;
   4
   5 /**
   6  * Created by dd4296 on 12/25/2017.
   7  */
   8 public interface ILogFieldsHandler {
   9     void startAuditTimer();
  10
  11     void startMetricTimer();
  12
  13     void stopAuditTimer();
  14
  15     void stopMetricTimer();
  16
  17     void setClassName(String className);
  18
  19     void setServerFQDN(String serverFQDN);
  20
  21     void setServerIPAddress(String serverIPAddress);
  22
  23     // intended for setting this parameter in a given thread
  24     void setServerFQDNInternally();
  25
  26     // intended for setting this parameter in a given thread
  27     void setServerIPAddressInternally();
  28
  29     void setInstanceUUID(String instanceUUID);
  30
  31     void setProcessKey(String processKey);
  32
  33     void setAlertSeverity(Severity alertSeverity);
  34
  35     void setOptCustomField1(String customField1);
  36
  37     void setOutgoingInvocationId(String outgoingInvocationId);
  38
  39     void setKeyRequestId(String keyRequestId);
  40
  41     void setRemoteHost(String remoteHost);
  42
  43     void setServiceName(String serviceName);
  44
  45     void setStatusCode(String statusCode);
  46
  47     void setPartnerName(String partnerName);
  48
  49     void setResponseCode(int responseCode);
  50
  51     void setResponseDesc(String responseDesc);
  52
  53     void setServiceInstanceId(String serviceInstanceId);
  54
  55     void setTargetEntity(String targetEntity);
  56
  57     void setTargetServiceName(String targetServiceName);
  58
  59     void setTargetVirtualEntity(String targetVirtualEntity);
  60
  61     void setErrorCode(int errorCode);
  62
  63     void setErrorCategory(String errorCategory);
  64
  65     String getErrorCode();
  66
  67     String getServiceName();
  68
  69     String getTargetEntity();
  70
  71     String getTargetServiceName();
  72
  73     String getErrorCategory();
  74
  75     void clear();
  76
  77     boolean isMDCParamEmpty(String mdcKeyName);
  78
  79     String getFqdn();
  80
  81     String getHostAddress();
  82
  83     String getKeyRequestId();
  84
  85     void removeStatusCode();
  86
  87     void removePartnerName();
  88
  89     void removeResponseCode();
  90
  91     void removeResponseDesc();
  92
  93     void removeServiceInstanceId();
  94
  95     void removeTargetEntity();
  96
  97     void removeTargetServiceName();
  98
  99     void removeTargetVirtualEntity();
 100
 101     void removeErrorCode();
 102
 103     void removeErrorCategory();
 104
 105     void removeErrorDescription();
 106
 107     void setAuditMessage(String message);
 108
 109     String getAuditMessage();
 110
 111     //service supportability [US 496441]
 112
 113     String getSupportablityAction();
 114
 115     String getSupportablityCsarUUID();
 116
 117     String getSupportablityCsarVersion();
 118
 119     String getSupportablityComponentName();
 120
 121     String getSupportablityComponentUUID();
 122
 123     String getSupportablityComponentVersion();
 124
 125     String getSupportablityStatusCode();
 126
 127     void setSupportablityAction(String action);
 128
 129     void setSupportablityCsarUUID(String uuid);
 130
 131     void setSupportablityCsarVersion(String version);
 132
 133     void setSupportablityComponentName(String name);
 134
 135     void setSupportablityComponentUUID(String UUID);
 136
 137     void setSupportablityComponentVersion(String version);
 138
 139     void setSupportablityStatusCode(String statusCode);
 140
 141     void removeSupportablityAction();
 142
 143     void removeSupportablityComponentName();
 144
 145     void removeSupportablityComponentUUID();
 146
 147     void removeSupportablityComponentVersion();
 148
 149     void removeSupportablityCsarUUID();
 150
 151     void removeSupportablityCsarVersion();
 152
 153     void removeSupportablityStatusCode();
 154
 155     String getPartnerName();
 156
 157     String getRemoteHost();
 158
 159     String getServerIpAddress();
 160
 161     void setKeyInvocationId(String invocationId);
 162
 163     CharSequence getKeyInvocationId();
 164 }