fr.esrf.TangoApi.TangoUrl Maven / Gradle / Ivy
//+======================================================================
// $Source$
//
// Project: Tango
//
// Description: java source code for the TANGO client/server API.
//
// $Author: pascal_verdier $
//
// Copyright (C) : 2004,2005,2006,2007,2008,2009,2010,2011,2012,2013,2014,
// 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
* Tango URL management.
*
* @author verdier
* @version $Revision: 25723 $
*/
public class TangoUrl implements ApiDefs, java.io.Serializable {
int protocol = TANGO;
String host = null;
String strPort = null;
int port = -1;
String devname = null;
boolean fromEnv = false;
boolean use_db = true;
static private boolean envRead = false;
public static final String NO_DATABASE = "#dbase=no";
//===================================================================
/**
* Object Constructor.
*
* @throws fr.esrf.Tango.DevFailed in case of problem to find TANGO_HOST
* @param urlStr url string to connect.
*/
//===================================================================
public TangoUrl(String urlStr) throws DevFailed {
// Get TACO/TANGO protocol
int idx;
if ((idx = urlStr.indexOf(protocol_name[TANGO] + ":")) >= 0)
protocol = TANGO;
else if ((idx = urlStr.indexOf(protocol_name[TACO] + ":")) >= 0) {
protocol = TACO;
use_db = false;
}
// replace by standard one
int len;
if (idx < 0)
idx = len = 0;
else
len = protocol_name[protocol].length() + 1;
String newUrlStr =
"http:" + urlStr.substring(idx + len);
// Build URL object
URL url = null;
try {
url = new URL(newUrlStr);
} catch (MalformedURLException e) {
// Check if malformed due to multi TANGO_HOST
boolean ok = false;
int comma = newUrlStr.indexOf(",");
if (comma > 0) {
// parse TANGO_HOST part
int start = newUrlStr.indexOf("//");
if (start >= 0) {
start += 2;
int end = newUrlStr.indexOf("/", start);
if (end < 0) // no device name
end = newUrlStr.length();
if (end > start) {
String[] array =
ApiUtil.parseTangoHost(newUrlStr.substring(start, end));
host = array[0];
strPort = array[1];
port = Integer.parseInt(strPort);
// If OK remove multi tango host before retrying URL constructor
String tmp = newUrlStr.substring(0, comma) +
newUrlStr.substring(end);
try {
url = new URL(tmp);
ok = true;
} catch (MalformedURLException ex) { /* */}
}
}
}
if (!ok) {
//e.printStackTrace();
Except.throw_wrong_syntax_exception("TangoApi_BAD_URL",
"Bad url parameter",
"TangoUrl.TangoUrl()");
}
}
// Fill object fields from URL class
assert url != null;
host = url.getHost();
port = url.getPort();
strPort = Integer.toString(port);
devname = url.getFile();
// Check if tango host and port OK
// Else retreive from environment
if (protocol==TANGO && (host == null || host.isEmpty())) {
// Check if database already connected
Database db = null;
// If default database already create, get it
if (ApiUtil.default_db_obj_exists()) {
db = ApiUtil.get_default_db_obj();
}
else {
// if tango_host is unknown --> get it from environment
setFromEnv();
if (host!=null && !host.isEmpty())
db = ApiUtil.get_db_obj(host, strPort);
else
db = ApiUtil.get_db_obj();
}
if (db != null)
envRead = true;
// TANGO_HOST must be read from environment
if (!envRead) {
setFromEnv();
if (protocol == TANGO && port < 0)
Except.throw_connection_failed("TangoApi_TANGO_HOST_NOT_SET",
"Cannot parse port number",
"TangoUrl.TangoUrl()");
} else {
// Get the DB used host and port
host = db.url.host;
port = db.url.port;
strPort = Integer.toString(port);
fromEnv = true;
}
}
// Check id device name is OK
while (devname.startsWith("/")) // if slash is first char, remove
devname = devname.substring(1);
// check if alias or device name
if (devname.length() > 0) {
int nb_slash = 0;
for (int i = 0; i < devname.length(); i++)
if (devname.charAt(i) == '/')
nb_slash++;
if (nb_slash != 0 && nb_slash != 2) // NOT alias or device name
Except.throw_wrong_syntax_exception("TangoApi_BAD_DEVICE_NAME",
"Device name (" + devname + ") wrong definition.",
"TangoUrl.TangoUrl()");
} else {
if (strPort.endsWith("/")) {
// This a device connection (database does not need a '/' at after port)
Except.throw_wrong_syntax_exception("TangoApi_BAD_DEVICE_NAME",
"Device name (" + devname + ") wrong definition.",
"TangoUrl.TangoUrl()");
}
}
// Check char used
if (devname.indexOf('#') >= 0 && devname.contains("->"))
Except.throw_wrong_syntax_exception("TangoApi_BAD_DEVICE_NAME",
"Device name (" + devname + ") wrong definition.",
"TangoUrl.TangoUrl()");
// check for dbase usage
if (protocol == TANGO) {
if (url.getRef() != null)
if (url.getRef().indexOf("dbase=no") == 0)
use_db = false;
if (host!=null)
host = getCanonicalName(host);
}
//trace(urlStr);
}
//===================================================================
/**
* Get url only from environment.
*
* @throws fr.esrf.Tango.DevFailed in case of problem to find TANGO_HOST
*/
//===================================================================
public TangoUrl() throws DevFailed {
if (protocol == TANGO)
setFromEnv();
}
//===================================================================
//===================================================================
public static String getCanonicalName(String hostName) throws DevFailed {
String canonicalHostName = null;
try {
// Get FQDN for host and real name if alias used
canonicalHostName = InetAddress.getByName(hostName).getCanonicalHostName();
if (!canonicalHostName.contains(hostName))
ApiUtil.printTrace(hostName + " ========> " + canonicalHostName);
}
catch (UnknownHostException e) {
throw new CommonDevFailed(e, "Api_GetCanonicalHostNameFailed", e.toString());
}
return canonicalHostName;
}
//===================================================================
//===================================================================
private void setFromEnv() throws DevFailed {
String env = TangoEnv.getTangoHost();
assert env != null;
if (!env.contains(":"))
Except.throw_connection_failed("TangoApi_TANGO_HOST_NOT_SET",
"Unknown \"TANGO_HOST\" property " + env,
"TangoUrl.setFromEnv()");
String[] array = ApiUtil.parseTangoHost(env);
host = array[0];
strPort = array[1];
port = Integer.parseInt(strPort);
envRead = true;
fromEnv = true;
}
//===================================================================
//===================================================================
public String getTangoHost() {
return host + ":" + port;
}
//===================================================================
//===================================================================
public String toString() {
StringBuilder sb = new StringBuilder();
if (protocol == TANGO)
sb.append("tango://").append(host).append(":").append(strPort);
else
sb.append("taco");
sb.append("/").append(devname);
if (!use_db)
sb.append(NO_DATABASE);
return sb.toString();
}
//===================================================================
/**
* Trace the url parameters
* @param urlStr the url string
*/
//===================================================================
public void trace(String urlStr) {
System.out.println("\n================" + urlStr + "====================");
System.out.println(" protocol = " + protocol_name[protocol]);
if (host != null)
System.out.println(" host name= " + host);
//if (port>0)
System.out.println(" port num = " + strPort);
System.out.println(" device = " + devname);
if (use_db)
System.out.println(" use database");
else
System.out.println(" Do NOT use database");
System.out.println();
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy