org.tango.server.events.ArchiveEventTrigger Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of JTangoServer Show documentation
Library for Tango Server (ie. Tango Device) in Java
There is a newer version: 10.0.0
/**
 * 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.events;

import fr.esrf.Tango.DevFailed;
import fr.esrf.Tango.EventProperties;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.slf4j.ext.XLogger;
import org.slf4j.ext.XLoggerFactory;
import org.tango.server.Constants;
import org.tango.server.ExceptionMessages;
import org.tango.server.attribute.AttributeImpl;
import org.tango.utils.DevFailedUtils;

/**
 * manage trigger for {@link EventType#ARCHIVE_EVENT}
 *
 * @author ABEILLE
 */
public class ArchiveEventTrigger implements IEventTrigger {
    private final Logger logger = LoggerFactory.getLogger(ArchiveEventTrigger.class);
    private final XLogger xlogger = XLoggerFactory.getXLogger(ArchiveEventTrigger.class);

    private final ChangeEventTrigger change;
    private final AttributeImpl attribute;
    private PeriodicEventTrigger periodic = null;

    /**
     * Ctr
     *
     * @param period    The archive period
     * @param absolute  The archive absolute change delta
     * @param relative  The archive relative change delta
     * @param attribute The attribute that send events
     */
    public ArchiveEventTrigger(final long period, final String absolute, final String relative,
                               final AttributeImpl attribute) {
        this.attribute = attribute;
        periodic = new PeriodicEventTrigger(period, attribute);
        change = new ChangeEventTrigger(attribute, absolute, relative);
    }

    /**
     * Check if event criteria are set for specified attribute
     *
     * @param attribute the specified attribute
     * @throws DevFailed if no event criteria is set for specified attribute.
     */
    public static void checkEventCriteria(final AttributeImpl attribute) throws DevFailed {
        // Check if value is not numerical (always true for State and String)
        if (attribute.isState() || attribute.isString()) {
            return;
        }
        // Else check criteria
        final EventProperties props = attribute.getProperties().getEventProp();
        if (attribute.isCheckArchivingEvent()) {
            if (props.arch_event.period.equals(Constants.NOT_SPECIFIED) && props.arch_event.abs_change.equals(Constants.NOT_SPECIFIED)
                    && props.arch_event.rel_change.equals(Constants.NOT_SPECIFIED)) {
                throw DevFailedUtils.newDevFailed(ExceptionMessages.EVENT_CRITERIA_NOT_SET,
                        "Archive event properties (period or abs_change or rel_change) for attribute " + attribute.getName()
                                + " are not set");
            }
        }
    }

    @Override
    public boolean isSendEvent() throws DevFailed {
        xlogger.entry();
        boolean isSend = periodic.isSendEvent();
        if (!isSend) {
            isSend = change.isSendEvent();
        }

        logger.debug("ARCHIVE event must send: {}", isSend);
        xlogger.exit();
        return isSend;
    }

    @Override
    public void setError(final DevFailed error) {
        change.setError(error);
    }

    @Override
    public void updateProperties() throws DevFailed {
        final EventProperties props = attribute.getProperties().getEventProp();
        long period = -1;
        try {
            period = Long.parseLong(props.arch_event.period);
        } catch (final NumberFormatException e) {
        }
        periodic.setPeriod(period);
        change.setCriteria(props.arch_event.abs_change, props.arch_event.rel_change);

    }

    @Override
    public boolean doCheck() {
        return attribute.isCheckArchivingEvent();
    }

    @Override
    public boolean isPushedFromDeviceCode() {
        return attribute.isPushArchiveEvent();
    }
}