org.tango.server.admin.PollStatusCommand Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of JTangoServer Show documentation
Show all versions of JTangoServer Show documentation
Library for Tango Server (ie. Tango Device) in Java
/**
* 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
* @since 8/2/17
*/
public class PollStatusCommand implements Callable {
private final Logger logger = LoggerFactory.getLogger(PollStatusCommand.class);
private final String deviceName;
private final List classList;
PollStatusCommand(String deviceName, List classList) {
this.deviceName = deviceName;
this.classList = classList;
}
/**
* @return an array of strings with polling info
* @throws DevFailed in case device cannot be found
*/
@Override
public String[] call() throws DevFailed {
final List result = new ArrayList();
final DeviceImpl device = tryFindDeviceByName(deviceName);
addPolledStatus(result, device, device.getCommandList());
addPolledStatus(result, device, device.getAttributeList());
return result.toArray(new String[result.size()]);
}
private void addPolledStatus(List pollStatus, final DeviceImpl device, List pollableList) {
Collection polledCommands = Collections2.filter(pollableList, new Predicate() {
@Override
public boolean apply(IPollable pollable) {
return pollable.isPolled();
}
});
pollStatus.addAll(
Collections2.transform(polledCommands, new Function() {
@Override
public String apply(IPollable pollable) {
return buildPollingStatus(device, pollable).toString();
}
}));
}
private DeviceImpl tryFindDeviceByName(final String deviceName) throws DevFailed {
List allDevices = Lists.newLinkedList(Iterables.concat(Iterables.transform(classList, new Function>() {
@Override
public List apply(DeviceClassBuilder input) {
return input.getDeviceImplList();
}
})));
Optional device = Iterables.tryFind(allDevices, new Predicate() {
@Override
public boolean apply(DeviceImpl input) {
return deviceName.equalsIgnoreCase(input.getName());
}
});
if (!device.isPresent()) {
//try to find device by alias
device = Iterables.tryFind(allDevices, new Predicate() {
@Override
public boolean apply(DeviceImpl input) {
try {
//returns alias or deviceName
return TangoUtil.getfullNameForDevice(deviceName).equalsIgnoreCase(input.getName());
} catch (DevFailed devFailed) {
logger.warn("Failed to get full name for device {}", deviceName);
DevFailedUtils.logDevFailed(devFailed, logger);
return false;
}
}
});
}
if (!device.isPresent()) {
DevFailedUtils.throwDevFailed(ExceptionMessages.DEVICE_NOT_FOUND, deviceName + AdminDevice.DOES_NOT_EXIST);
}
return device.get();
}
private StringBuilder buildPollingStatus(final DeviceImpl device, final IPollable pollable) {
// XXX WARN!!! The string table is parsed by jive.Do not change a letter
// of
// the result!
//TODO do we need special output formatter for jive?
final StringBuilder buf;
if (pollable instanceof AttributeImpl) {
buf = new StringBuilder("Polled attribute name = ");
} else {
buf = new StringBuilder("Polled command name = ");
}
buf.append(pollable.getName());
if (pollable.getPollingPeriod() == 0) {
buf.append("\nPolling externally triggered");
} else {
buf.append("\nPolling period (mS) = ");
buf.append(pollable.getPollingPeriod());
}
buf.append("\nPolling ring buffer depth = ");
buf.append(pollable.getPollRingDepth());
if (pollable instanceof AttributeImpl && device.getAttributeHistorySize((AttributeImpl) pollable) == 0) {
buf.append("\nNo data recorded yet");
}
if (pollable instanceof CommandImpl && device.getCommandHistorySize((CommandImpl) pollable) == 0) {
buf.append("\nNo data recorded yet");
}
if (!pollable.getLastDevFailed().isEmpty()) {
buf.append("\nLast attribute read FAILED :\n").append(pollable.getLastDevFailed());
} else {
buf.append("\nTime needed for the last attribute reading (mS) = ");
buf.append(pollable.getExecutionDuration());
buf.append("\nData not updated since ");
buf.append(System.currentTimeMillis() - (long) pollable.getLastUpdateTime());
buf.append(" mS\nDelta between last records (in mS) = ");
buf.append(pollable.getDeltaTime());
}
return buf;
}
}