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.Constants;
23
24 /**
25 * Abstract base class for Layouts that result in a String.
26 */
27 public abstract class AbstractStringLayout extends AbstractLayout<String> {
28
29 private static final long serialVersionUID = 1L;
30
31 /**
32 * The charset for the formatted message.
33 */
34 // TODO: Charset is not serializable. Implement read/writeObject() ?
35 private final Charset charset;
36
37 protected AbstractStringLayout(final Charset charset) {
38 this(charset, null, null);
39 }
40
41 protected AbstractStringLayout(final Charset charset, final byte[] header, final byte[] footer) {
42 super(header, footer);
43 this.charset = charset == null ? Constants.UTF_8 : charset;
44 }
45
46 protected byte[] getBytes(String s) {
47 return s.getBytes(charset);
48 }
49
50 protected Charset getCharset() {
51 return charset;
52 }
53
54 /**
55 * @return The default content type for Strings.
56 */
57 @Override
58 public String getContentType() {
59 return "text/plain";
60 }
61
62 /**
63 * Formats the Log Event as a byte array.
64 *
65 * @param event
66 * The Log Event.
67 * @return The formatted event as a byte array.
68 */
69 @Override
70 public byte[] toByteArray(final LogEvent event) {
71 return toSerializable(event).getBytes(charset);
72 }
73 }