org.tango.server.device.DeviceManager 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.device;

import org.apache.commons.lang3.builder.ReflectionToStringBuilder;
import org.apache.commons.lang3.builder.ToStringStyle;
import org.tango.orb.ServerRequestInterceptor;
import org.tango.server.annotation.DeviceManagement;
import org.tango.server.attribute.AttributeImpl;
import org.tango.server.attribute.AttributePropertiesImpl;
import org.tango.server.attribute.AttributeValue;
import org.tango.server.command.CommandImpl;
import org.tango.server.events.EventManager;
import org.tango.server.events.EventType;
import org.tango.server.pipe.PipeImpl;
import org.tango.server.pipe.PipeValue;
import org.tango.server.servant.AttributeGetterSetter;
import org.tango.server.servant.DeviceImpl;
import org.tango.utils.ClientIDUtil;
import org.tango.utils.DevFailedUtils;

import fr.esrf.Tango.ClntIdent;
import fr.esrf.Tango.DevFailed;

/**
 * Global info and tool for a device. Injected with {@link DeviceManagement}
 *
 * @author ABEILLE
 *
 */
public final class DeviceManager {

    private final DeviceImpl device;
    private final String name;
    private final String className;
    private final String adminName;

    /**
     * Ctr
     *
     * @param device
     */
    public DeviceManager(final DeviceImpl device) {
        this.device = device;
        name = device.getName();
        className = device.getClassName();
        adminName = device.getAdminDeviceName();
    }

    /**
     *
     * @return name of the device
     */
    public String getName() {
        return name;
    }

    /**
     *
     * @return class of the device, as defined in tango db
     */
    public String getClassName() {
        return className;
    }

    /**
     *
     * @return admin device name
     */
    public String getAdminName() {
        return adminName;
    }

    /**
     * Get an attribute's properties
     *
     * @param attributeName
     *            the attribute name
     * @return its properties
     * @throws DevFailed
     */
    public AttributePropertiesImpl getAttributeProperties(final String attributeName) throws DevFailed {
        final AttributeImpl attr = AttributeGetterSetter.getAttribute(attributeName, device.getAttributeList());
        return attr.getProperties();
    }

    /**
     * Configure an attribute's properties
     *
     * @param attributeName
     *            the attribute name
     * @param properties
     *            its properties
     * @throws DevFailed
     */
    public void setAttributeProperties(final String attributeName, final AttributePropertiesImpl properties)
            throws DevFailed {
        final AttributeImpl attr = AttributeGetterSetter.getAttribute(attributeName, device.getAttributeList());
        attr.setProperties(properties);
    }

    /**
     * Remove an attribute's properties
     *
     * @param attributeName
     *            the attribute name
     * @throws DevFailed
     */
    public void removeAttributeProperties(final String attributeName) throws DevFailed {
        final AttributeImpl attr = AttributeGetterSetter.getAttribute(attributeName, device.getAttributeList());
        attr.removeProperties();
    }

    /**
     * Check if an attribute or an command is polled
     *
     * @param polledObject
     *            The name of the polled object (attribute or command)
     * @return true if polled
     * @throws DevFailed
     */
    public boolean isPolled(final String polledObject) throws DevFailed {
        try {
            return AttributeGetterSetter.getAttribute(polledObject, device.getAttributeList()).isPolled();
        } catch (final DevFailed e) {
            return device.getCommand(polledObject).isPolled();
        }
    }

    /**
     * Get polling period of an attribute or a command
     *
     * @param polledObject
     *            The name of the polled object (attribute or command)
     * @return The polling period
     * @throws DevFailed
     */
    public int getPollingPeriod(final String polledObject) throws DevFailed {
        try {
            return AttributeGetterSetter.getAttribute(polledObject, device.getAttributeList()).getPollingPeriod();
        } catch (final DevFailed e) {
            return device.getCommand(polledObject).getPollingPeriod();
        }
    }

    /**
     * Configure polling of an attribute or a command and start it
     *
     * @param polledObject The name of the polled object (attribute or command)
     * @param pollingPeriod The polling period
     * @throws DevFailed
     */
    public void startPolling(final String polledObject, final int pollingPeriod) throws DevFailed {
        try {
            final AttributeImpl attr = AttributeGetterSetter.getAttribute(polledObject, device.getAttributeList());
            attr.configurePolling(pollingPeriod);
            device.configurePolling(attr);
        } catch (final DevFailed e) {
            if (polledObject.equalsIgnoreCase(DeviceImpl.STATE_NAME)
                    || polledObject.equalsIgnoreCase(DeviceImpl.STATUS_NAME)) {
                final CommandImpl cmd = device.getCommand(polledObject);
                cmd.configurePolling(pollingPeriod);
                device.configurePolling(cmd);
            } else {
                throw e;
            }
        }
    }

