001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements. See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache license, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License. You may obtain a copy of the License at
008 *
009 *      http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the license for the specific language governing permissions and
015 * limitations under the license.
016 */
017package org.apache.logging.log4j.core.layout;
018
019import java.nio.charset.Charset;
020
021import org.apache.logging.log4j.core.LogEvent;
022import org.apache.logging.log4j.core.util.Constants;
023
024/**
025 * Abstract base class for Layouts that result in a String.
026 */
027public abstract class AbstractStringLayout extends AbstractLayout<String> {
028
029    private static final long serialVersionUID = 1L;
030
031    /**
032     * The charset for the formatted message.
033     */
034    // TODO: Charset is not serializable. Implement read/writeObject() ?
035    private final Charset charset;
036
037    protected AbstractStringLayout(final Charset charset) {
038        this(charset, null, null);
039    }
040
041    protected AbstractStringLayout(final Charset charset, final byte[] header, final byte[] footer) {
042        super(header, footer);
043        this.charset = charset == null ? Constants.UTF_8 : charset;
044    }
045
046    protected byte[] getBytes(String s) {
047        return s.getBytes(charset);
048    }
049
050    protected Charset getCharset() {
051        return charset;
052    }
053
054    /**
055     * @return The default content type for Strings.
056     */
057    @Override
058    public String getContentType() {
059        return "text/plain";
060    }
061
062    /**
063     * Formats the Log Event as a byte array.
064     *
065     * @param event
066     *        The Log Event.
067     * @return The formatted event as a byte array.
068     */
069    @Override
070    public byte[] toByteArray(final LogEvent event) {
071        return toSerializable(event).getBytes(charset);
072    }
073}