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, byte[] header, byte[] footer) {
35 super(header, footer);
36 this.charset = charset == null ? Charsets.UTF_8 : charset;
37 }
38
39 protected AbstractStringLayout(final Charset charset) {
40 this(charset, null, null);
41 }
42
43 /**
44 * Formats the Log Event as a byte array.
45 *
46 * @param event
47 * The Log Event.
48 * @return The formatted event as a byte array.
49 */
50 @Override
51 public byte[] toByteArray(final LogEvent event) {
52 return toSerializable(event).getBytes(charset);
53 }
54
55 /**
56 * @return The default content type for Strings.
57 */
58 @Override
59 public String getContentType() {
60 return "text/plain";
61 }
62
63 protected Charset getCharset() {
64 return charset;
65 }
66 }