org.apache.logging.log4j.core.pattern.EncodingPatternConverter Maven / Gradle / Ivy
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You 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 org.apache.logging.log4j.core.pattern;
import java.util.List;
import org.apache.logging.log4j.core.LogEvent;
import org.apache.logging.log4j.core.config.Configuration;
import org.apache.logging.log4j.core.config.plugins.Plugin;
import org.apache.logging.log4j.core.layout.PatternLayout;
/**
* Returns the event's rendered message in a StringBuilder.
*/
@Plugin(name = "encode", category = PatternConverter.CATEGORY)
@ConverterKeys({ "enc", "encode" })
public final class EncodingPatternConverter extends LogEventPatternConverter {
private final List formatters;
/**
* Private constructor.
*
* @param formatters The PatternFormatters to generate the text to manipulate.
*/
private EncodingPatternConverter(final List formatters) {
super("encode", "encode");
this.formatters = formatters;
}
/**
* Obtains an instance of pattern converter.
*
* @param config The Configuration.
* @param options options, may be null.
* @return instance of pattern converter.
*/
public static EncodingPatternConverter newInstance(final Configuration config, final String[] options) {
if (options.length != 1) {
LOGGER.error("Incorrect number of options on escape. Expected 1, received " + options.length);
return null;
}
if (options[0] == null) {
LOGGER.error("No pattern supplied on escape");
return null;
}
final PatternParser parser = PatternLayout.createPatternParser(config);
final List formatters = parser.parse(options[0]);
return new EncodingPatternConverter(formatters);
}
/**
* {@inheritDoc}
*/
@Override
public void format(final LogEvent event, final StringBuilder toAppendTo) {
final StringBuilder buf = new StringBuilder();
for (final PatternFormatter formatter : formatters) {
formatter.format(event, buf);
}
for (int i = 0; i < buf.length(); i++) {
final char c = buf.charAt(i);
switch (c) {
case '\r':
toAppendTo.append("\\r");
break;
case '\n':
toAppendTo.append("\\n");
break;
case '&':
toAppendTo.append("&");
break;
case '<':
toAppendTo.append("<");
break;
case '>':
toAppendTo.append(">");
break;
case '"':
toAppendTo.append(""");
break;
case '\'':
toAppendTo.append("'");
break;
case '/':
toAppendTo.append("/");
break;
default:
toAppendTo.append(c);
break;
}
}
}
}