aboutsummaryrefslogtreecommitdiffstats
path: root/openecomp-be/lib/openecomp-logging-lib/openecomp-sdc-logging-core/src/main/java/org/openecomp/sdc/logging/context/impl/MdcDataDebugMessage.java
blob: 01bc6f446e717280c1c8888337dad9b899cbe172 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
/*-
 * ============LICENSE_START=======================================================
 * SDC
 * ================================================================================
 * Copyright (C) 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.openecomp.sdc.logging.context.impl;

import org.openecomp.sdc.logging.api.Logger;
import org.openecomp.sdc.logging.api.LoggerFactory;
import org.openecomp.sdc.logging.context.MdcData;
import org.openecomp.sdc.logging.messages.DebugMessages;
import org.openecomp.sdc.logging.types.DebugConstants;
import org.openecomp.sdc.logging.types.LoggerErrorCategory;
import org.openecomp.sdc.logging.util.LoggingUtils;

import java.util.HashMap;
import java.util.Map;

public class MdcDataDebugMessage extends MdcData {

  private static Logger logger;
  private static Map<String, String> mapExitOrEntryToMessage;

  static {
    mapExitOrEntryToMessage = new HashMap<>();
    mapExitOrEntryToMessage.put(DebugConstants.ENTER, DebugMessages.ENTER_METHOD);
    mapExitOrEntryToMessage.put(DebugConstants.ENTER_DEFAULT, DebugMessages.DEFAULT_ENTER_METHOD);
    mapExitOrEntryToMessage.put(DebugConstants.EXIT, DebugMessages.EXIT_METHOD);
    mapExitOrEntryToMessage.put(DebugConstants.EXIT_DEFAULT, DebugMessages.DEFAULT_EXIT_METHOD);
  }

  public MdcDataDebugMessage() {
    super(LoggerErrorCategory.DEBUG.name(), null);
  }

  //todo add more explanations as to the first parameter structure in case of multiples and in
  // case of no params in method
  /**
   * Debug entry message.
   *
   * @param entityParameter the entity parameter
   * @param ids             the ids
   */
  public void debugEntryMessage(String entityParameter, String... ids) {
    logDebugMessage(entityParameter, DebugConstants.ENTER, ids);
  }

  /**
   * Debug exit message.
   *
   * @param entityParameter the entity parameter
   * @param ids             the ids
   */
  public void debugExitMessage(String entityParameter, String... ids) {
    logDebugMessage(entityParameter, DebugConstants.EXIT, ids);
  }

  public void logDebugMessage(String entityParameter, String enterOrExit, String... ids) {
    String methodName = LoggingUtils.getCallingMethodNameForDebugging();
    String declaringClass = LoggingUtils.getDeclaringClass();
    logger = (Logger) LoggerFactory.getLogger(declaringClass);
    String messageToWrite;

    if (entityParameter == null || ids == null) {
      messageToWrite = mapExitOrEntryToMessage.get(enterOrExit + "_" + DebugConstants.DEFAULT);
      logger.debug(String.format(messageToWrite, methodName));
    } else {
      messageToWrite = mapExitOrEntryToMessage.get(enterOrExit);
      logger.debug(String
          .format(messageToWrite, methodName, entityParameter, String.join(",", ids)));
    }
  }
}