org.tango.server.admin.AdminDevice 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 classList;
@Status
private String status;
private IExporter tangoExporter;
private TangoStats tangoStats;
/**
* Init the device
*
* @throws DevFailed
*/
@Init
@StateMachine(endState = DeviceState.ON)
public void init() throws DevFailed {
xlogger.entry();
TangoCacheManager.setPollSize(pollingThreadsPoolSize);
// logger.debug("init admin device with quartzThreadsPoolSize = {}",
// quartzThreadsPoolSize);
status = "The device is ON\nThe polling is ON";
tangoStats = TangoStats.getInstance();
xlogger.exit();
}
/**
* Set the tango exporter
*
* @param tangoExporter
*/
public void setTangoExporter(final IExporter tangoExporter) {
this.tangoExporter = tangoExporter;
}
/**
* Set the class list
*
* @param classList
*/
public void setClassList(final List classList) {
this.classList = classList;
}
/**
* get the polling status
*
* @param deviceName
* Device name
* @return Device polling status
* @throws DevFailed
*/
@Command(name = "DevPollStatus", inTypeDesc = DEVICE_NAME, outTypeDesc = "Device polling status")
public String[] getPollStatus(final String deviceName) throws DevFailed {
xlogger.entry(deviceName);
String[] ret = new PollStatusCommand(deviceName, classList).call();
xlogger.exit(ret);
return ret;
}
/**
*
* @return Device class list
* @throws DevFailed
*/
@Command(name = "QueryClass", outTypeDesc = "Device server class(es) list")
public String[] queryClass() throws DevFailed {
xlogger.entry();
final String[] ret = new String[classList.size() - 1];
int i = 0;
for (final DeviceClassBuilder clazz : classList) {
if (!clazz.getDeviceClass().equals(AdminDevice.class)) {
ret[i++] = clazz.getClassName();
}
}
xlogger.exit(Arrays.toString(ret));
return ret;
}
/**
*
* @return Device list
* @throws DevFailed
*/
@Command(name = "QueryDevice", outTypeDesc = "Device server device(s) list")
public String[] queryDevice() throws DevFailed {
xlogger.entry();
final List deviceNames = new ArrayList();
for (final DeviceClassBuilder clazz : classList) {
if (!clazz.getDeviceClass().equals(AdminDevice.class)) {
for (final DeviceImpl dev : clazz.getDeviceImplList()) {
deviceNames.add(clazz.getClassName() + "::" + dev.getName());
}
}
}
xlogger.exit();
return deviceNames.toArray(new String[deviceNames.size()]);
}
/**
* Command QuerySubDevice
*
* @return Device server sub device(s) list
* @throws DevFailed
*/
@Command(name = "QuerySubDevice", outTypeDesc = "Device server sub device(s) list")
public String[] querySubDevice() throws DevFailed {
// TODO QuerySubDevice
// final Set names = DeviceProxyFactory.getProxies().keySet();
// return names.toArray(new String[names.size()]);
return new String[0];
}
/**
*
* @param deviceName
* Device name
* @throws DevFailed
*/
@Command(name = "DevRestart", inTypeDesc = DEVICE_NAME)
public void restart(final String deviceName) throws DevFailed {
xlogger.entry();
int nbClasses = 0;
final ClntIdent id = tangoExporter.getDevice("DServer", ServerManager.getInstance().getAdminDeviceName())
.getClientIdentity();
for (final DeviceClassBuilder deviceClass : classList) {
if (deviceClass.containsDevice(deviceName)) {
// a device cannot be restarted if locked by another client
deviceClass.getDeviceImpl(deviceName).checkLocking(id);
tangoExporter.buildDevice(deviceName, deviceClass);
xlogger.exit();
break;
}
nbClasses++;
}
if (nbClasses == classList.size()) {
DevFailedUtils.throwDevFailed(ExceptionMessages.DEVICE_NOT_FOUND, deviceName + DOES_NOT_EXISTS);
}
}
@Command(name = "EventSubscriptionChange", inTypeDesc = "Event consumer wants to subscribe to", outTypeDesc = "Tango lib release")
public int eventSubscriptionChange(final String[] argin) {
return 0;
}
/**
* Restart the whole server and its devices.
*
* @throws DevFailed
*/
@Command(name = "RestartServer")
public void restartServer() throws DevFailed {
xlogger.entry();
tangoExporter.unexportAll();
tangoExporter.exportAll();
xlogger.exit();
}
/**
* Unexport everything and kill it self
*
* @throws DevFailed
*/
@Command(name = "Kill")
public void kill() throws DevFailed {
xlogger.entry();
// do it in a thread to avoid throwing error to client
new Thread() {
@Override
public void run() {
logger.error("kill server");
try {
tangoExporter.unexportAll();
} catch (final DevFailed e) {
} finally {
ORBManager.shutdown();
System.exit(-1);
}
logger.error("everything has been shutdown normally");
}
}.start();
xlogger.exit();
}
/**
* Start logging
*/
@Command(name = "StartLogging")
public void startLogging() {
LoggingManager.getInstance().startAll();
}
/**
* Stop logging
*/
@Command(name = "StopLogging")
public void stopLogging() {
LoggingManager.getInstance().stopAll();
}
/**
* Send logs to a device
*
* @param argin
* @throws DevFailed
*/
@Command(name = "AddLoggingTarget", inTypeDesc = "Str[i]=Device-name. Str[i+1]=Target-type::Target-name")
public void addLoggingTarget(final String[] argin) throws DevFailed {
if (argin.length % 2 != 0) {
DevFailedUtils.throwDevFailed(INPUT_ERROR, "argin must be of even size");
}
for (int i = 0; i < argin.length - 1; i = i + 2) {
final String deviceName = argin[i];
final String[] config = argin[i + 1].split(LoggingManager.LOGGING_TARGET_SEPARATOR);
if (config.length != 2) {
DevFailedUtils.throwDevFailed(INPUT_ERROR, "config must be of size 2: targetType::targetName");
}
if (config[0].equalsIgnoreCase(LoggingManager.LOGGING_TARGET_DEVICE)) {
Class className = null;
for (final DeviceClassBuilder deviceClass : classList) {
if (deviceClass.containsDevice(deviceName)) {
className = deviceClass.getDeviceClass();
break;
}
}
if (className != null) {
LoggingManager.getInstance().addDeviceAppender(config[1], className, deviceName);
}
} else {
LoggingManager.getInstance().addFileAppender(config[1], deviceName);
}
}
}
/**
* remove logging to a device
*
* @param argin
* @throws DevFailed
*/
@Command(name = "RemoveLoggingTarget", inTypeDesc = "Str[i]=Device-name. Str[i+1]=Target-type::Target-name")
public void removeLoggingTarget(final String[] argin) throws DevFailed {
if (argin.length % 2 != 0) {
DevFailedUtils.throwDevFailed(INPUT_ERROR, "argin must be of even size");
}
for (int i = 0; i < argin.length - 1; i = i + 2) {
final String deviceName = argin[i];
final String[] config = argin[i + 1].split(LoggingManager.LOGGING_TARGET_SEPARATOR);
if (config.length != 2) {
DevFailedUtils.throwDevFailed(INPUT_ERROR, "config must be of size 2: targetType::targetName");
}
LoggingManager.getInstance().removeAppender(deviceName, config[0]);
}
}
/**
* Get the logging level
*
* @param deviceNames
* @return the current logging levels
*/
@Command(name = "GetLoggingLevel", inTypeDesc = "Device list", outTypeDesc = "Lg[i]=Logging Level. Str[i]=Device name.")
public DevVarLongStringArray getLoggingLevel(final String[] deviceNames) {
final int[] levels = new int[deviceNames.length];
for (int i = 0; i < levels.length; i++) {
levels[i] = LoggingManager.getInstance().getLoggingLevel(deviceNames[i]);
}
return new DevVarLongStringArray(levels, deviceNames);
}
/**
* Get logging target
*
* @param deviceName
* @return Logging target list
* @throws DevFailed
*/
@Command(name = "GetLoggingTarget", inTypeDesc = DEVICE_NAME, outTypeDesc = "Logging target list")
public String[] getLoggingTarget(final String deviceName) throws DevFailed {
return LoggingManager.getInstance().getLoggingTarget(deviceName);
}
/**
* Set logging level
*
* @param dvlsa
* Lg[i]=Logging Level. Str[i]=Device name.
* @throws DevFailed
*/
@Command(name = "SetLoggingLevel", inTypeDesc = "Lg[i]=Logging Level. Str[i]=Device name.")
public void setLoggingLevel(final DevVarLongStringArray dvlsa) throws DevFailed {
final int[] levels = dvlsa.lvalue;
final String[] deviceNames = dvlsa.svalue;
if (deviceNames.length != levels.length) {
DevFailedUtils.throwDevFailed(INPUT_ERROR, "argin must be of same size for string and long ");
}
for (int i = 0; i < levels.length; i++) {
LoggingManager.getInstance().setLoggingLevel(deviceNames[i], levels[i]);
}
}
/**
* Get status
*
* @return the status
*/
public String getStatus() {
return status;
}
/**
* set status
*
* @param status
*/
public void setStatus(final String status) {
this.status = status;
}
/**
*
* @return Polled device name list
*/
@Command(name = "PolledDevice", outTypeDesc = "Polled device name list")
public String[] getPolledDevice() {
xlogger.entry();
final Set pollDevices = new LinkedHashSet();
for (final DeviceClassBuilder deviceClass : classList) {
for (final DeviceImpl device : deviceClass.getDeviceImplList()) {
for (final CommandImpl command : device.getCommandList()) {
if (command.isPolled()) {
pollDevices.add(device.getName());
}
}
for (final AttributeImpl attribute : device.getAttributeList()) {
if (attribute.isPolled()) {
pollDevices.add(device.getName());
}
}
}
}
xlogger.exit();
return pollDevices.toArray(new String[pollDevices.size()]);
}
/**
*
* @param dvlsa
* Lg[0]=Upd period. Str[0]=Device name. Str[1]=Object
* type(COMMAND or ATTRIBUTE). Str[2]=Object name
* @throws DevFailed
*/
@Command(name = "AddObjPolling", inTypeDesc = "Lg[0]=Upd period. Str[0]=Device name. Str[1]=Object type. Str[2]=Object name")
public void addPolling(final DevVarLongStringArray dvlsa) throws DevFailed {
xlogger.entry();
// Check that parameters number is correct
if (dvlsa.svalue.length != 3 || dvlsa.lvalue.length != 1) {
DevFailedUtils.throwDevFailed(ExceptionMessages.WRONG_NR_ARGS, "Incorrect number of inout arguments");
}
final String deviceName = dvlsa.svalue[0];
final String type = dvlsa.svalue[1];
final String polledObjectName = dvlsa.svalue[2];
final int pollPeriod = dvlsa.lvalue[0];
logger.info("add polling for {}/{} {} with period {}", new Object[]{deviceName, polledObjectName, type,
pollPeriod});
for (final DeviceClassBuilder deviceClass : classList) {
if (deviceClass.containsDevice(deviceName)) {
final DeviceImpl dev = deviceClass.getDeviceImpl(deviceName);
if (type.equalsIgnoreCase(PolledObjectType.ATTRIBUTE.toString())) {
dev.addAttributePolling(polledObjectName, pollPeriod);
} else {
dev.addCommandPolling(polledObjectName, pollPeriod);
}
break;
}
}
xlogger.exit();
}
/**
* Command UpdObjPollingPeriod
*
* @param dvlsa
* @throws DevFailed
*/
@Command(name = "UpdObjPollingPeriod", inTypeDesc = "Lg[0]=Upd period. Str[0]=Device name. Str[1]=Object type. Str[2]=Object name")
public void updatePollingPeriod(final DevVarLongStringArray dvlsa) throws DevFailed {
addPolling(dvlsa);
}
/**
* Command RemObjPolling
*
* @param devices
* deviceName,type= {attribute or command},name1, namei
* @throws DevFailed
*/
@Command(name = "RemObjPolling", inTypeDesc = "Str[0]=Device name. Str[1]=Object type. Str[2]=Object name")
public void removePolling(final String[] devices) throws DevFailed {
xlogger.entry();
if (devices.length < 3) {
DevFailedUtils.throwDevFailed(ExceptionMessages.WRONG_NR_ARGS, "Incorrect number of inout arguments");
}
final String deviceName = devices[0];
final String type = devices[1];
final String[] attributes = Arrays.copyOfRange(devices, 2, devices.length);
for (final String attribute : attributes) {
for (final DeviceClassBuilder deviceClass : classList) {
if (deviceClass.containsDevice(deviceName)) {
final DeviceImpl dev = deviceClass.getDeviceImpl(deviceName);
if (type.equalsIgnoreCase(PolledObjectType.ATTRIBUTE.toString())) {
logger.debug("remove polling of attribute {} on device {}", attribute, deviceName);
dev.removeAttributePolling(attribute);
} else {
logger.debug("remove polling of command {} on device {}", attribute, deviceName);
dev.removeCommandPolling(attribute);
}
}
}
}
xlogger.exit();
}
/**
* Stop polling
*/
@Command(name = "StopPolling")
public void stopPolling() {
xlogger.entry();
for (final DeviceClassBuilder deviceClass : classList) {
for (final DeviceImpl dev : deviceClass.getDeviceImplList()) {
dev.stopPolling();
}
}
status = "The device is ON\nThe polling is OFF";
xlogger.exit();
}
/**
* Start polling
*/
@Command(name = "StartPolling")
public void startPolling() {
xlogger.entry();
for (final DeviceClassBuilder deviceClass : classList) {
for (final DeviceImpl dev : deviceClass.getDeviceImplList()) {
dev.startPolling();
}
}
status = "The device is ON\nThe polling is ON";
xlogger.exit();
}
/**
* Get class properties
*
* @param className
* @return class properties
* @throws DevFailed
*/
@Command(name = "QueryWizardClassProperty", inTypeDesc = "Class name", outTypeDesc = "Class property list (name - description and default value)")
public String[] queryClassProp(final String className) throws DevFailed {
xlogger.entry();
final List names = new ArrayList();
for (final DeviceClassBuilder deviceClass : classList) {
if (deviceClass.getClassName().equalsIgnoreCase(className)) {
final List devices = deviceClass.getDeviceImplList();
if (devices.size() > 0) {
final DeviceImpl dev = devices.get(0);
final List props = dev.getClassPropertyList();
for (final ClassPropertyImpl prop : props) {
names.add(prop.getName());
names.add(prop.getDescription());
names.add("");// default value
}
}
break;
}
}
xlogger.exit();
return names.toArray(new String[names.size()]);
}
/**
* Get device properties
*
* @param className
* @return device properties and descriptions
*/
@Command(name = "QueryWizardDevProperty", inTypeDesc = "Class name", outTypeDesc = "Device property list (name - description and default value)")
public String[] queryDevProp(final String className) {
xlogger.entry();
final List names = new ArrayList();
for (final DeviceClassBuilder deviceClass : classList) {
if (deviceClass.getClassName().equalsIgnoreCase(className)) {
final List devices = deviceClass.getDeviceImplList();
if (devices.size() > 0) {
final DeviceImpl dev = devices.get(0);
final List props = dev.getDevicePropertyList();
for (final DevicePropertyImpl prop : props) {
names.add(prop.getName());
names.add(prop.getDescription());
names.add(prop.getDefaultValue()[0]);// default value
}
}
break;
}
}
xlogger.exit(names);
return names.toArray(new String[names.size()]);
}
/**
*
* @param argin
* @throws DevFailed
*/
@Command(name = "ZmqEventSubscriptionChange", inTypeDesc = "Events consumer wants to subscribe to", outTypeDesc = "Str[0] = Heartbeat pub endpoint - Str[1] = Event pub endpoint - Lg[0] = Tango lib release - Lg[1] = Device IDL release")
public DevVarLongStringArray zmqEventSubscriptionChange(final String[] argin) throws DevFailed {
xlogger.entry();
// A simple way to be used in debug
if (argin.length == 1) {
if (argin[0].equals("info")) {
return EventManager.getInstance().getInfo();
} else {
DevFailedUtils.throwDevFailed(ExceptionMessages.WRONG_NR_ARGS,
"Command ZmqEventSubscriptionChange expect 4 input arguments");
}
}
// Normal usage: Subscribe to the specified event
if (argin.length < 4) {
DevFailedUtils.throwDevFailed(ExceptionMessages.WRONG_NR_ARGS,
"Command ZmqEventSubscriptionChange expect 4 input arguments");
}
final String deviceName = argin[0].toLowerCase(Locale.ENGLISH);
final String attributeName = argin[1].toLowerCase(Locale.ENGLISH);
// argin[2] - "subscribe" not used.
final String eventTypeAndIDL = argin[3].toLowerCase(Locale.ENGLISH);
// check idl version is contained in event name like "idl5_archive"
final Pattern p = Pattern.compile(EventManager.IDL_REGEX);
final Matcher m = p.matcher(eventTypeAndIDL);
DevVarLongStringArray returned;
if (m.matches()) {
returned = subcribeIDLInEventString(eventTypeAndIDL, deviceName, attributeName);
} else {
int idlversion = EventManager.MINIMUM_IDL_VERSION;
if (argin.length == 5) {
idlversion = Integer.parseInt(argin[4]);
}
final EventType eventType = EventType.getEvent(eventTypeAndIDL);
logger.debug("Subscribe event for {}/{} with type {}",
new Object[]{deviceName, attributeName, eventType});
// Search the specified device and attribute objects
final Pair result = findSubscribers(eventType, deviceName, attributeName);
returned = subscribeEvent(eventType, deviceName, idlversion, result.getRight(), result.getLeft());
}
xlogger.exit();
return returned;
}
@Command(name = "EventConfirmSubscription")
public void eventConfirmSubscription(final String[] argin) throws DevFailed {
xlogger.entry(Arrays.toString(argin));
if (argin.length == 0 || argin.length % 3 != 0) {
throw DevFailedUtils.newDevFailed(ExceptionMessages.WRONG_NR_ARGS, "must a modulo 3 length");
}
final int eventNb = argin.length / 3;
for (int i = 0; i < eventNb; i++) {
final int idx = i * 3;
final String deviceName = argin[idx].toLowerCase(Locale.ENGLISH);
final String objName = argin[idx + 1].toLowerCase(Locale.ENGLISH);
final String eventTypeAndIDL = argin[idx + 2].toLowerCase(Locale.ENGLISH);
// event name like "idl5_archive" or "archive"
subcribeIDLInEventString(eventTypeAndIDL, deviceName, objName);
xlogger.exit();
}
}
/**
* Manage event subcription with event name like "idl5_archive" or "archive"
*
* @param eventTypeAndIDL
* @param deviceName
* @param objName
* @return
* @throws DevFailed
*/
private DevVarLongStringArray subcribeIDLInEventString(final String eventTypeAndIDL, final String deviceName,
final String objName) throws DevFailed {
// event name like "idl5_archive" or "archive"
String event = eventTypeAndIDL;
int idlversion = EventManager.MINIMUM_IDL_VERSION;
if (eventTypeAndIDL.contains(EventManager.IDL_LATEST)) {
idlversion = DeviceImpl.SERVER_VERSION;
event = eventTypeAndIDL.substring(eventTypeAndIDL.indexOf("_") + 1, eventTypeAndIDL.length());
}
final EventType eventType = EventType.getEvent(event);
logger.debug("event subscription/confirmation for {}, attribute/pipe {} with type {} and IDL {}", new Object[]{
deviceName, objName, eventType, idlversion});
final Pair result = findSubscribers(eventType, deviceName, objName);
return subscribeEvent(eventType, deviceName, idlversion, result.getRight(), result.getLeft());
}
private Pair findSubscribers(final EventType eventType, final String deviceName,
final String objName) throws DevFailed {
DeviceImpl device = null;
PipeImpl pipe = null;
AttributeImpl attribute = null;
for (final DeviceClassBuilder deviceClass : classList) {
for (final DeviceImpl deviceImpl : deviceClass.getDeviceImplList()) {
if (deviceImpl.getName().toLowerCase(Locale.ENGLISH).equals(deviceName)) {
if (eventType.equals(EventType.INTERFACE_CHANGE_EVENT)) {
// event for INTERFACE_CHANGE_EVENT does not have an attribute
device = deviceImpl;
} else if (eventType.equals(EventType.PIPE_EVENT)) {
for (final PipeImpl pipeImpl : deviceImpl.getPipeList()) {
if (pipeImpl.getName().toLowerCase(Locale.ENGLISH).equals(objName)) {
// Found. Store objects
device = deviceImpl;
pipe = pipeImpl;
}
}
} else {
for (final AttributeImpl attributeImpl : deviceImpl.getAttributeList()) {
if (attributeImpl.getName().toLowerCase(Locale.ENGLISH).equals(objName)) {
if (attributeImpl.getBehavior() instanceof ForwardedAttribute) {
// Found. Store objects
device = deviceImpl;
attribute = attributeImpl;
} else if (attributeImpl.isPolled()) {
// Check if event criteria are set. Otherwise a DevFailed is thrown
EventManager.checkEventCriteria(attributeImpl, eventType);
// Found. Store objects
device = deviceImpl;
attribute = attributeImpl;
} else {
// check if event is pushed from device
boolean throwError = false;
switch (eventType) {
case ARCHIVE_EVENT:
if (!attributeImpl.isPushArchiveEvent()) {
throwError = true;
}
break;
case CHANGE_EVENT:
if (!attributeImpl.isPushChangeEvent()) {
throwError = true;
}
break;
case DATA_READY_EVENT:
if (!attributeImpl.isPushDataReady()) {
throwError = true;
}
break;
case USER_EVENT:
case ATT_CONF_EVENT:
case INTERFACE_CHANGE_EVENT:
break;
case PERIODIC_EVENT:
default:
throwError = true;
break;
}
if (throwError) {
DevFailedUtils.throwDevFailed(ExceptionMessages.ATTR_NOT_POLLED,
"The polling (necessary to send events) for the attribute " + objName
+ " is not started");
} else {
device = deviceImpl;
attribute = attributeImpl;
}
}
}
} // end for
}// end if
}// end if
}// end for
} // end for
if (eventType.equals(EventType.PIPE_EVENT)) {
if (pipe == null) {
DevFailedUtils.throwDevFailed(ExceptionMessages.ATTR_NOT_FOUND, "Pipe " + objName + " not found");
}
} else if (!eventType.equals(EventType.INTERFACE_CHANGE_EVENT) && attribute == null) { // Not
// found
DevFailedUtils.throwDevFailed(ExceptionMessages.ATTR_NOT_FOUND, "Attribute " + objName + " not found");
}
if (device == null) { // Not found
DevFailedUtils.throwDevFailed(ExceptionMessages.DEVICE_NOT_FOUND, "Device " + deviceName + " not found");
}
return ImmutablePair.of(pipe, attribute);
}
private DevVarLongStringArray subscribeEvent(final EventType eventType, final String deviceName,
final int idlversion, final AttributeImpl attribute, final PipeImpl pipe) throws DevFailed {
DevVarLongStringArray result;
// Subscribe and returns connection parameters for client
// Str[0] = Heartbeat pub endpoint -
// Str[1] = Event pub endpoint
// - Lg[0] = Tango lib release
// - Lg[1] = Device IDL release
// - Lg[2] = High Water Mark buffer size
// - Lg[3] = Multicast info
// - Lg[4] = Multicast info
// - Lg[5] = ZMQ release
if (eventType.equals(EventType.INTERFACE_CHANGE_EVENT)) {
// event for INTERFACE_CHANGE_EVENT does not have an attribute
result = EventManager.getInstance().subcribe(deviceName);
} else if (eventType.equals(EventType.PIPE_EVENT)) {
result = EventManager.getInstance().subcribe(deviceName, pipe);
} else {
result = EventManager.getInstance().subcribe(deviceName, attribute, eventType, idlversion);
}
return result;
}
/**
*
* @param argin
* @throws DevFailed
*/
@Command(name = "LockDevice", inTypeDesc = "Str[0] = Device name. Lg[0] = Lock validity")
public void lockDevice(final DevVarLongStringArray argin) throws DevFailed {
if (argin.svalue.length != 1 && argin.lvalue.length != 1) {
DevFailedUtils.throwDevFailed(ExceptionMessages.WRONG_NR_ARGS, "Incorrect number of inout arguments");
}
final String deviceName = argin.svalue[0];
final int validity = argin.lvalue[0];
logger.debug("locking {} with {}", deviceName, validity);
if (deviceName.equalsIgnoreCase(ServerManager.getInstance().getAdminDeviceName())) {
DevFailedUtils.throwDevFailed(ExceptionMessages.DEVICE_UNLOCKABLE, deviceName + " not lockable");
}
// identify the client who's asking to lock
ClntIdent id = null;
for (final DeviceClassBuilder deviceClass : classList) {
if (deviceClass.containsDevice(ServerManager.getInstance().getAdminDeviceName())) {
id = deviceClass.getDeviceImpl(ServerManager.getInstance().getAdminDeviceName()).getClientIdentity();
break;
}
}
int nbClasses = 0;
for (final DeviceClassBuilder deviceClass : classList) {
if (deviceClass.containsDevice(deviceName)) {
deviceClass.getDeviceImpl(deviceName).lock(validity, id,
ServerRequestInterceptor.getInstance().getGiopHostAddress());
xlogger.exit();
break;
}
nbClasses++;
}
if (nbClasses == classList.size()) {
DevFailedUtils.throwDevFailed(ExceptionMessages.DEVICE_NOT_FOUND, deviceName + DOES_NOT_EXISTS);
}
}
/**
* Command UnLockDevice
*
* @param argin
* @return Device global lock counter
* @throws DevFailed
*/
@Command(name = "UnLockDevice", inTypeDesc = "Str[x] = Device name(s). Lg[0] = Force flag", outTypeDesc = "Device global lock counter")
public int unlockDevice(final DevVarLongStringArray argin) throws DevFailed {
final String[] deviceNames = argin.svalue;
boolean isForced = false;
if (argin.lvalue[0] == 1) {
isForced = true;
}
logger.debug("unlocking {} - force = {}", Arrays.toString(deviceNames), isForced);
for (final String deviceName : deviceNames) {
int nbClasses = 0;
for (final DeviceClassBuilder deviceClass : classList) {
if (deviceClass.containsDevice(deviceName)) {
deviceClass.getDeviceImpl(deviceName).unLock(isForced);
xlogger.exit();
break;
}
nbClasses++;
}
if (nbClasses == classList.size()) {
DevFailedUtils.throwDevFailed(ExceptionMessages.DEVICE_NOT_FOUND, deviceName + DOES_NOT_EXISTS);
}
}
return 0;
}
/**
*
* @param deviceNames
* @throws DevFailed
*/
@Command(name = "ReLockDevices", inTypeDesc = "Device(s) name")
public void relockDevice(final String[] deviceNames) throws DevFailed {
for (final String deviceName : deviceNames) {
logger.debug("re locking {} ", deviceName);
if (deviceName.equalsIgnoreCase(ServerManager.getInstance().getAdminDeviceName())) {
DevFailedUtils.throwDevFailed(ExceptionMessages.DEVICE_UNLOCKABLE, deviceName + " not lockable");
}
for (final DeviceClassBuilder deviceClass : classList) {
if (deviceClass.containsDevice(deviceName)) {
deviceClass.getDeviceImpl(deviceName).relock();
xlogger.exit();
}
}
}
}
/**
* Command DevLockStatus
*
* @param deviceName
* device name
* @return lock status
* @throws DevFailed
*/
@Command(name = "DevLockStatus", inTypeDesc = DEVICE_NAME, outTypeDesc = "Device locking status")
public DevVarLongStringArray devLockStatus(final String deviceName) throws DevFailed {
DevVarLongStringArray result = null;
int nbClasses = 0;
final String fullDeviceName = TangoUtil.getfullNameForDevice(deviceName);
for (final DeviceClassBuilder deviceClass : classList) {
if (deviceClass.containsDevice(fullDeviceName)) {
result = deviceClass.getDeviceImpl(fullDeviceName).getLockStatus();
xlogger.exit();
break;
}
nbClasses++;
}
if (nbClasses == classList.size()) {
DevFailedUtils.throwDevFailed(ExceptionMessages.DEVICE_NOT_FOUND, deviceName + DOES_NOT_EXISTS);
}
logger.debug("DevLockStatus {} {}", Arrays.toString(result.lvalue), Arrays.toString(result.svalue));
return result;
}
public void setPollingThreadsPoolSize(final int pollingThreadsPoolSize) {
this.pollingThreadsPoolSize = pollingThreadsPoolSize;
}
@Override
public String getServerName() {
return "";
}
@Override
@Attribute
public String getLastRequest() {
return tangoStats.getLastRequest();
}
@Override
@Attribute
public String getMaxRequest() {
return tangoStats.getMaxRequest();
}
@Override
@Attribute
public long getRequestsPerSecond() {
return tangoStats.getRequestsPerSecond();
}
@Override
@Attribute
public long getLastRequestDuration() {
return tangoStats.getLastRequestDuration();
}
@Override
@Attribute
public long getMaxRequestDuration() {
return tangoStats.getMaxRequestDuration();
}
@Override
@Attribute
public long getAverageRequestDuration() {
return tangoStats.getAverageRequestDuration();
}
@Override
@Attribute
public long getMinRequestDuration() {
return tangoStats.getMinRequestDuration();
}
@Override
@Command
public void resetStats() {
tangoStats.resetStats();
}
@Override
@Attribute
public long getErrorNr() {
return tangoStats.getErrorNr();
}
@Override
public long getMaxRequestsPerSecond() {
return tangoStats.getMaxRequestsPerSecond();
}
@Override
public long getAverageRequestsPerSecond() {
return tangoStats.getAverageRequestsPerSecond();
}
@Override
public long getMinRequestsPerSecond() {
return tangoStats.getMinRequestsPerSecond();
}
// public void setQuartzThreadsPoolSize(final int quartzThreadsPoolSize) {
// this.quartzThreadsPoolSize = quartzThreadsPoolSize;
// DeviceScheduler.setThreadPoolSize(quartzThreadsPoolSize);
// }
}