fr.esrf.TangoApi.DbServerStructure Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of JTangoCommons Show documentation
Show all versions of JTangoCommons Show documentation
Common classes for tango java API
//+======================================================================
// $Source$
//
// Project: Tango
//
// Description: java source code for the TANGO client/srcServer API.
//
// $Author: pascal_verdier $
//
// Copyright (C) : 2004,2005,2006,2007,2008,2009,2010,2011,2012,2013,2014,,2013
// European Synchrotron Radiation Facility
// BP 220, Grenoble 38043
// FRANCE
//
// 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 classes = new ArrayList();
//===============================================================
/**
* Constructor for DbServerStructure.
* It will read the server structure from database.
*
* @param serverName the specified server (ServerName/InstanceName)
* @throws DevFailed in case of read database fails.
*/
//===============================================================
public DbServerStructure(String serverName) throws DevFailed {
this.serverName = serverName;
buildStructure();
}
//===============================================================
/**
* Constructor for DbServerStructure.
* It will read the server structure from database.
*
* @param serverName the specified server (ServerName/InstanceName)
* @param tangoHost the specified TANGO_HOST
* @throws DevFailed in case of read database fails.
*/
//===============================================================
public DbServerStructure(String serverName, String tangoHost) throws DevFailed {
this.serverName = serverName;
int pos = tangoHost.indexOf(':');
if (pos<0 || pos==tangoHost.length())
Except.throw_exception("BAD_SYNTAX",
"TANGO_HOST name is not valid", "DbServerStructure.DbServerStructure()");
tgHost = tangoHost.substring(0, pos);
tgPort = tangoHost.substring(pos+1);
buildStructure();
}
//===============================================================
/**
* Constructor for DbServerStructure.
* It will read the server structure from database.
*
* @param serverName the specified server (ServerName/InstanceName)
* @param host host where database is running.
* @param port port for database connection.
* @throws DevFailed in case of read database fails.
*/
//===============================================================
public DbServerStructure(String serverName, String host, String port) throws DevFailed {
this.serverName = serverName;
tgHost = host;
tgPort = port;
buildStructure();
}
//===============================================================
//===============================================================
private void buildStructure() throws DevFailed {
DbServer server;
if (tgHost ==null || tgPort ==null)
server = new DbServer(serverName);
else {
server = new DbServer(serverName, tgHost, tgPort);
}
// Check if server defined in database.
String adminName = (tgHost ==null)? "" : "tango://"+ tgHost +":"+ tgPort +"/";
adminName += "dserver/"+serverName.toLowerCase();
new DeviceProxy(adminName);
// Build Server classes
String[] classNames = server.get_class_list();
classes.add(new TangoClass("DServer"));
for (String className : classNames) {
classes.add(new TangoClass(className));
}
}
//===============================================================
/**
* Returns the server name
* @return the server name
*/
//===============================================================
public String getName() {
return serverName;
}
//===============================================================
/**
* Returns list of Tango classes for server
* @return list of Tango classes for server
*/
//===============================================================
@SuppressWarnings("UnusedDeclaration")
public ArrayList getClasses() {
return classes;
}
//===============================================================
/**
* Put the DbServerStructure object in the database specified by tango host.
*
* @param tangoHost the specified tango host (Host:Port)
* @throws DevFailed in case of write database fails
*/
//===============================================================
public void putInDatabase(String tangoHost) throws DevFailed {
Database database = ApiUtil.get_db_obj(tangoHost);
createTheServer(database);
putProperties(database);
}
//===============================================================
/**
* Check if the server or one of its devices already exists in database specified by tango host
*
* @param tangoHost the specified tango host (Host:Port)
* @return true if serer already defined
* @throws DevFailed if a database read fails.
*/
//===============================================================
public boolean alreadyExists(String tangoHost) throws DevFailed {
String header = "tango://"+tangoHost+"/";
// Check if server defined in database.
try {
new DeviceProxy(header + "dserver/"+serverName.toLowerCase());
return true;
}
catch (DevFailed e){ /* Does not exist. --> Continue */ }
// Check if at least one device already defined
for (TangoClass clazz : classes) {
for (TangoDevice device : clazz) {
try {
new DeviceProxy(header+device.name);
return true;
}
catch (DevFailed e) {
if (!e.errors[0].desc.contains("not defined in the database"))
Except.re_throw_exception(e, "FailedToCheck",
"Failed to check " + device.name + "in " + tangoHost,
"DbServerStructure.alreadyExists()");
}
}
}
return false;
}
//===============================================================
/**
* Create the server in specified database
*
* @param database the specified database.
* @throws DevFailed if a write in database fails
*/
//===============================================================
private void createTheServer(Database database) throws DevFailed {
ArrayList deviceInfoList =new ArrayList();
for (TangoClass clazz : classes) {
for (TangoDevice device : clazz) {
deviceInfoList.add(new DbDevInfo(device.name, clazz.name, serverName));
}
}
DbDevInfo[] deviceInfoArray = new DbDevInfo[deviceInfoList.size()];
for (int i=0 ; i=0 ; i--) {
for (TangoDevice device : classes.get(i)) {
database.delete_device(device.name);
}
}
// Check if there is other instance(s) of classes
for (TangoClass clazz : classes) {
if (!clazz.name.toLowerCase().equals("dserver")) { // NOT for DServer class
String[] deviceNames = database.get_device_name("*", clazz.name);
if (deviceNames.length==0) {
// There is no device any more --> remove class properties
clazz.removeProperties(database);
//System.out.println("Class properties removed for " + clazz.name);
}
else {
//System.out.println(clazz.name + " class is used. do not delete Class properties");
}
}
}
}
//===============================================================
public String toString() {
return serverName;
}
//===============================================================
//===============================================================
//===============================================================
/**
* A class defining a Tango class
*/
//===============================================================
public class TangoClass extends ArrayList {
String name;
ArrayList properties = new ArrayList();
ArrayList attributes = new ArrayList();
ArrayList pipes = new ArrayList();
//===========================================================
private TangoClass(String name) throws DevFailed {
this.name = name;
Database database =
(tgHost ==null)? ApiUtil.get_db_obj() : ApiUtil.get_db_obj(tgHost, tgPort);
// Read properties
String[] propertyNames = database.get_class_property_list(name, "*");
if (propertyNames.length>0) {
DbDatum[] propertyValues = database.get_class_property(name, propertyNames);
for (int i=0 ; i pipeNames = database.getClassPipeList(name);
for (String pipeName : pipeNames) {
// Read pipe properties
DbPipe dbPipe = database.getClassPipeProperties(name, pipeName);
for (DbDatum datum : dbPipe) {
if (!datum.is_empty()) {
TangoPipe pipe = new TangoPipe(pipeName);
pipe.add(new TangoProperty(datum.name, datum.extractStringArray()));
pipes.add(pipe);
}
}
}
}
catch (DevFailed e) {
// Database server manage pipes ?
if (e.errors[0].reason.equals("API_CommandNotFound"))
System.err.println(e.errors[0].desc);
else
throw e;
}
// Build devices
String[] deviceNames = (tgHost ==null) ?
new DbServer(serverName).get_device_name(name)
: new DbServer(serverName, tgHost, tgPort).get_device_name(name);
for (String deviceName : deviceNames)
add(new TangoDevice(deviceName));
}
//===========================================================
public String getName() {
return name;
}
//===========================================================
@SuppressWarnings("UnusedDeclaration")
public ArrayList getProperties() {
return properties;
}
//===========================================================
@SuppressWarnings("UnusedDeclaration")
public ArrayList getAttributes() {
return attributes;
}
//===========================================================
@SuppressWarnings("UnusedDeclaration")
public ArrayList getPipes() {
return pipes;
}
//===========================================================
private void putProperties(Database database) throws DevFailed {
if (properties.size()>0) {
DbDatum[] data = new DbDatum[properties.size()];
int i=0;
for (TangoProperty property : properties) {
data[i++] = new DbDatum(property.name, property.values);
}
database.put_class_property(name, data);
}
}
//===========================================================
private void putAttributeProperties(Database database) throws DevFailed {
ArrayList dbAttributeList = new ArrayList();
if (attributes.size()>0) {
// Build the DbDAttribute list for the class
for (TangoAttribute attribute : attributes) {
if (attribute.size()>0) {
DbAttribute dbAttribute = new DbAttribute(name);
for (TangoProperty property : attribute) {
dbAttribute.add(new DbDatum(property.name, property.values));
}
dbAttributeList.add(dbAttribute);
}
}
// Copy in array before put in database
DbAttribute[] dbAttributes = new DbAttribute[dbAttributeList.size()];
for (int i=0 ; i dbPipeList = new ArrayList();
if (dbPipeList.size()>0) {
// Build the DbDAttribute list for the class
for (TangoPipe pipe : pipes) {
if (pipe.size()>0) {
DbPipe dbPipe = new DbPipe(name);
for (TangoProperty property : pipe) {
dbPipe.add(new DbDatum(property.name, property.values));
}
dbPipeList.add(dbPipe);
}
}
database.putClassPipeProperty(name, dbPipeList);
}
}
catch (DevFailed e) {
// Database server manage pipes ?
if (e.errors[0].reason.equals("API_CommandNotFound"))
System.err.println(e.errors[0].desc);
else
throw e;
}
}
//===========================================================
private void removeProperties(Database database) throws DevFailed {
// delete class properties if any
if (properties.size()>0) {
String[] propertyNames = new String[properties.size()];
for (int i=0 ; i0) {
for (TangoAttribute attribute : attributes) {
if (attribute.size()>0) {
String[] propertyNames = new String[attribute.size()];
for (int i=0 ; i0) {
for (TangoPipe pipe : pipes) {
if (pipe.size()>0) {
String[] propertyNames = new String[pipe.size()];
for (int i=0 ; i properties = new ArrayList();
ArrayList attributes = new ArrayList();
ArrayList pipes = new ArrayList();
//===========================================================
TangoDevice(String name) throws DevFailed{
this.name = name;
String fullName =
(tgHost ==null) ? name : "tango://"+ tgHost +":"+ tgPort +"/"+name;
deviceProxy = new DeviceProxy(fullName);
// Read properties
String[] propertyNames = deviceProxy.get_property_list("*");
if (propertyNames.length>0) {
DbDatum[] propertyValues = deviceProxy.get_property(propertyNames);
for (int i=0 ; i pipeNames = database.getDevicePipeList(name);
for (String pipeName : pipeNames) {
// Read attribute properties
DbPipe dbPipe = database.getDevicePipeProperties(name, pipeName);
for (DbDatum datum : dbPipe) {
if (!datum.is_empty()) {
TangoPipe pipe = new TangoPipe(pipeName);
pipe.add(new TangoProperty(datum.name, datum.extractStringArray()));
pipes.add(pipe);
}
}
}
}
catch (DevFailed e) {
// Database server manage pipes ?
if (e.errors[0].reason.equals("API_CommandNotFound"))
System.err.println(e.errors[0].desc);
else
throw e;
}
}
//===========================================================
public String getName() {
return name;
}
//===========================================================
@SuppressWarnings("UnusedDeclaration")
public ArrayList getProperties() {
return properties;
}
//===========================================================
@SuppressWarnings("UnusedDeclaration")
public ArrayList getAttributes() {
return attributes;
}
//===========================================================
@SuppressWarnings("UnusedDeclaration")
public ArrayList getPipes() {
return pipes;
}
//===========================================================
private void putProperties(Database database) throws DevFailed {
if (properties.size()>0) {
DbDatum[] data = new DbDatum[properties.size()];
int i=0;
for (TangoProperty property : properties) {
data[i++] = new DbDatum(property.name, property.values);
}
database.put_device_property(name, data);
}
}
//===========================================================
private void putAttributeProperties(Database database) throws DevFailed {
ArrayList dbAttributeList = new ArrayList();
if (attributes.size()>0) {
// Build the DbAttribute list for the class
for (TangoAttribute attribute : attributes) {
if (attribute.size()>0) {
DbAttribute dbAttribute = new DbAttribute(attribute.name);
for (TangoProperty property : attribute) {
dbAttribute.add(new DbDatum(property.name, property.values));
}
dbAttributeList.add(dbAttribute);
}
}
// Copy in array before put in database
DbAttribute[] dbAttributes = new DbAttribute[dbAttributeList.size()];
for (int i=0 ; i dbPipeList = new ArrayList();
if (pipes.size()>0) {
// Build the DbPipe list for the class
for (TangoPipe pipe : pipes) {
if (pipe.size()>0) {
DbPipe dbPipe = new DbPipe(pipe.name);
for (TangoProperty property : pipe) {
dbPipe.add(new DbDatum(property.name, property.values));
}
dbPipeList.add(dbPipe);
}
}
database.putDevicePipeProperty(name, dbPipeList);
}
}
catch (DevFailed e) {
// Database server manage pipes ?
if (e.errors[0].reason.equals("API_CommandNotFound"))
System.err.println(e.errors[0].desc);
else
throw e;
}
}
//===========================================================
public String toString() {
return name;
}
//===========================================================
}
//===============================================================
//===============================================================
//===============================================================
/**
* A class defining a Tango attribute
*/
//===============================================================
public class TangoAttribute extends ArrayList {
String name;
//===========================================================
TangoAttribute(String name) {
this.name = name;
}
//===========================================================
public String toString() {
return name;
}
//===========================================================
}
//===============================================================
//===============================================================
//===============================================================
/**
* A class defining a Tango Pipe
*/
//===============================================================
public class TangoPipe extends ArrayList {
String name;
//===========================================================
TangoPipe(String name) {
this.name = name;
}
//===========================================================
public String toString() {
return name;
}
//===========================================================
}
//===============================================================
//===============================================================
//===============================================================
/**
* A class defining a Tango property
*/
//===============================================================
public class TangoProperty {
String name;
String[] values;
//===========================================================
TangoProperty(String name, String[] values) {
this.name = name;
this.values = values;
}
//===========================================================
public String toString() {
String str = name;
if (values.length>0) {
str += ": " + values[0];
if (values.length>1)
str += "...";
}
return str;
}
//===========================================================
}
//===============================================================
//===============================================================
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy