001/*
002 * (C) Copyright 2015-2019 Nuxeo (http://nuxeo.com/) and others.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 *     http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 *
016 * Contributors:
017 *     Anahide Tchertchian
018 *     Kevin Leturc <kleturc@nuxeo.com>
019 */
020package org.nuxeo.runtime.logging;
021
022import org.apache.commons.lang3.StringUtils;
023import org.apache.logging.log4j.LogManager;
024import org.apache.logging.log4j.Logger;
025import org.nuxeo.runtime.api.Framework;
026
027/**
028 * Logger for deprecation that can hold the version from which this deprecation starts.
029 * <p>
030 * If the dev mode is set to {@code true} then logs the message as warning, otherwise logs as info if this level is
031 * enabled, for more details see <a href="https://doc.nuxeo.com/nxdoc/logs-analysis/">documentation</a>
032 *
033 * @since 7.4
034 */
035public class DeprecationLogger {
036
037    private static final Logger log = LogManager.getLogger(DeprecationLogger.class);
038
039    public static void log(String message, String deprecatedVersion) {
040        StringBuilder finalMessage = new StringBuilder();
041        if (StringUtils.isNotBlank(deprecatedVersion)) {
042            finalMessage.append("Since version ").append(deprecatedVersion).append(": ");
043        }
044        finalMessage.append(message);
045        log(finalMessage.toString());
046    }
047
048    public static void log(String message) {
049        if (Framework.isDevModeSet() || Framework.isTestModeSet()) {
050            log.warn(message);
051        } else {
052            log.info(message);
053        }
054    }
055
056}