    public void stopPolling(final String polledObject) throws DevFailed {
        try {
            device.removeAttributePolling(polledObject);
        } catch (final DevFailed e) {
            if (polledObject.equalsIgnoreCase(DeviceImpl.STATE_NAME)
                    || polledObject.equalsIgnoreCase(DeviceImpl.STATUS_NAME)) {
                device.removeCommandPolling(polledObject);
            } else {
                throw e;
            }
        }
    }

    /**
     * Update polling cache. Works only if polling period is zero.
     *
     * @param polledObject
     *            The name of the polled object (attribute or command)
     * @throws DevFailed
     */
    public void triggerPolling(final String polledObject) throws DevFailed {
        device.triggerPolling(polledObject);
    }

    /**
     * Push an event if some client had register it. The method will perform a read on the requested attribute before
     * sending the event
     *
     * @param attributeName The attribute name
     * @param eventType The type of event to fire
     * @throws DevFailed
     */
    public void pushEvent(final String attributeName, final EventType eventType) throws DevFailed {
        switch (eventType) {
            case CHANGE_EVENT:
            case ARCHIVE_EVENT:
            case USER_EVENT:
                // get attribute value
                final AttributeImpl attribute = AttributeGetterSetter.getAttribute(attributeName,
                        device.getAttributeList());
                try {
                    attribute.updateValue();
                    // push the event
                    EventManager.getInstance().pushAttributeEvent(name, attributeName, eventType);
                } catch (final DevFailed e) {
                    EventManager.getInstance().pushAttributeEvent(name, attributeName, e);
                }
                break;
            default:
                throw DevFailedUtils.newDevFailed("Only USER, ARCHIVE or CHANGE event can be send");
        }
    }

    /**
     * Push an event if some client had register it.
     *
     * @param attributeName The attribute name
     * @param eventType The type of event to fire
     * @throws DevFailed
     */
    public void pushEvent(final String attributeName, final AttributeValue value, final EventType eventType)
            throws DevFailed {
        switch (eventType) {
            case CHANGE_EVENT:
            case ARCHIVE_EVENT:
            case USER_EVENT:
                // set attribute value
                final AttributeImpl attribute = AttributeGetterSetter.getAttribute(attributeName,
                        device.getAttributeList());
                try {
                    attribute.updateValue(value);
                    // push the event
                    EventManager.getInstance().pushAttributeEvent(name, attributeName, eventType);
                } catch (final DevFailed e) {
                    EventManager.getInstance().pushAttributeEvent(name, attributeName, e);
                }
                break;
            default:
                throw DevFailedUtils.newDevFailed("Only USER, ARCHIVE or CHANGE event can be send");
        }
    }

    /**
     * Push a DATA_READY event if some client had registered it
     *
     * @param attributeName The attribute name
     * @param counter
     * @throws DevFailed
     */
    public void pushDataReadyEvent(final String attributeName, final int counter) throws DevFailed {
        EventManager.getInstance().pushAttributeDataReadyEvent(name, attributeName, counter);
    }

    /**
     * Push a PIPE EVENT event if some client had registered it
     *
     * @param pipeName The pipe name
     * @param blob The pipe data
     * @throws DevFailed
     */
    public void pushPipeEvent(final String pipeName, final PipeValue blob) throws DevFailed {
        // set attribute value
        final PipeImpl pipe = DeviceImpl.getPipe(pipeName, device.getPipeList());
        try {
            pipe.updateValue(blob);
            // push the event
            EventManager.getInstance().pushPipeEvent(name, pipeName, blob);
        } catch (final DevFailed e) {
            EventManager.getInstance().pushPipeEvent(name, pipeName, e);
        }
    }

    /**
     * Get the client identity of the current request. WARNING: works only if the client is of version IDL4 and for
     * these requests: read_attribute(s), write_attribute(s), write_read_attribute(s), command_inout.
     *
     * @return the client identity
     */
    @Deprecated
    public ClntIdent getClientIdentity() {
        return ClientIDUtil.copyClntIdent(device.getClientIdentity());
    }

    /**
     * Get the client host name of the current request
     *
     * @return
     */
    @Deprecated
    public String getClientHostName() {
        return ServerRequestInterceptor.getInstance().getClientHostName();
    }

    public boolean hasEventSubsriber() {
        return EventManager.getInstance().hasSubscriber(name);
    }

    @Override
    public String toString() {
        final ReflectionToStringBuilder reflectionToStringBuilder = new ReflectionToStringBuilder(this,
                ToStringStyle.SHORT_PREFIX_STYLE);
        reflectionToStringBuilder.setExcludeFieldNames(new String[] { "device" });
        return reflectionToStringBuilder.toString();
    }
}