com.esri.geoportal.commons.utils.CrlfUtils.java Source code

Introduction

Here is the source code for com.esri.geoportal.commons.utils.CrlfUtils.java

Source

/*
 * Copyright 2017 Esri, Inc.
 *
 * 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.
 */
package com.esri.geoportal.commons.utils;

import org.apache.commons.text.StringEscapeUtils;

/**
 * CRLF utilities.
 */
public class CrlfUtils {

    /**
     * Sanitizes string for log.
     * @param msg message to sanitize
     * @return sanitized message
     */
    public static String sanitizeForLog(String msg) {
        String clean = msg != null ? msg.replace('\n', '_').replace('\r', '_') : "";
        clean = StringEscapeUtils.escapeHtml4(clean);
        if (!msg.equals(clean)) {
            clean += " (Encoded)";
        }
        return clean;
    }

    /**
     * Formats string for the log entry.
     * @param format format
     * @param args arguments
     * @return formatted log message
     */
    public static String formatForLog(String format, Object... args) {
        String msg = String.format(format, args);
        return sanitizeForLog(msg);
    }
}