1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one or more
3 * contributor license agreements. See the NOTICE file distributed with
4 * this work for additional information regarding copyright ownership.
5 * The ASF licenses this file to You under the Apache license, Version 2.0
6 * (the "License"); you may not use this file except in compliance with
7 * the License. You may obtain a copy of the License at
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the license for the specific language governing permissions and
15 * limitations under the license.
16 */
17 package org.apache.logging.log4j.core.layout;
18
19 import java.nio.charset.Charset;
20
21 import org.apache.logging.log4j.core.LogEvent;
22 import org.apache.logging.log4j.core.util.Charsets;
23
24 /**
25 * Abstract base class for Layouts that result in a String.
26 */
27 public abstract class AbstractStringLayout extends AbstractLayout<String> {
28
29 /**
30 * The charset for the formatted message.
31 */
32 private final Charset charset;
33
34 protected AbstractStringLayout(final Charset charset) {
35 this.charset = charset == null ? Charsets.UTF_8 : charset;
36 }
37
38 /**
39 * Formats the Log Event as a byte array.
40 *
41 * @param event The Log Event.
42 * @return The formatted event as a byte array.
43 */
44 @Override
45 public byte[] toByteArray(final LogEvent event) {
46 return toSerializable(event).getBytes(charset);
47 }
48
49 /**
50 * @return The default content type for Strings.
51 */
52 @Override
53 public String getContentType() {
54 return "text/plain";
55 }
56
57 protected Charset getCharset() {
58 return charset;
59 }
60 }