org.tango.server.attribute.log.LogAttribute Maven / Gradle / Ivy

Go to download
/**
 * Copyright (C) :     2012
 *
 * 	Synchrotron Soleil
 * 	L'Orme des merisiers
 * 	Saint Aubin
 * 	BP48
 * 	91192 GIF-SUR-YVETTE CEDEX
 *
 * This file is part of Tango.
 *
 * Tango is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * Tango is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with Tango.  If not, see .
 */
package org.tango.server.attribute.log;

import java.util.Arrays;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.tango.server.StateMachineBehavior;
import org.tango.server.attribute.AttributeConfiguration;
import org.tango.server.attribute.AttributeValue;
import org.tango.server.attribute.IAttributeBehavior;

import fr.esrf.Tango.AttrDataFormat;
import fr.esrf.Tango.AttrWriteType;
import fr.esrf.Tango.DevFailed;
import fr.esrf.TangoDs.TangoConst;

/**
 * An image attribute that contains logs from a list of {@link Logger}
 *
 * @author ABEILLE
 *
 */
public class LogAttribute implements IAttributeBehavior {

    private final Logger logger = LoggerFactory.getLogger(LogAttribute.class);
    private final AttributeAppender attributeAppender;
    private String attributeName = "";

    /**
     * Build an attribute "log" which is an image of string.
     *
     * @param depth max logging size
     * @param loggers the loggers to log
     */
    public LogAttribute(final int depth, final Logger... loggers) {
        logger.debug("create log attribute for loggers {}", Arrays.toString(loggers));
        attributeName = "log";
        attributeAppender = new AttributeAppender(depth);
        for (final Logger logger : loggers) {
            if (logger instanceof ch.qos.logback.classic.Logger) {
                this.logger.debug(" add appender {}", logger);
                final ch.qos.logback.classic.Logger loggerBack = (ch.qos.logback.classic.Logger) logger;
                loggerBack.addAppender(attributeAppender);
                attributeAppender.start();
            }
        }
    }

    /**
     * Build an attribute which is an image of string.
     *
     * @param attributeName The attribute name
     * @param depth max logging size
     * @param loggers the loggers to log
     */
    public LogAttribute(final String attributeName, final int depth, final Logger... loggers) {
        this(depth, loggers);
        this.attributeName = attributeName;
    }

    @Override
    public AttributeConfiguration getConfiguration() throws DevFailed {
        final AttributeConfiguration config = new AttributeConfiguration();
        config.setName(attributeName);
        config.setTangoType(TangoConst.Tango_DEV_STRING, AttrDataFormat.IMAGE);
        config.setWritable(AttrWriteType.READ);
        return config;
    }

    @Override
    public AttributeValue getValue() throws DevFailed {
        return new AttributeValue(attributeAppender.getLog());
    }

    @Override
    public void setValue(final AttributeValue value) throws DevFailed {
    }

    @Override
    public StateMachineBehavior getStateMachine() throws DevFailed {
        return null;
    }

}