// ----------------------------------------------------------------------------
// Copyright 2007-2013, GeoTelematic Solutions, Inc.
// All rights reserved
// ----------------------------------------------------------------------------
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//
// ----------------------------------------------------------------------------
// Description:
// Device Communication Server configuration (central registry for port usage)
// ----------------------------------------------------------------------------
// Change History:
// 2009/04/02 Martin D. Flynn
// -Initial release
// 2009/07/01 Martin D. Flynn
// -Added support for sending commands to the appropriate DCS.
// 2009/08/23 Martin D. Flynn
// -Added several additional common runtime property methods.
// 2009/09/23 Martin D. Flynn
// -Changed 'getSimulateDigitalInputs' to return a mask
// 2011/05/13 Martin D. Flynn
// -Added "getMinimumHDOP"
// 2011/08/21 Martin D. Flynn
// -Added "getIgnoreDeviceOdometer()"
// 2013/05/28 Martin D. Flynn
// -Added aditional argument adjustment types (see "_adjustKeyArg")
// -Changed CommandProtocol.SMS to value '9' (was '2').
// ----------------------------------------------------------------------------
package org.opengts.db;
import java.lang.*;
import java.util.*;
import java.io.*;
import java.net.*;
import javax.xml.parsers.*;
import org.w3c.dom.*;
import org.xml.sax.*;
import org.opengts.util.*;
import org.opengts.dbtools.*;
import org.opengts.db.tables.*;
public class DCServerConfig
implements Comparable
{
// ------------------------------------------------------------------------
// flags
// default property group id
public static final String DEFAULT_PROP_GROUP_ID = "default";
// Boolean Properties
public static final String P_NONE = "none";
public static final String P_HAS_INPUTS = "hasInputs";
public static final String P_HAS_OUTPUTS = "hasOutputs";
public static final String P_COMMAND_SMS = "commandSms";
public static final String P_COMMAND_UDP = "commandUdp";
public static final String P_COMMAND_TCP = "commandTcp";
public static final String P_XMIT_TCP = "transmitTcp";
public static final String P_XMIT_UDP = "transmitUdp";
public static final String P_XMIT_SMS = "transmitSms";
public static final String P_XMIT_SAT = "transmitSat";
public static final String P_JAR_OPTIONAL = "jarOptional";
public static final long F_NONE = 0x00000000L;
public static final long F_HAS_INPUTS = 0x00000002L; // hasInputs
public static final long F_HAS_OUTPUTS = 0x00000004L; // hasOutputs
public static final long F_COMMAND_TCP = 0x00000100L; // commandTcp
public static final long F_COMMAND_UDP = 0x00000200L; // commandUdp
public static final long F_COMMAND_SMS = 0x00000400L; // commandSms
public static final long F_XMIT_TCP = 0x00001000L; // transmitTcp
public static final long F_XMIT_UDP = 0x00002000L; // transmitUdp
public static final long F_XMIT_SMS = 0x00004000L; // transmitSms
public static final long F_XMIT_SAT = 0x00008000L; // transmitSat
public static final long F_JAR_OPTIONAL = 0x00010000L; // jarOptional
public static final long F_STD_VEHICLE = F_HAS_INPUTS | F_HAS_OUTPUTS | F_XMIT_TCP | F_XMIT_UDP;
public static final long F_STD_PERSONAL = F_XMIT_TCP | F_XMIT_UDP;
/**
*** Gets the attribute flag mask for the specified RTProperties instance.
*** @param rtp The RTProperties instance constructed from the "Attributes" tag
*** in the DCS "dcserver_XXXX.xml" file.
*** @return The attribute flag mask
**/
public static long GetAttributeFlags(RTProperties rtp)
{
long flags = 0L;
if (rtp.getBoolean(P_HAS_INPUTS ,false)) { flags |= F_HAS_INPUTS ; }
if (rtp.getBoolean(P_HAS_OUTPUTS ,false)) { flags |= F_HAS_OUTPUTS ; }
if (rtp.getBoolean(P_COMMAND_SMS ,false)) { flags |= F_COMMAND_SMS ; }
if (rtp.getBoolean(P_COMMAND_UDP ,false)) { flags |= F_COMMAND_UDP ; }
if (rtp.getBoolean(P_COMMAND_TCP ,false)) { flags |= F_COMMAND_TCP ; }
if (rtp.getBoolean(P_XMIT_TCP ,false)) { flags |= F_XMIT_TCP ; }
if (rtp.getBoolean(P_XMIT_UDP ,false)) { flags |= F_XMIT_UDP ; }
if (rtp.getBoolean(P_XMIT_SMS ,false)) { flags |= F_XMIT_SMS ; }
if (rtp.getBoolean(P_XMIT_SAT ,false)) { flags |= F_XMIT_SAT ; }
if (rtp.getBoolean(P_JAR_OPTIONAL,false)) { flags |= F_JAR_OPTIONAL; }
return flags;
}
// ------------------------------------------------------------------------
// ------------------------------------------------------------------------
public enum CommandProtocol implements EnumTools.IsDefault, EnumTools.IntValue {
UDP(0,"udp"),
TCP(1,"tcp"),
SMS(9,"sms");
// ---
private int vv = 0;
private String ss = "";
CommandProtocol(int v, String s) { vv = v; ss = s; }
public int getIntValue() { return vv; }
public String toString() { return ss; }
public boolean isDefault() { return this.equals(UDP); }
public boolean isSMS() { return this.equals(SMS); }
};
/**
*** Gets the CommandProtocol Enum value, based on the value of the specified String
*** @param v The command protocol name
*** @return The CommandProtocol Enum value
**/
public static CommandProtocol getCommandProtocol(String v)
{
// returns 'null' if protocol value is invalid
return EnumTools.getValueOf(CommandProtocol.class, v);
}
// ------------------------------------------------------------------------
// ------------------------------------------------------------------------
/**
*** Device event code to status code translation
**/
public static class EventCode
{
private int oldCode = 0;
private int statusCode = StatusCodes.STATUS_NONE;
private String dataString = null;
private long dataLong = Long.MIN_VALUE;
public EventCode(int oldCode, int statusCode, String data) {
this.oldCode = oldCode;
this.statusCode = statusCode;
this.dataString = data;
this.dataLong = StringTools.parseLong(data, Long.MIN_VALUE);
}
public int getCode() {
return this.oldCode;
}
public int getStatusCode() {
return this.statusCode;
}
public String getDataString(String dft) {
return !StringTools.isBlank(this.dataString)? this.dataString : dft;
}
public long getDataLong(long dft) {
return (this.dataLong != Long.MIN_VALUE)? this.dataLong : dft;
}
public String toString() {
return StringTools.toHexString(this.getCode(),16) + " ==> 0x" + StringTools.toHexString(this.getStatusCode(),16);
}
}
// ------------------------------------------------------------------------
// ------------------------------------------------------------------------
/* Perl 'psjava' command (relative to GTS_HOME) */
private static final String PSJAVA_PERL = File.separator + "bin" + File.separator + "psjava";
/**
*** Returns the "psjava" command relative to GTS_HOME
*** @return The "psjava" command relative to GTS_HOME
**/
public static String getPSJavaCommand()
{
File psjava = FileTools.toFile(DBConfig.get_GTS_HOME(), new String[] {"bin","psjava"});
if (psjava != null) {
return psjava.toString();
} else {
return null;
}
}
/**
*** Returns the "psjava" command relative to GTS_HOME, and returning the
*** specified information for the named jar file
*** @param name The DCServerConfig name
*** @param display The type of information to return ("pid", "name", "user")
*** @return The returned 'display' information for the specified DCServerConfig
**/
public static String getPSJavaCommand_jar(String name, String display)
{
String psjava = DCServerConfig.getPSJavaCommand();
if (!StringTools.isBlank(psjava)) {
StringBuffer sb = new StringBuffer();
sb.append(psjava);
if (OSTools.isWindows()) {
sb.append(" \"-jar=").append(name).append(".jar\"");
if (!StringTools.isBlank(display)) {
sb.append(" \"-display="+display+"\"");
}
} else {
sb.append(" -jar=").append(name).append(".jar");
if (!StringTools.isBlank(display)) {
sb.append(" -display="+display+"");
}
}
return sb.toString();
} else {
return null;
}
}
/**
*** Returns the file path for the named running DCServerConfig jar files.
*** This method will return 'null' if no DCServerConfig jar files with the specified
*** name are currently running.
*** All matching running DCServerConfig entries will be returned.
*** @param name The DCServerConfig name
*** @return The matching running jar file paths, or null if no matching server enteries are running.
**/
public static File[] getRunningJarPath(String name)
{
if (OSTools.isLinux() || OSTools.isMacOS()) {
try {
String cmd = DCServerConfig.getPSJavaCommand_jar(name,"name");
Process process = (cmd != null)? Runtime.getRuntime().exec(cmd) : null;
if (process != null) {
BufferedReader procReader = new BufferedReader(new InputStreamReader(process.getInputStream()));
StringBuffer sb = new StringBuffer();
for (;;) {
String line = procReader.readLine();
if (line == null) { break; }
sb.append(StringTools.trim(line));
}
process.waitFor();
procReader.close();
int exitVal = process.exitValue();
if (exitVal == 0) {
String jpath[] = StringTools.split(sb.toString(), '\n');
java.util.List jpl = new Vector();
for (int i = 0; i < jpath.length; i++) {
if (StringTools.isBlank(jpath[i])) { continue; }
File jarPath = new File(sb.toString());
try {
jpl.add(jarPath.getCanonicalFile());
} catch (Throwable th) {
jpl.add(jarPath);
}
}
if (!ListTools.isEmpty(jpl)) {
return jpl.toArray(new File[jpl.size()]);
}
}
} else {
if (StringTools.isBlank(cmd)) {
Print.logWarn("Unable to create 'psjava' command for '"+name+"'");
} else {
Print.logError("Unable to execute command: " + cmd);
}
}
} catch (Throwable th) {
Print.logException("Unable to determine if Tomcat is running:", th);
}
return null;
} else {
// not supported on Windows
return null;
}
}
/**
*** Return log file paths from jar file paths
**/
public static File getLogFilePath(File jarPath)
{
if (jarPath != null) {
// "/usr/local/GTS_1.2.3/build/lib/enfora.jar"
String jarName = jarPath.getName();
if (jarName.endsWith(".jar")) {
String name = jarName.substring(0,jarName.length()-4);
File logDir = new File(jarPath.getParentFile().getParentFile().getParentFile(), "logs");
if (logDir.isDirectory()) {
return new File(logDir, name + ".log");
}
}
}
return null;
}
// ------------------------------------------------------------------------
// ------------------------------------------------------------------------
public static class EventDataAnalogField
{
private int index = 0;
private double gain = 1.0 / (double)(1L << 10); // default 10-bit analog
private double offset = 0.0;
private DBField dbField = null;
public EventDataAnalogField(int ndx, double gain, double offset) {
this(ndx, gain, offset, null);
}
public EventDataAnalogField(int ndx, double gain, double offset, String fieldN) {
this.index = ndx;
this.gain = gain;
this.offset = offset;
this.setFieldName(fieldN);
Print.logInfo("New AnalogField["+this.index+"]: " + this);
}
public EventDataAnalogField(int ndx, String gof, double dftGain, double dftOffset) {
this.index = ndx;
String v[] = StringTools.split(gof,',');
this.gain = (v.length >= 1)? StringTools.parseDouble(v[0],dftGain ) : dftGain;
this.offset = (v.length >= 2)? StringTools.parseDouble(v[1],dftOffset) : dftOffset;
this.setFieldName((v.length >= 3)? StringTools.blankDefault(v[2],null) : null);
Print.logInfo("New AnalogField["+this.index+"]: " + this);
}
public int getIndex() {
return this.index;
}
public void setGain(double gain) {
this.gain = gain;
}
public double getGain() {
return this.gain;
}
public void setOffset(double offset) {
this.offset = offset;
}
public double getOffset() {
return this.offset;
}
public double convert(long value) {
return this.convert((double)value);
}
public double convert(double value) {
return (value * this.gain) + this.offset;
}
public void setFieldName(String fieldN) {
this.dbField = null;
if (!StringTools.isBlank(fieldN)) {
DBField dbf = EventData.getFactory().getField(fieldN);
if (dbf == null) {
Print.logError("**** EventData analog field does not exist: " + fieldN);
} else {
this.dbField = dbf;
Object val = this.getValueObject(0.0);
if (val == null) {
Print.logError("**** EventData field type not supported: " + fieldN);
this.dbField = null;
}
}
}
}
public DBField getDBField() {
return this.dbField;
}
public String getFieldName() {
return (this.dbField != null)? this.dbField.getName() : null;
}
public Object getValueObject(double value) {
// DBField
DBField dbf = this.getDBField();
if (dbf == null) {
return null;
}
// convert to type
Class dbfc = dbf.getTypeClass();
if (dbfc == String.class) {
return String.valueOf(value);
} else
if ((dbfc == Integer.class) || (dbfc == Integer.TYPE)) {
return new Integer((int)value);
} else
if ((dbfc == Long.class) || (dbfc == Long.TYPE )) {
return new Long((long)value);
} else
if ((dbfc == Float.class) || (dbfc == Float.TYPE )) {
return new Float((float)value);
} else
if ((dbfc == Double.class) || (dbfc == Double.TYPE )) {
return new Double(value);
} else
if ((dbfc == Boolean.class) || (dbfc == Boolean.TYPE)) {
return new Boolean(value != 0.0);
}
return null;
}
public boolean saveEventDataFieldValue(EventData evdb, double value) {
if (evdb != null) {
Object objVal = this.getValueObject(value); // null if no dbField
if (objVal != null) {
String fn = this.getFieldName();
boolean ok = evdb.setFieldValue(fn, objVal);
Print.logInfo("Set AnalogField["+this.getIndex()+"]: "+fn+" ==> " + (ok?evdb.getFieldValue(fn):"n/a"));
return ok;
}
}
return false;
}
public String toString() {
StringBuffer sb = new StringBuffer();
sb.append("index=" ).append(this.getIndex());
sb.append(" gain=" ).append(this.getGain());
sb.append(" offset=").append(this.getOffset());
sb.append(" field=" ).append(this.getFieldName());
return sb.toString();
}
}
// ------------------------------------------------------------------------
// ------------------------------------------------------------------------
private static String DecodeEscapeChars(String s)
{
if (s == null) {
return "";
} else {
s = StringTools.replace(s,"\\n","\n");
s = StringTools.replace(s,"\\r","\r");
return s;
}
}
// ------------------------------------------------------------------------
// ------------------------------------------------------------------------
public static final String COMMAND_CONFIG = "config"; // arg=deviceCommandString
public static final String COMMAND_PING = "ping"; // arg=commandID
//public static final String COMMAND_OUTPUT = "output"; // arg=gpioOutputState
public static final String COMMAND_GEOZONE = "geozone"; // arg=""
public static final String COMMAND_GFMI = "gfmi"; // arg=deviceCommandString
public static final String COMMAND_DIAGNOSTIC = "diagnostic"; // arg=diagCommandString
public static final String COMMAND_INTERNAL = "internal"; // arg=""
public static final String DIAG_LOG[] = { "log", "active", "sessions" };
public static final String DEFAULT_ARG_NAME = "arg";
public static final String KEYARG_HEX8[] = { "h8" , "hex8" }; // return arg as 8-bit hex value
public static final String KEYARG_HEX16[] = { "h16" , "hex16" }; // return arg as 16-bit hex value
public static final String KEYARG_HEX32[] = { "h32" , "hex32" }; // return arg as 32-bit hex value
public static final String KEYARG_HEX64[] = { "h64" , "hex64" }; // return arg as 64-bit hex value
public static final String KEYARG_INT[] = { "#" , "int" , "long" }; // arg is an integer
public static final String KEYARG_QUOTE[] = { "q" , "quote" }; // quote arg
public static final String KEYARG_GPS[] = { "gp" , "gps" }; // format arg as lat/lon
public static final String KEYARG_GPLAT[] = { "gplat", "lat" , "latitude" }; // extract latitude from arg
public static final String KEYARG_GPLON[] = { "gplon", "lon" , "longitude" }; // extract longitude from arg
public static final String KEYARG_NOSPACE[] = { "ns" , "nospace" }; // remove spaces from arg
public static final String JSONKey_DCS = "DCS";
public static final String JSONKey_Commands = "Commands";
public static final String JSONKey_Name = "Name";
public static final String JSONKey_Description = "Description";
public static final String JSONKey_ReadOnly = "ReadOnly";
public static final String JSONKey_ResourceName = "ResourceName";
public static final String JSONKey_DefaultValue = "DefaultValue";
public static final String JSONKey_DisplayLength = "DisplayLength";
public static final String JSONKey_MaximumLength = "MaximumLength";
public static final String JSONKey_Enabled = "Enabled";
public static final String JSONKey_Types = "Types";
public static final String JSONKey_AclName = "AclName";
public static final String JSONKey_AclDefault = "AclDefault";
public static final String JSONKey_Protocol = "Protocol";
public static final String JSONKey_CommandString = "CommandString";
public static final String JSONKey_MaximumRouteAge = "MaximumRouteAge";
public static final String JSONKey_AllowQueue = "AllowQueue";
public static final String JSONKey_ExpectAck = "ExpectAck";
public static final String JSONKey_ExpectAckCode = "ExpectAckCode";
public static final String JSONKey_StateBitMask = "StateBitMask";
public static final String JSONKey_StateBitValue = "StateBitValue";
public static final String JSONKey_AuditCode = "AuditCode";
public static final String JSONKey_Args = "Args";
public static final char GP_SEP[] = { '/', ',', ' ' };
public static final char CSV_SEP[] = { ',' };
public static class Command
{
private String dcsName = "";
private String cmdName = "";
private String cmdDesc = "";
private boolean isEnabled = true;
private String types[] = null;
private String aclName = "";
private AclEntry.AccessLevel aclDft = AclEntry.AccessLevel.WRITE;
private String cmdStr = "";
private boolean hasArgs = false;
private String cmdProto = "";
private String protoHandlr = null;
private long maxRouteAgeSec = -1L;
private boolean allowQueue = false;
private boolean expectAck = false;
private int expAckCode = StatusCodes.STATUS_NONE;
private long stateMask = 0x0000L;
private boolean stateVal = false;
private int cmdStCode = StatusCodes.STATUS_NONE; // auditCode
private OrderedMap argMap = null;
public Command(String dcsName, JSON._Object obj) throws JSON.JSONParsingException {
// This is used for populating Command configuration from the specific DCS
if (obj == null) {
throw new JSON.JSONParsingException("JSON Object is null", null);
}
this.dcsName = StringTools.trim(dcsName);
this.cmdName = obj.getStringForName( JSONKey_Name , "");
this.cmdDesc = obj.getStringForName( JSONKey_Description, "");
this.isEnabled = obj.getBooleanForName( JSONKey_Enabled , true);
this.types = obj.getStringArrayForName(JSONKey_Types , null);
this.aclName = obj.getStringForName( JSONKey_AclName , "");
this.aclDft = AclEntry.parseAccessLevel(obj.getStringForName(JSONKey_AclDefault,null),AclEntry.AccessLevel.WRITE);
String cmdProtoH = obj.getStringForName( JSONKey_Protocol , "");
if (cmdProtoH.indexOf(":") >= 0) {
int p = cmdProtoH.indexOf(":");
this.cmdProto = StringTools.trim(cmdProtoH.substring(0,p));
this.protoHandlr = StringTools.trim(cmdProtoH.substring(p+1));
} else {
this.cmdProto = cmdProtoH;
this.protoHandlr = null;
}
this.cmdStr = DecodeEscapeChars(obj.getStringForName(JSONKey_CommandString,""));
this.maxRouteAgeSec = obj.getLongForName( JSONKey_MaximumRouteAge, 0L);
this.allowQueue = obj.getBooleanForName(JSONKey_AllowQueue , false);
this.expectAck = obj.getBooleanForName(JSONKey_ExpectAck , false);
this.expAckCode = obj.getIntForName( JSONKey_ExpectAckCode , StatusCodes.STATUS_NONE);
this.stateMask = obj.getLongForName( JSONKey_StateBitMask , 0L);
this.stateVal = obj.getBooleanForName(JSONKey_StateBitValue , true);
this.cmdStCode = obj.getIntForName( JSONKey_AuditCode , StatusCodes.STATUS_NONE);
JSON._Array args = obj.getArrayForName( JSONKey_Args , null);
if (!ListTools.isEmpty(args)) {
this.hasArgs = true;
this.argMap = new OrderedMap();
for (int i = 0; i < args.size(); i++) {
JSON._Object arg = args.getObjectValueAt(i,null);
if (arg != null) {
CommandArg cmdArg = new CommandArg(arg);
cmdArg.setCommand(this);
this.argMap.put(cmdArg.getName(),cmdArg);
} else {
throw new JSON.JSONParsingException("Command '"+this.cmdName+"': Invalid Arg at #" + i, null);
}
}
} else {
this.hasArgs = (this.cmdStr.indexOf("${") >= 0)? true : false;
}
// TODO
}
public Command(
String dcsName ,
String cmdName , String desc, boolean enable,
String types[] , String aclName, AclEntry.AccessLevel aclDft,
String cmdStr , boolean hasArgs, Collection cmdArgs,
String cmdProtoH, long maxRteAge, boolean allowQueue,
boolean expectAck, int expAckCode,
long stateMask, boolean stateVal,
int cmdStCode) {
this.dcsName = StringTools.trim(dcsName);
this.cmdName = StringTools.trim(cmdName);
this.cmdDesc = StringTools.trim(desc);
this.isEnabled = enable; // cmdEnable
this.types = (types != null)? types : new String[0];
this.aclName = StringTools.trim(aclName);
this.aclDft = (aclDft != null)? aclDft : AclEntry.AccessLevel.WRITE;
//this.cmdStr = (cmdStr != null)? cmdStr : ""; // DecodeEscapeChars
this.cmdStr = DecodeEscapeChars(cmdStr);
//if (!this.cmdStr.equals(cmdStr)) {Print.logInfo("\""+cmdStr+"\" ==> \""+this.cmdStr+"\"");}
this.hasArgs = hasArgs || (this.cmdStr.indexOf("${") >= 0);
cmdProtoH = StringTools.trim(cmdProtoH);
if (cmdProtoH.indexOf(":") >= 0) {
int p = cmdProtoH.indexOf(":");
this.cmdProto = StringTools.trim(cmdProtoH.substring(0,p));
this.protoHandlr = StringTools.trim(cmdProtoH.substring(p+1));
} else {
this.cmdProto = cmdProtoH;
this.protoHandlr = null;
}
this.maxRouteAgeSec = maxRteAge;
this.allowQueue = allowQueue;
this.expectAck = expectAck;
this.expAckCode = (expAckCode > 0)? expAckCode : StatusCodes.STATUS_NONE;
this.stateMask = stateMask;
this.stateVal = stateVal;
this.cmdStCode = (cmdStCode > 0)? cmdStCode : StatusCodes.STATUS_NONE;
if (!ListTools.isEmpty(cmdArgs) && this.hasArgs) {
this.argMap = new OrderedMap();
for (CommandArg arg : cmdArgs) {
arg.setCommand(this);
this.argMap.put(arg.getName(),arg);
}
}
/*
if (this.cmdName.equals("GFMITextMessage")) {
Print.logInfo("Name : " + this.cmdName);
Print.logInfo("CmdStr : " + this.cmdStr);
Print.logInfo("HasArgs: " + this.hasArgs);
Print.logInfo("Args[] : " + StringTools.join(cmdArgs,","));
}
*/
}
public String getServerName() {
return this.dcsName;
}
public String getName() {
return this.cmdName; // not null
}
public String getDescription() {
return this.cmdDesc; // not null
}
public boolean isEnabled(BasicPrivateLabel privLabel) {
String dcsn = this.getServerName();
if ((privLabel != null) && !StringTools.isBlank(dcsn)) {
String rtKey = // DCServer.DCSNAME.Command.CMDNAME.enabled
DCServerFactory.PROP_DCServer_ + dcsn + "." + DCServerFactory.PROP_Command_ +
this.getName() + "." + DCServerFactory.ATTR_enabled;
if (privLabel.hasProperty(rtKey)) {
// IE:
// DCServer.calamp.Command.StarterDisableSMS.enabled=true
// DCServer.calamp.Command.StarterEnableSMS.enabled=true
boolean cmdEna = privLabel.getBooleanProperty(rtKey, true);
//Print.logInfo("Found key ["+privLabel.getName()+"]: " + rtKey + " ==> " + cmdEna);
return cmdEna;
} else {
//Print.logInfo("Key not found ["+privLabel.getName()+"]: " + rtKey);
}
}
return this.isEnabled;
}
public String[] getTypes() {
return this.types;
}
public boolean isType(String type) {
if (DCServerFactory.isCommandTypeAll(type)) {
return true;
} else
if (ListTools.isEmpty(this.types)) {
return true;
} else {
return ListTools.contains(this.types, type);
}
}
public String getAclName() {
return this.aclName; // not null
}
public AclEntry.AccessLevel getAclAccessLevelDefault() {
return this.aclDft; // not null
}
public String getCommandString() {
return this.cmdStr; // not null (may contain replacement variables)
}
//public String getCommandString(String cmdArgs[]) {
// return this.getCommandString(null, cmdArgs);
//}
private String _adjustKeyArg(String V, String keyArg) {
if (!StringTools.isBlank(keyArg)) {
String ka = keyArg.trim().toLowerCase();
if (ListTools.contains(KEYARG_HEX8,ka)) {
// convert numeric value to hex (1 byte)
// 16 ==> 0x10
long v = StringTools.parseLong(V,0L) & 0xFFL;
return "0x" + StringTools.toHexString(v,8);
} else
if (ListTools.contains(KEYARG_HEX16,ka)) {
// convert numeric value to hex (2 bytes)
// 16 ==> 0x0010
long v = StringTools.parseLong(V,0L) & 0xFFFFL;
return "0x" + StringTools.toHexString(v,16);
} else
if (ListTools.contains(KEYARG_HEX32,ka)) {
// convert numeric value to hex (4 bytes)
// 16 ==> 0x00000010
long v = StringTools.parseLong(V,0L) & 0xFFFFFFFFL;
return "0x" + StringTools.toHexString(v,32);
} else
if (ListTools.contains(KEYARG_HEX64,ka)) {
// convert numeric value to hex (4 bytes)
// 16 ==> 0x0000000000000010
long v = StringTools.parseLong(V,0L); // already 64 bit
return "0x" + StringTools.toHexString(v,64);
} else
if (ListTools.contains(KEYARG_INT,ka)) {
// extract the leading digits
// 123ABC ==> 123
return String.valueOf(StringTools.parseLong(V,0L));
} else
if (ListTools.contains(KEYARG_NOSPACE,ka)) {
// remove embedded spaces from arg [gps=${gps:ns}]
// Hello World ==> HelloWorld
return StringTools.stripChars(V," \t\r\n");
} else
if (ListTools.contains(KEYARG_QUOTE,ka)) {
// quote argument [message=${text:quote}]
// Hello "World" ==> "Hello \"World\""
return StringTools.quoteString(V);
} else
if (ListTools.contains(KEYARG_GPS,ka)) {
// format arg as GPS [point=${point:gps}]
// 39.1234, -142.1234 ==> 39.1234/-142.1234
GeoPoint gp = new GeoPoint(V, GP_SEP);
return gp.toString();
} else
if (ListTools.contains(KEYARG_GPLAT,ka)) {
// extract latitude from "latitude/longitude" [latitude=${point:lat}]
GeoPoint gp = new GeoPoint(V, GP_SEP);
return gp.getLatitudeString();
} else
if (ListTools.contains(KEYARG_GPLON,ka)) {
// extract longitude from "latitude/longitude" [longitude=${point:lon}]
GeoPoint gp = new GeoPoint(V, GP_SEP);
return gp.getLongitudeString();
} else
if (StringTools.isNumeric(ka)) {
// extract indexed value from "A,B,C,D" [value=${arg0:1}]
int p = StringTools.indexOf(V, CSV_SEP); // find first separator
int n = StringTools.parseInt(ka, -1);
if (n < 0) {
// argument index is invalid
return V; // leave as-is
} else
if (p < 0) {
// "V" contains only one value (no separators found)
return (n == 0)? V : ""; // return as first element only
} else {
// return indexed element
String f[] = StringTools.split(V, V.charAt(p)); // split on first separator
return (n < f.length)? f[n] : "";
}
}
}
return V; // leave as-is
}
public String getCommandString(Device device, String cmdArgs[]) {
String cs = this.getCommandString();
// insert command arguments
if (this.hasCommandArgs()) {
// insert replacement variables
final String args[] = (cmdArgs != null)? cmdArgs : new String[0];
String rcs = StringTools.replaceKeys(cs, new StringTools.KeyValueMap() {
public String getKeyValue(String key, String keyArg, String dft) {
int argNdx = (Command.this.argMap != null)? Command.this.argMap.indexOfKey(key) : -1;
if ((argNdx >= 0) && (argNdx < args.length)) {
// ${text[:{ns|int|quote|gps|gplat|gplon}][=DFT]}
String V = !StringTools.isBlank(args[argNdx])? args[argNdx] : dft;
return Command.this._adjustKeyArg(V,keyArg);
} else
if (key.equals(DEFAULT_ARG_NAME)) {
// ${arg[:{ns|int|quote|gps|gplat|gplon}][=DFT]}
String V = ((args.length > 0) && !StringTools.isBlank(args[0]))? args[0] : dft;
return Command.this._adjustKeyArg(V,keyArg);
} else {
// ${argX[:{ns|int|quote|gps|gplat|gplon}][=DFT]}
for (int i = 0; i < args.length; i++) {
if (key.equals(DEFAULT_ARG_NAME+i)) { // "arg0", "arg1", ...
String V = !StringTools.isBlank(args[i])? args[i] : dft;
return Command.this._adjustKeyArg(V,keyArg);
}
}
return Command.this._adjustKeyArg(dft,keyArg);
}
}
});
cs = rcs;
}
// insert fixed arguments into command string
if (device != null) {
String dataKey = device.getDataKey(); // %{dataKey} , {DATAKEY}
String uniqueID = device.getUniqueID(); // %{uniqueID}, {UNIQUEID}
String modemID = device.getModemID(); // %{modemID} , {MODEMID}
String imeiNum = device.getImeiNumber(); // %{imei} , {IMEI}
String serial = device.getSerialNumber(); // %{serial} , {SERIAL}
cs = SMSOutboundGateway.REPLACE(cs, SMSOutboundGateway.REPL_dataKey , dataKey );
cs = SMSOutboundGateway.REPLACE(cs, SMSOutboundGateway.REPL_uniqueID, uniqueID);
cs = SMSOutboundGateway.REPLACE(cs, SMSOutboundGateway.REPL_modemID , modemID );
cs = SMSOutboundGateway.REPLACE(cs, SMSOutboundGateway.REPL_imei , imeiNum );
cs = SMSOutboundGateway.REPLACE(cs, SMSOutboundGateway.REPL_serial , serial );
}
// return command string
return cs;
}
public boolean hasCommandArgs() {
//return (this.cmdStr != null)? (this.cmdStr.indexOf("${arg") >= 0) : false;
return this.hasArgs;
}
public int getArgCount() {
if (!this.hasArgs) {
return 0;
} else
if (this.argMap != null) {
return this.argMap.size();
} else {
return 1;
}
}
public CommandArg getCommandArg(int argNdx) {
if (this.hasArgs && (this.argMap != null)) {
return this.argMap.getValue(argNdx);
} else {
return null;
}
}
public CommandProtocol getCommandProtocol() {
return this.getCommandProtocol(null);
}
public CommandProtocol getCommandProtocol(CommandProtocol dftProto) {
if (!StringTools.isBlank(this.cmdProto)) {
// may return null if cmdProto is not one of the valid values
return DCServerConfig.getCommandProtocol(this.cmdProto);
} else {
return dftProto;
}
}
public boolean isCommandProtocolSMS() {
CommandProtocol proto = this.getCommandProtocol(null);
return ((proto != null) && proto.isSMS());
}
public String getCommandProtocolHandler() {
return this.protoHandlr; // may be null
}
public boolean hasMaximumRouteAge() {
return (this.maxRouteAgeSec > 0L)? true : false;
}
public long getMaximumRouteAge() {
return this.maxRouteAgeSec;
}
public boolean queueIfUndelivered() {
return this.allowQueue;
}
public boolean getExpectAck() {
return this.expectAck;
}
public int getExpectAckCode() {
return this.expAckCode;
}
public boolean hasStateBitMask() {
return (this.stateMask != 0x0000L)? true : false;
}
public long getStateBitMask() {
return this.stateMask;
}
public boolean getStateBitValue() {
return this.stateVal;
}
public boolean hasAuditStatusCode() {
return (this.cmdStCode != StatusCodes.STATUS_NONE)? true : false;
}
public int getAuditStatusCode() {
return this.cmdStCode;
}
public boolean setDeviceCommandAttributes(
DCServerFactory.ResultCode result,
Device device, String cmdStr, boolean update) {
if (DCServerFactory.isCommandResultOK(result) && (device != null)) {
return device.postCommandHandling(this, cmdStr, update);
} else {
return false;
}
}
public JSON._Object toJsonObject() {
JSON._Object obj = new JSON._Object();
obj.addKeyValue(JSONKey_Name , this.getName());
obj.addKeyValue(JSONKey_Description, this.getDescription());
obj.addKeyValue(JSONKey_Enabled , this.isEnabled(null));
obj.addKeyValue(JSONKey_Types , new JSON._Array(this.getTypes()).setFormatIndent(false));
obj.addKeyValue(JSONKey_AclName , this.getAclName());
obj.addKeyValue(JSONKey_AclDefault , this.getAclAccessLevelDefault().getIntValue());
if (this.hasMaximumRouteAge()) {
obj.addKeyValue(JSONKey_MaximumRouteAge, this.getMaximumRouteAge());
} else {
// defaults to "MaximumRouteAge=0"
}
obj.addKeyValue(JSONKey_AllowQueue, this.queueIfUndelivered());
if (this.getExpectAck()) {
obj.addKeyValue(JSONKey_ExpectAck , this.getExpectAck());
obj.addKeyValue(JSONKey_ExpectAckCode, this.getExpectAckCode());
} else {
// default: ExpectAck=false
}
if (this.hasStateBitMask()) {
obj.addKeyValue(JSONKey_StateBitMask , this.getStateBitMask());
obj.addKeyValue(JSONKey_StateBitValue, this.getStateBitValue());
} else {
// default: StateBitMask=0
}
if (this.hasAuditStatusCode()) {
obj.addKeyValue(JSONKey_AuditCode, this.getAuditStatusCode());
}
obj.addKeyValue(JSONKey_Protocol , StringTools.trim(this.getCommandProtocol()));
obj.addKeyValue(JSONKey_CommandString, this.getCommandString());
if (this.hasCommandArgs() && !ListTools.isEmpty(this.argMap)) {
JSON._Array jsonArgArray = new JSON._Array();
for (int i = 0; i < this.getArgCount(); i++) {
CommandArg cmdArg = this.getCommandArg(i);
if (cmdArg != null) {
jsonArgArray.addValue(cmdArg.toJsonObject());
} else
if ((this.argMap != null) && (i < this.argMap.size())) {
//Print.logWarn("Command '"+this.getName()+"' Arg #" + i + " is null");
JSON._Object argObj = new JSON._Object();
argObj.addKeyValue(JSONKey_Name, "arg" + i);
jsonArgArray.addValue(argObj);
}
}
obj.addKeyValue(JSONKey_Args, jsonArgArray);
}
return obj;
}
}
private static final int ARG_DISPLAY_LENGTH = 70;
private static final int ARG_MAXIMUM_LENGTH = 500;
public static class CommandArg
{ // static because the 'Args' are initialized before the 'Command' is
private Command command = null; // The command that owns this arg
private String argName = ""; // This argument name
private String argDesc = ""; // This argument description
private boolean readOnly = false;
private String resKey = null;
private String dftVal = "";
private int lenDisp = ARG_DISPLAY_LENGTH;
private int lenMax = ARG_MAXIMUM_LENGTH;
public CommandArg(JSON._Object arg) {
this.argName = arg.getStringForName( JSONKey_Name , "");
this.argDesc = arg.getStringForName( JSONKey_Description , "");
this.readOnly = arg.getBooleanForName(JSONKey_ReadOnly , false);
this.resKey = arg.getStringForName( JSONKey_ResourceName , null);
this.dftVal = arg.getStringForName( JSONKey_DefaultValue , "");
this.lenDisp = arg.getIntForName( JSONKey_DisplayLength, ARG_DISPLAY_LENGTH);
this.lenMax = arg.getIntForName( JSONKey_MaximumLength, ARG_MAXIMUM_LENGTH);
}
public CommandArg(String name, String desc, boolean readOnly, String resKey, String dftVal) {
this.argName = StringTools.trim(name);
this.argDesc = StringTools.trim(desc);
this.readOnly = readOnly;
this.resKey = !StringTools.isBlank(resKey)? resKey : null;
this.dftVal = StringTools.trim(dftVal);
this.lenDisp = ARG_DISPLAY_LENGTH;
this.lenMax = ARG_MAXIMUM_LENGTH;
}
public String getName() {
return this.argName;
}
public String getDescription() {
return this.argDesc;
}
public boolean isReadOnly() {
return this.readOnly;
}
public void setCommand(Command cmd) {
this.command = cmd;
}
public Command getCommand() {
return this.command;
}
public String getResourceName() {
return this.resKey;
// ie. "DCServerConfig.enfora.DriverMessage.arg"
/*
StringBuffer sb = new StringBuffer();
sb.append("DCServerConfig.");
sb.append(cmd.getDCServerConfig().getName());
sb.append(".");
sb.append(cmd.getName());
sb.append(".");
sb.append(this.getName());
return sb.toString();
*/
}
public String getDefaultValue() {
return this.dftVal;
}
public void setLength(int dispLen, int maxLen) {
this.lenDisp = (dispLen > 0)? dispLen : 70;
this.lenMax = (maxLen > 0)? maxLen : (this.lenDisp * 2);
}
public int getDisplayLength() {
return this.lenDisp;
}
public int getMaximumLength() {
return this.lenMax;
}
public String toString() {
StringBuffer sb = new StringBuffer();
sb.append(this.getName()).append("/").append(StringTools.quoteString(this.getDescription()));
return sb.toString();
}
public JSON._Object toJsonObject() {
JSON._Object obj = new JSON._Object();
obj.addKeyValue(JSONKey_Name , this.getName());
obj.addKeyValue(JSONKey_Description , this.getDescription());
obj.addKeyValue(JSONKey_ReadOnly , this.isReadOnly());
obj.addKeyValue(JSONKey_ResourceName , this.getResourceName());
obj.addKeyValue(JSONKey_DefaultValue , this.getDefaultValue());
obj.addKeyValue(JSONKey_DisplayLength, this.getDisplayLength());
obj.addKeyValue(JSONKey_MaximumLength, this.getMaximumLength());
return obj;
}
}
// ------------------------------------------------------------------------
// ------------------------------------------------------------------------
/**
*** FuelLevelProfile class
**/
public static class FuelLevelProfile
{
// 0,0|1,1
private double evtLevel = 0.0;
private double actLevel = 0.0;
public FuelLevelProfile(String lvl) {
if (!StringTools.isBlank(lvl)) {
String L[] = StringTools.split(lvl,',');
if (ListTools.size(L) >= 2) {
this.evtLevel = StringTools.parseDouble(L[0],-1.0);
this.actLevel = StringTools.parseDouble(L[1],-1.0);
if ((this.evtLevel < 0.0) || (this.evtLevel > 1.0) ||
(this.actLevel < 0.0) || (this.actLevel > 1.0) ) {
Print.logError("Invalid FuelLevelProfile value: " + lvl);
this.evtLevel = 0.0;
this.actLevel = 0.0;
}
}
}
}
public FuelLevelProfile(double evLvl, double acLvl) {
this.evtLevel = evLvl;
this.actLevel = acLvl;
}
public double getEventLevel() {
return this.evtLevel;
}
public double getActualLevel() {
return this.actLevel;
}
}
/**
*** Parse the FuelLevelProfile String
*** @param profile The string containing the fuel-level profile
*** @return An array of FuelLevelProfile entries
**/
public static FuelLevelProfile[] ParseFuelLevelProfile(String profile)
{
// "0.00,0.00|0.25,0.50|1.00,1.00"
String p[] = StringTools.split(profile,'|');
FuelLevelProfile flp[] = new FuelLevelProfile[p.length];
for (int i = 0; i < p.length; i++) {
flp[i] = new FuelLevelProfile(p[i]);
}
return flp;
}
/**
*** Adjust a non-linear event specified fuel-level to a linear value based on the specified profile.
*** @param fuelLevel The event fuel-level to adjust
*** @param flp The FuelLevelProfile array used to adjust the fuel-level
*** @return The adjusted fuel-level
**/
public static double adjustFuelLevelProfile(double fuelLevel, FuelLevelProfile flp[])
{
// not currently used
double FL = fuelLevel;
if (!ListTools.isEmpty(flp)) {
FuelLevelProfile hi = null;
FuelLevelProfile lo = null;
for (int i = 0; i < flp.length; i++) {
if (flp[i].getEventLevel() == FL) {
hi = flp[i];
lo = flp[i];
break;
} else
if (flp[i].getEventLevel() >= FL) {
hi = flp[i];
lo = (i > 0)? flp[i - 1] : null;
break;
}
}
if ((hi != null) && (lo != null)) {
double evHi = hi.getEventLevel();
double evLo = lo.getEventLevel();
double evD = (FL - evLo) / (evHi - evLo);
double acHi = hi.getActualLevel();
double acLo = lo.getActualLevel();
FL = acLo + (evD * (acHi - acLo));
}
}
return FL;
}
// ------------------------------------------------------------------------
// ------------------------------------------------------------------------
// ------------------------------------------------------------------------
private String dcName = "";
private String dcDesc = "";
private String remoteLoggingAttr = null;
private String uniquePrefix[] = null;
private boolean useSSL = false;
private OrderedMap tcpPortMap = null;
private OrderedMap udpPortMap = null;
private OrderedMap satPortMap = null;
private int startStopCodes[] = null;
private boolean startStopCodes_init = false;
private boolean customCodeEnabled = true;
private Map customCodeMap = new HashMap();
private String commandHost = null;
private int commandPort = 0;
private CommandProtocol commandProtocol = null;
private long attrFlags = F_NONE;
private Map rtPropsMap = new OrderedMap();
private String commandsAclName = null;
private AclEntry.AccessLevel commandsAccessLevelDft = null;
private OrderedMap commandMap = null;
/**
*** Blank Constructor
**/
public DCServerConfig()
{
this.getDefaultProperties();
this.setName("unregistered");
this.setDescription("Unregistered DCS");
this.setAttributeFlags(F_NONE);
this.setUseSSL(false);
this.setTcpPorts(null, null, false);
this.setUdpPorts(null, null, false);
this.setSatPorts(null, null, false);
this.setCommandDispatcherPort(0);
this.setUniquePrefix(null);
this._postInit();
}
/**
*** Constructor
**/
public DCServerConfig(String name, String desc, int tcpPorts[], int udpPorts[], int commandPort, long flags, String... uniqPfx)
{
this.getDefaultProperties();
this.setName(name);
this.setDescription(desc);
this.setAttributeFlags(flags);
this.setUseSSL(false);
this.setTcpPorts(null, tcpPorts, true);
this.setUdpPorts(null, udpPorts, true);
this.setSatPorts(null, null , true); // TODO:
this.setCommandDispatcherPort(commandPort, true);
this.setUniquePrefix(uniqPfx);
this._postInit();
}
private void _postInit()
{
// etc.
}
// ------------------------------------------------------------------------
/**
*** Sets the server name/id
**/
protected void setName(String n)
{
this.dcName = StringTools.trim(n);
}
/**
*** Gets the server name/id
**/
public String getName()
{
return this.dcName;
}
// ------------------------------------------------------------------------
/**
*** Sets the server description
**/
public void setDescription(String d)
{
this.dcDesc = StringTools.trim(d);
}
/**
*** Gets the server description
**/
public String getDescription()
{
return this.dcDesc;
}
// ------------------------------------------------------------------------
/**
*** Sets the remote logging attributes for this DCS
*** @param logAttr The remote log attributes in the form "[[HOST]:]PORT[/BUFFERSIZE]"
**/
public void setRemoteLogging(String logAttr)
{
this.remoteLoggingAttr = logAttr;
}
/**
*** Gets the remote logging attribute string for this DCS
*** @return The remote logging attribute string for this DCS
**/
public String getRemoteLogging()
{
return this.remoteLoggingAttr;
}
/**
*** Starts the RemoteLogServer if remote logging is enabled
*** @return True if started, false otherwise
**/
public boolean startRemoteLogging()
{
String logAttr = this.getRemoteLogging();
if (!StringTools.isBlank(logAttr)) {
boolean ok = Print.setRemoteLogging(logAttr);
if (ok) {
//Print.sysPrintln("Enabled cached remote logging on port " + port);
return true;
} else {
//Print.sysPrintln("Unable to Enabled cached remote logging");
return false;
}
} else {
//Print.sysPrintln("Remote logging not enabled");
return false;
}
}
/**
*** Starts the RemoteLogServer if remote logging is enabled
*** @param dcsc The DCServerConfig instance
*** @return True if started, false otherwise
**/
public static boolean startRemoteLogging(DCServerConfig dcsc)
{
if (dcsc != null) {
return dcsc.startRemoteLogging();
} else {
//Print.sysPrintln("Remote logging not enabled");
return false;
}
}
// ------------------------------------------------------------------------
/**
*** Sets the server attribute flags
**/
public void setAttributeFlags(long f)
{
this.attrFlags = f;
}
/**
*** Gets the server attribute flags
**/
public long getAttributeFlags()
{
return this.attrFlags;
}
/**
*** Returns true if the indicate mask is non-zero
**/
public boolean isAttributeFlag(long mask)
{
return ((this.getAttributeFlags() & mask) != 0L);
}
// ------------------------------------------------------------------------
/**
*** Gets an array of server ports from the specified runtime keys.
*** (first check command-line, then config file, then default)
*** @param name The server name
*** @param rtPropKey The runtime key names
*** @param dft The default array of server ports if not defined otherwise
*** @return The array of server ports
**/
private int[] _getServerPorts(
String cmdLineKey[],
String rtPropKey[],
int dft[])
{
String portStr[] = null;
/* check command-line override first */
RTProperties cmdLineProps = RTConfig.getCommandLineProperties();
if ((cmdLineProps != null) && cmdLineProps.hasProperty(cmdLineKey)) {
portStr = cmdLineProps.getStringArray(cmdLineKey, null);
}
/* check runtime config override */
if (ListTools.isEmpty(portStr)) {
String ak[] = this.normalizeKeys(rtPropKey); // "tcpPort" ==> "enfora.tcpPort"
if (!this.hasProperty(ak,false)) { // exclude 'defaults'
// no override defined
return dft;
}
portStr = this.getStringArrayProperty(ak, null);
if (ListTools.isEmpty(portStr)) {
// ports explicitly removed
//Print.logInfo(name + ": Returning 'null' ports");
return null;
}
}
/* parse/return port numbers */
int p = 0;
int srvPorts[] = new int[portStr.length];
for (int i = 0; i < portStr.length; i++) {
int port = StringTools.parseInt(portStr[i], 0);
if (ServerSocketThread.isValidPort(port)) {
srvPorts[p++] = port;
}
}
if (p < srvPorts.length) {
// list contains invalid port numbers
int newPorts[] = new int[p];
System.arraycopy(srvPorts, 0, newPorts, 0, p);
srvPorts = newPorts;
}
if (!ListTools.isEmpty(srvPorts)) {
//Print.logInfo(name + ": Returning server ports: " + StringTools.join(srvPorts,","));
return srvPorts;
} else {
//Print.logInfo(name + ": Returning 'null' ports");
return null;
}
}
// ------------------------------------------------------------------------
/**
*** Sets whether to use SSL on TCP connections
**/
public void setUseSSL(boolean useSSL)
{
this.useSSL = useSSL;
}
/**
*** Gets whether to use SSL on TCP connections
**/
public boolean getUseSSL()
{
return this.useSSL;
}
// ------------------------------------------------------------------------
/**
*** Sets the default TCP port for this server
**/
public void setTcpPorts(InetAddress bindAddr, int tcp[], boolean checkRTP)
{
if (checkRTP) {
tcp = this._getServerPorts(
DCServerFactory.ARG_tcpPort,
DCServerFactory.CONFIG_tcpPort(this.getName()),
tcp);
}
if (!ListTools.isEmpty(tcp)) {
if (this.tcpPortMap == null) { this.tcpPortMap = new OrderedMap(); }
for (int i = 0; i < tcp.length; i++) {
Integer p = new Integer(tcp[i]);
if (this.tcpPortMap.containsKey(p)) {
Print.logWarn("TCP port already defined ["+this.getName()+"]: " + p);
}
this.tcpPortMap.put(p, bindAddr);
}
}
}
/**
*** Get TCP Port bind address
**/
public InetAddress getTcpPortBindAddress(int port)
{
InetAddress bind = (this.tcpPortMap != null)? this.tcpPortMap.get(new Integer(port)) : null;
return (bind != null)? bind : ServerSocketThread.getDefaultBindAddress();
}
/**
*** Gets the default TCP port for this server
**/
public int[] getTcpPorts()
{
if (ListTools.isEmpty(this.tcpPortMap)) {
return null;
} else {
int ports[] = new int[this.tcpPortMap.size()];
for (int i = 0; i < ports.length; i++) {
ports[i] = this.tcpPortMap.getKey(i).intValue();
}
return ports;
}
}
/**
*** Create TCP ServerSocketThread
**/
public ServerSocketThread createServerSocketThread_TCP(int port)
throws SocketException, IOException
{
boolean useSSL = this.getUseSSL();
return this.createServerSocketThread_TCP(port, useSSL);
}
/**
*** Create TCP ServerSocketThread
**/
public ServerSocketThread createServerSocketThread_TCP(int port, boolean useSSL)
throws SocketException, IOException
{
InetAddress bindAddr = this.getTcpPortBindAddress(port);
Print.logInfo("Binding TCP listener to " + bindAddr + ":" + port);
ServerSocketThread sst = new ServerSocketThread(bindAddr, port, useSSL);
sst.setName("TCPListener_" + port);
return sst;
}
// ------------------------------------------------------------------------
/**
*** Sets the default UDP port for this server
**/
public void setUdpPorts(InetAddress bindAddr, int udp[], boolean checkRTP)
{
if (checkRTP) {
udp = this._getServerPorts(
DCServerFactory.ARG_udpPort,
DCServerFactory.CONFIG_udpPort(this.getName()),
udp);
}
if (!ListTools.isEmpty(udp)) {
if (this.udpPortMap == null) { this.udpPortMap = new OrderedMap(); }
for (int i = 0; i < udp.length; i++) {
Integer p = new Integer(udp[i]);
if (this.udpPortMap.containsKey(p)) {
Print.logWarn("UDP port already defined ["+this.getName()+"]: " + p);
}
this.udpPortMap.put(p, bindAddr);
//Print.logInfo("Setting UDP listener at " + StringTools.blankDefault(bindAddr,"") + " : " + p);
}
}
}
/**
*** Get UDP Port bind address
**/
public InetAddress getUdpPortBindAddress(int port)
{
InetAddress bind = (this.udpPortMap != null)? this.udpPortMap.get(new Integer(port)) : null;
return (bind != null)? bind : ServerSocketThread.getDefaultBindAddress();
}
/**
*** Gets the default UDP port for this server
**/
public int[] getUdpPorts()
{
if (ListTools.isEmpty(this.udpPortMap)) {
return null;
} else {
int ports[] = new int[this.udpPortMap.size()];
for (int i = 0; i < ports.length; i++) {
ports[i] = this.udpPortMap.getKey(i).intValue();
}
return ports;
}
}
/**
*** Create UDP ServerSocketThread
**/
public ServerSocketThread createServerSocketThread_UDP(int port)
throws SocketException, IOException
{
if (port > 0) {
InetAddress bindAddr = this.getUdpPortBindAddress(port);
DatagramSocket dgs = ServerSocketThread.createDatagramSocket(bindAddr, port);
Print.logInfo("Binding UDP listener to "+dgs.getLocalAddress()+":"+dgs.getLocalPort()+" [bound="+dgs.isBound()+"]");
ServerSocketThread sst = new ServerSocketThread(dgs);
sst.setName("UDPListener_" + port);
return sst;
} else {
Print.logInfo("Created unbound UDP listener");
ServerSocketThread sst = new ServerSocketThread((DatagramSocket)null);
sst.setName("UDPListener_unbound");
return sst;
}
}
// ------------------------------------------------------------------------
/**
*** Sets the default SAT port for this server
**/
public void setSatPorts(InetAddress bindAddr, int sat[], boolean checkRTP)
{
if (checkRTP) {
sat = this._getServerPorts(
DCServerFactory.ARG_satPort,
DCServerFactory.CONFIG_satPort(this.getName()),
sat);
}
if (!ListTools.isEmpty(sat)) {
if (this.satPortMap == null) { this.satPortMap = new OrderedMap(); }
for (int i = 0; i < sat.length; i++) {
Integer p = new Integer(sat[i]);
if (this.satPortMap.containsKey(p)) {
Print.logWarn("SAT port already defined ["+this.getName()+"]: " + p);
}
this.satPortMap.put(p, bindAddr);
}
}
}
/**
*** Get SAT Port bind address
**/
public InetAddress getSatPortBindAddress(int port)
{
InetAddress bind = (this.satPortMap != null)? this.satPortMap.get(new Integer(port)) : null;
return (bind != null)? bind : ServerSocketThread.getDefaultBindAddress();
}
/**
*** Gets the default SAT port for this server
**/
public int[] getSatPorts()
{
if (ListTools.isEmpty(this.satPortMap)) {
return null;
} else {
int ports[] = new int[this.satPortMap.size()];
for (int i = 0; i < ports.length; i++) {
ports[i] = this.satPortMap.getKey(i).intValue();
}
return ports;
}
}
/**
*** Create SAT ServerSocketThread
**/
public ServerSocketThread createServerSocketThread_SAT(int port)
throws SocketException, IOException
{
boolean useSSL = this.getUseSSL();
return this.createServerSocketThread_SAT(port, useSSL);
}
/**
*** Create SAT ServerSocketThread
**/
public ServerSocketThread createServerSocketThread_SAT(int port, boolean useSSL)
throws SocketException, IOException
{
InetAddress bindAddr = this.getSatPortBindAddress(port);
Print.logInfo("Binding SAT listener to " + bindAddr + ":" + port);
ServerSocketThread sst = new ServerSocketThread(bindAddr, port, useSSL);
sst.setName("SATListener_" + port);
return sst;
}
// ------------------------------------------------------------------------
// ------------------------------------------------------------------------
public static final int STARTSTOP_STARTSTOP[] = { StatusCodes.STATUS_MOTION_START, StatusCodes.STATUS_MOTION_STOP };
public static final int STARTSTOP_IGNITION[] = { StatusCodes.STATUS_IGNITION_ON , StatusCodes.STATUS_IGNITION_OFF };
public static final int STARTSTOP_ENGINE[] = { StatusCodes.STATUS_ENGINE_START, StatusCodes.STATUS_ENGINE_STOP };
public static final int STARTSTOP_PARK[] = { StatusCodes.STATUS_UNPARKED , StatusCodes.STATUS_PARKED };
/**
*** Sets the start and stop status codes.
*** @param ssKey The start status code key ("ignition", "parked", "startStop")
**/
public void setStartStopStatusCodes(String ssKey)
{
// default
// ignition
// engine
// parked
// startstop
String ssk = StringTools.trim(ssKey).toLowerCase();
if (StringTools.isBlank(ssk)) {
this.startStopCodes = null;
return;
} else
if (ssk.equals("default")) {
if (this.getStartStopSupported(false)) {
this.startStopCodes = STARTSTOP_STARTSTOP;
} else {
this.startStopCodes = null;
}
return;
} else
if (ssk.equals("ign") || ssk.equals("ignition")) {
this.startStopCodes = STARTSTOP_IGNITION;
return;
} else
if (ssk.equals("eng") || ssk.equals("engine")) {
this.startStopCodes = STARTSTOP_ENGINE;
return;
} else
if (ssk.equals("park") || ssk.equals("parked")) {
this.startStopCodes = STARTSTOP_PARK;
return;
} else
if (ssk.equals("ss") || ssk.equals("startstop")) {
this.startStopCodes = STARTSTOP_STARTSTOP;
return;
} else
if (ssk.indexOf(',') > 0) {
String sc[] = StringTools.split(ssk,',');
if (ListTools.size(sc) >= 2) {
int startSC = StringTools.parseInt(sc[0],0);
int stopSC = StringTools.parseInt(sc[1],0);
if ((startSC > 0) && (stopSC > 0)) {
this.startStopCodes = new int[] { startSC, stopSC };
return;
}
}
}
Print.logWarn("Invalid Start/Stop Status Code specification: " + ssKey);
//Print.logStackTrace("here");
this.startStopCodes = null;
}
/**
*** Sets the start and stop status codes.
*** @param startCode The start status code
*** @param stopCode The stop status code
**/
public void setStartStopStatusCodes(int startCode, int stopCode)
{
if ((startCode > 0) && (stopCode > 0)) {
this.startStopCodes = new int[] { startCode, stopCode };
} else {
this.startStopCodes = null;
}
}
/**
*** Sets the start and stop status codes.
*** @param startStopCodes An array containing 2 elements. The first element
*** is the start status code, and the second element
*** is the stop status code.
**/
public void setStartStopStatusCodes(int startStopCodes[])
{
if (ListTools.size(startStopCodes) >= 2) {
this.setStartStopStatusCodes(startStopCodes[0], startStopCodes[1]);
} else {
this.startStopCodes = null;
}
}
/**
*** Gets the start/stop status codes, or null if no start/stop status codes
*** have been defined. If non-null, element '0' will always contain the
*** start code, and element '1' will contain the stop code.
*** @return The start/stop status codes, or null if no codes defined.
**/
public int[] getStartStopStatusCodes()
{
if (!this.startStopCodes_init) {
String ssk = this.getStringProperty(DCServerFactory.CONFIG_startStopStatusCodes(this.getName()), null);
this.setStartStopStatusCodes(ssk);
this.startStopCodes_init = true;
}
return this.startStopCodes;
}
// ------------------------------------------------------------------------
// ------------------------------------------------------------------------
/**
*** Start Command Listener
*** @param port The listen port
*** @param handler The command handler class
**/
public static ServerSocketThread startCommandHandler(int port, Class handler)
throws Throwable
{
ServerSocketThread sst = null;
/* create server socket */
try {
sst = new ServerSocketThread(port);
sst.setName("CommandListener_" + port);
} catch (Throwable t) { // trap any server exception
Print.logException("ServerSocket error", t);
throw t;
}
/* initialize */
sst.setTextPackets(true);
sst.setBackspaceChar(null); // no backspaces allowed
sst.setLineTerminatorChar(new int[] { '\r', '\n' });
sst.setIgnoreChar(null);
sst.setMaximumPacketLength(1024); // safety net
sst.setMinimumPacketLength(1);
sst.setIdleTimeout(1000L); // time between packets
sst.setPacketTimeout(1000L); // time from start of packet to packet completion
sst.setSessionTimeout(5000L); // time for entire session
sst.setLingerTimeoutSec(5);
sst.setTerminateOnTimeout(true);
sst.setClientPacketHandlerClass(handler);
/* start thread */
DCServerConfig.startServerSocketThread(sst,"Command");
return sst;
}
/**
*** Start ServerSocketThread
*** @param sst The ServerSocketThread to start
*** @param type The short 'type' name of the socket listener
**/
public static void startServerSocketThread(ServerSocketThread sst, String type)
{
if (sst != null) {
/* message header */
String m = StringTools.trim(type);
int port = sst.getLocalPort();
boolean isBound = true;
String bindAddr = StringTools.blankDefault(sst.getBindAddress(), "(ALL)");
if (bindAddr.startsWith("/")) { bindAddr = bindAddr.substring(1); }
if (sst.getServerSocket() != null) {
// TCP
long tmo = sst.getSessionTimeout();
Print.logInfo("Starting "+m+" Listener (TCP) - " +port+ " [" +bindAddr+ "] timeout="+tmo+"ms ...");
isBound = true;
} else
if (sst.getDatagramSocket() != null) {
// UDP
Print.logInfo("Starting "+m+" Listener (UDP) - " +port+ " [" +bindAddr+ "] ...");
isBound = true;
} else {
Print.logInfo("Initialized "+m+" Listener (non-socket)");
isBound = false;
}
/* set DCS indicator */
DCServerFactory.__setRunningDCS(null);
/* start thread */
if (isBound) {
sst.start();
}
} else {
Print.logStackTrace("ServerSocketThread is null!");
}
}
// ------------------------------------------------------------------------
// ------------------------------------------------------------------------
/**
*** Load device record from unique-id.
*** @param dcsc The DCS DCServerConfig instance. If null, this method
*** will return null.
*** @param modemID The unique modem ID (IMEI, ESN, etc)
*** @return The Device record, or null if "dcsc" is null, or if the modemID
*** is not found.
**/
public static Device loadDeviceUniqueID(DCServerConfig dcsc, String modemID)
{
if (dcsc != null) {
return dcsc.loadDeviceUniqueID(modemID);
} else {
Print.logError("DCServerConfig is null");
return null;
}
}
/**
*** Load device record from unique-id.
*** This is the main method used by most DCS modules to load the Device record
*** instance from the specified modemID.
*** @param modemID The unique modem ID (IMEI, ESN, etc)
*** @return The Device record, or null if "dcsc" is null, or if the modemID
*** is not found.
**/
public Device loadDeviceUniqueID(String modemID)
{
return DCServerFactory._loadDeviceByPrefixedModemID(this.getUniquePrefix(), modemID);
}
// ------------------------------------------------------------------------
// ------------------------------------------------------------------------
/**
*** Returns true if the named server is defined in the current installation.
**/
public boolean serverJarExists()
{
return DCServerFactory.serverJarExists(this.getName());
}
/**
*** Returns true if this DCS requires a Jar file
**/
public boolean isJarOptional()
{
return this.isAttributeFlag(F_JAR_OPTIONAL);
}
// ------------------------------------------------------------------------
// ------------------------------------------------------------------------
/**
*** Loads/Returns the named class.
*** @param cn The class name
*** @param SC The required subclass (may be null)
*** @param dftC The default class if unable to return named class
*** @return The loaded named class
**/
private Class LoadClassForName(String cn, Class SC, Class dftC)
{
if (!StringTools.isBlank(cn)) {
try {
Class C = Class.forName(cn);
if ((SC == null) || SC.isAssignableFrom(C)) {
return C;
} else {
Print.logError("Invalid '"+StringTools.className(SC)+"' class: " + cn);
return dftC;
}
} catch (ClassNotFoundException cnfe) {
Print.logWarn("Class not found: " + cn);
return dftC;
} catch (Throwable th) {
Print.logError("Error loading class: " + cn + " [" + th + "]");
return dftC;
}
} else {
return dftC;
}
}
/**
*** Gets the "TrackServerAdapter" subclass
*** @param tsaC The "TrackServerAdapter" class
*** @param dftC The default "TrackServerAdapter" subclass
*** @return The "TrackServerAdapter" class
**/
@SuppressWarnings("unchecked")
public Class getTrackServerAdapterClass(Class tsaC, Class dftC)
{
String cn = this.getStringProperty(DCServerFactory.CONFIG_TrackServerAdapterClass(this.getName()),null);
return LoadClassForName(cn, tsaC, dftC);
}
/**
*** Gets the "CommandPacketHandler" subclass
*** @param dftC The default "CommandPacketHandler" subclass
*** @return The "CommandPacketHandler" subclass
**/
@SuppressWarnings("unchecked")
public Class getCommandPacketHandlerClass(Class dftC)
{
String cn = this.getStringProperty(DCServerFactory.CONFIG_CommandPacketHandlerClass(this.getName()),null);
return (Class)LoadClassForName(cn, CommandPacketHandler.class, dftC);
}
/**
*** Gets the "ClientPacketHandler" subclass
*** @param dftC The default "ClientPacketHandler" subclass
*** @return The "ClientPacketHandler" subclass
**/
@SuppressWarnings("unchecked")
public Class getClientPacketHandlerClass(Class dftC)
{
String cn = this.getStringProperty(DCServerFactory.CONFIG_ClientPacketHandlerClass(this.getName()),null);
return (Class)LoadClassForName(cn, ClientPacketHandler.class, dftC);
}
// ------------------------------------------------------------------------
// ------------------------------------------------------------------------
/**
*** Sets the command protocol to use when communicating with remote devices
*** @param proto The CommandProtocol
**/
public void setCommandProtocol(String proto)
{
this.commandProtocol = DCServerConfig.getCommandProtocol(proto);
}
/**
*** Sets the command protocol to use when communicating with remote devices
*** @param proto The CommandProtocol
**/
public void setCommandProtocol(CommandProtocol proto)
{
this.commandProtocol = proto;
}
/**
*** Gets the command protocol to use when communicating with remote devices
*** @return The Command Protocol
**/
public CommandProtocol getCommandProtocol()
{
return (this.commandProtocol != null)? this.commandProtocol : CommandProtocol.UDP;
}
/**
*** Gets the "Client Command Port"
*** @param dft The default Client Command Port
*** @return The Client Command Port
**/
public int getClientCommandPort_udp(int dft)
{
return this.getIntProperty(DCServerFactory.CONFIG_clientCommandPort_udp(this.getName()), dft);
}
/**
*** Gets the "Client Command Port"
*** @param dft The default Client Command Port
*** @return The Client Command Port
**/
public int getClientCommandPort_tcp(int dft)
{
return this.getIntProperty(DCServerFactory.CONFIG_clientCommandPort_tcp(this.getName()), dft);
}
// ------------------------------------------------------------------------
// ------------------------------------------------------------------------
/**
*** Gets the "ACK Response Port"
*** @param dft The ACK response port
*** @return The ack response port
**/
public int getAckResponsePort(int dft)
{
return this.getIntProperty(DCServerFactory.CONFIG_ackResponsePort(this.getName()), dft);
}
/**
*** Gets the "ACK Response Port"
*** @param dcsc The DCServerConfig instance
*** @param dft The ACK response port
*** @return The ack response port
**/
public static int getAckResponsePort(DCServerConfig dcsc, int dft)
{
return (dcsc != null)? dcsc.getAckResponsePort(dft) : dft;
}
// ------------------------------------------------------------------------
/**
*** Gets the "TCP idle timeout"
*** @param dft The default timeout value
*** @return The default timeout value
**/
public long getTcpIdleTimeoutMS(long dft)
{
return this.getLongProperty(DCServerFactory.CONFIG_tcpIdleTimeoutMS(this.getName()), dft);
}
/**
*** Gets the "TCP packet timeout"
*** @param dft The default timeout value
*** @return The default timeout value
**/
public long getTcpPacketTimeoutMS(long dft)
{
return this.getLongProperty(DCServerFactory.CONFIG_tcpPacketTimeoutMS(this.getName()), dft);
}
/**
*** Gets the "TCP session timeout"
*** @param dft The default timeout value
*** @return The default timeout value
**/
public long getTcpSessionTimeoutMS(long dft)
{
return this.getLongProperty(DCServerFactory.CONFIG_tcpSessionTimeoutMS(this.getName()), dft);
}
// ------------------------------------------------------------------------
/**
*** Gets the "UDP idle timeout"
*** @param dft The default timeout value
*** @return The default timeout value
**/
public long getUdpIdleTimeoutMS(long dft)
{
return this.getLongProperty(DCServerFactory.CONFIG_udpIdleTimeoutMS(this.getName()), dft);
}
/**
*** Gets the "UDP packet timeout"
*** @param dft The default timeout value
*** @return The default timeout value
**/
public long getUdpPacketTimeoutMS(long dft)
{
return this.getLongProperty(DCServerFactory.CONFIG_udpPacketTimeoutMS(this.getName()), dft);
}
/**
*** Gets the "UDP session timeout"
*** @param dft The default timeout value
*** @return The default timeout value
**/
public long getUdpSessionTimeoutMS(long dft)
{
return this.getLongProperty(DCServerFactory.CONFIG_udpSessionTimeoutMS(this.getName()), dft);
}
// ------------------------------------------------------------------------
/**
*** Gets the array of allowed UniqueID prefixes
*** @param dftPfx The default list of prefixes
*** @return The array of allowed UniqueID prefixes
**/
public String[] getUniquePrefix(String dftPfx[])
{
if (ListTools.isEmpty(this.uniquePrefix)) {
// set non-empty default
this.uniquePrefix = !ListTools.isEmpty(dftPfx)? dftPfx : new String[] { "" };
}
return this.uniquePrefix;
}
/**
*** Gets the array of allowed UniqueID prefixes
*** @return The array of allowed UniqueID prefixes
**/
public String[] getUniquePrefix()
{
return this.getUniquePrefix(null);
}
/**
*** Sets the array of allowed UniqueID prefixes
*** @param pfx The default UniqueID prefixes
**/
public void setUniquePrefix(String pfx[])
{
if (!ListTools.isEmpty(pfx)) {
for (int i = 0; i < pfx.length; i++) {
String p = pfx[i].trim();
if (p.equals("") || p.equals("*")) {
p = "";
} else
if (p.endsWith("*")) {
p = p.substring(0, p.length() - 1);
}
pfx[i] = p;
}
this.uniquePrefix = pfx;
} else {
this.uniquePrefix = new String[] { "" };;
}
}
// ------------------------------------------------------------------------
/**
*** Gets the "Minimum Moved Meters"
*** @param dft The default minimum distance
*** @return The Minimum Moved Meters
**/
public double getMinimumMovedMeters(double dft)
{
return this.getDoubleProperty(DCServerFactory.CONFIG_minimumMovedMeters(this.getName()), dft);
}
/**
*** Gets the "Minimum Moved Meters"
*** @param dcsc The DCServerConfig instance
*** @param dft The default minimum distance
*** @return The Minimum Moved Meters
**/
public static double getMinimumMovedMeters(DCServerConfig dcsc, double dft)
{
return (dcsc != null)? dcsc.getMinimumMovedMeters(dft) : dft;
}
// ------------------------------------------------------------------------
/**
*** Gets the "Minimum Speed KPH"
*** @param dft The default minimum speed
*** @return The Minimum Speed KPH
**/
public double getMinimumSpeedKPH(double dft)
{
return this.getDoubleProperty(DCServerFactory.CONFIG_minimumSpeedKPH(this.getName()), dft);
}
/**
*** Gets the "Minimum Speed KPH"
*** @param dcsc The DCServerConfig instance
*** @param dft The default minimum speed
*** @return The Minimum Speed KPH
**/
public static double getMinimumSpeedKPH(DCServerConfig dcsc, double dft)
{
return (dcsc != null)? dcsc.getMinimumSpeedKPH(dft) : dft;
}
// ------------------------------------------------------------------------
/**
*** Gets the "Estimate Odometer" flag
*** @param dft The default estimate odometer flag
*** @return The Estimate Odometer flag
**/
public boolean getEstimateOdometer(boolean dft)
{
return this.getBooleanProperty(DCServerFactory.CONFIG_estimateOdometer(this.getName()), dft);
}
/**
*** Gets the "Estimate Odometer" flag
*** @param dcsc The DCServerConfig instance
*** @param dft The default estimate odometer flag
*** @return The Estimate Odometer flag
**/
public static boolean getEstimateOdometer(DCServerConfig dcsc, boolean dft)
{
return (dcsc != null)? dcsc.getEstimateOdometer(dft) : dft;
}
// ------------------------------------------------------------------------
/**
*** Gets the "Ignore Device Odometer" flag
*** @param dft The default ignore device odometer flag
*** @return The Ignore Device Odometer flag
**/
public boolean getIgnoreDeviceOdometer(boolean dft)
{
return this.getBooleanProperty(DCServerFactory.CONFIG_ignoreDeviceOdometer(this.getName()), dft);
}
/**
*** Gets the "Ignore Device Odometer" flag
*** @param dcsc The DCServerConfig instance
*** @param dft The default ignore device odometer flag
*** @return The ignore device Odometer flag
**/
public static boolean getIgnoreDeviceOdometer(DCServerConfig dcsc, boolean dft)
{
return (dcsc != null)? dcsc.getIgnoreDeviceOdometer(dft) : dft;
}
// ------------------------------------------------------------------------
/**
*** Gets the "Simulate Geozones" state
*** @param dft The default Simulate Geozones state
*** @return The Simulate Geozones state
**/
public boolean getSimulateGeozones(boolean dft)
{
return this.getBooleanProperty(DCServerFactory.CONFIG_simulateGeozones(this.getName()), dft);
}
/**
*** Gets the "Simulate Geozones" state
*** @param dcsc The DCServerConfig instance
*** @param dft The default Simulate Geozones state
*** @return The Simulate Geozones state
**/
public static boolean getSimulateGeozones(DCServerConfig dcsc, boolean dft)
{
return (dcsc != null)? dcsc.getSimulateGeozones(dft) : dft;
}
// ------------------------------------------------------------------------
/**
*** Gets the "Geozone Skip Old Events" state
*** @param dft The default Geozone Skip Old Events state
*** @return The Geozone Skip Old Events state
**/
public boolean getGeozoneSkipOldEvents(boolean dft)
{
return this.getBooleanProperty(DCServerFactory.CONFIG_geozoneSkipOldEvents(this.getName()), dft);
}
/**
*** Gets the "Geozone Skip Old Events" state
*** @param dcsc The DCServerConfig instance
*** @param dft The default Geozone Skip Old Events state
*** @return The Geozone Skip Old Events state
**/
public static boolean getGeozoneSkipOldEvents(DCServerConfig dcsc, boolean dft)
{
return (dcsc != null)? dcsc.getGeozoneSkipOldEvents(dft) : dft;
}
// ------------------------------------------------------------------------
/**
*** Gets the "Maximum HDOP"
*** @param dft The default maximum HDOP
*** @return The Maximum HDOP
**/
public double getMaximumHDOP(double dft)
{
return this.getDoubleProperty(DCServerFactory.CONFIG_maximumHDOP(this.getName()), dft);
}
/**
*** Gets the "Maximum HDOP"
*** @param dcsc The DCServerConfig instance
*** @param dft The default maximum HDOP
*** @return The Maximum HDOP
**/
public static double getMaximumHDOP(DCServerConfig dcsc, double dft)
{
return (dcsc != null)? dcsc.getMaximumHDOP(dft) : dft;
}
// ------------------------------------------------------------------------
/**
*** Gets the "Check Last Odometer" config
*** @param dft The default "Check Last Odometer" state
*** @return The "Check Last Odometer" state
**/
public boolean getCheckLastOdometer(boolean dft)
{
return this.getBooleanProperty(DCServerFactory.CONFIG_checkLastOdometer(this.getName()), dft);
}
/**
*** Gets the "Check Last Odometer" config
*** @param dcsc The DCServerConfig instance
*** @param dft The default "Check Last Odometer" state
*** @return The "Check Last Odometer" state
**/
public static boolean getCheckLastOdometer(DCServerConfig dcsc, boolean dft)
{
return (dcsc != null)? dcsc.getCheckLastOdometer(dft) : dft;
}
// ------------------------------------------------------------------------
/**
*** Gets the "Save Raw Data Packet" config
*** @param dft The default "Save Raw Data Packet" state
*** @return The "Save Raw Data Packet" state
**/
public boolean getSaveRawDataPackets(boolean dft)
{
return this.getBooleanProperty(DCServerFactory.CONFIG_saveRawDataPackets(this.getName()), dft);
}
/**
*** Gets the "Save Raw Data Packet" config
*** @param dcsc The DCServerConfig instance
*** @param dft The default "Save Raw Data Packet" state
*** @return The "Save Raw Data Packet" state
**/
public static boolean getSaveRawDataPackets(DCServerConfig dcsc, boolean dft)
{
return (dcsc != null)? dcsc.getSaveRawDataPackets(dft) : dft;
}
// ------------------------------------------------------------------------
/**
*** Gets the "Start/Stop StatusCode supported" config
*** @param dft The default "Start/Stop StatusCode supported" state
*** @return The "Start/Stop StatusCode supported" state
**/
public boolean getStartStopSupported(boolean dft)
{
String n = this.getName();
if (n.equals(DCServerFactory.OPENDMTP_NAME)) {
return true;
} else {
return this.getBooleanProperty(DCServerFactory.CONFIG_startStopSupported(this.getName()), dft);
}
}
/**
*** Gets the "Start/Stop StatusCode supported" config
*** @param dcsc The DCServerConfig instance
*** @param dft The default "Start/Stop StatusCode supported" state
*** @return The "Start/Stop StatusCode supported" state
**/
public static boolean getStartStopSupported(DCServerConfig dcsc, boolean dft)
{
return (dcsc != null)? dcsc.getStartStopSupported(dft) : dft;
}
// ------------------------------------------------------------------------
/**
*** Gets the "Status Location/InMotion Translation" config
*** @param dft The default "Status Location/InMotion Translation" state
*** @return The "Status Location/InMotion Translation" state
**/
public boolean getStatusLocationInMotion(boolean dft)
{
return this.getBooleanProperty(DCServerFactory.CONFIG_statusLocationInMotion(this.getName()), dft);
}
/**
*** Gets the "Status Location/InMotion Translation" config
*** @param dcsc The DCServerConfig instance
*** @param dft The default "Status Location/InMotion Translation" state
*** @return The "Status Location/InMotion Translation" state
**/
public static boolean getStatusLocationInMotion(DCServerConfig dcsc, boolean dft)
{
return (dcsc != null)? dcsc.getStatusLocationInMotion(dft) : dft;
}
// ------------------------------------------------------------------------
/**
*** Gets the "Ignore Invalid GPS Location Flag" config
*** @param dft The default "Ignore Invalid GPS Location Flag" state
*** @return The "Ignore Invalid GPS Location Flag" state
**/
public boolean getIgnoreInvalidGPSFlag(boolean dft)
{
return this.getBooleanProperty(DCServerFactory.CONFIG_ignoreInvalidGPSFlag(this.getName()), dft);
}
/**
*** Gets the "Ignore Invalid GPS Location Flag" config
*** @param dcsc The DCServerConfig instance
*** @param dft The default "Ignore Invalid GPS Location Flag" state
*** @return The "Ignore Invalid GPS Location Flag" state
**/
public static boolean getIgnoreInvalidGPSFlag(DCServerConfig dcsc, boolean dft)
{
return (dcsc != null)? dcsc.getIgnoreInvalidGPSFlag(dft) : dft;
}
// ------------------------------------------------------------------------
/**
*** Gets the "Ignore Events with Invalid GPS" config
*** @param dft The default "Ignore Events with Invalid GPS" state
*** @return The "Ignore Events with Invalid GPS" state
**/
public boolean getIgnoreEventsWithInvalidGPS(boolean dft)
{
return this.getBooleanProperty(DCServerFactory.CONFIG_ignoreEventsWithInvalidGPS(this.getName()), dft);
}
/**
*** Gets the "Ignore Events with Invalid GPS" config
*** @param dcsc The DCServerConfig instance
*** @param dft The default "Ignore Events with Invalid GPS" state
*** @return The "Ignore Events with Invalid GPS" state
**/
public static boolean getIgnoreEventsWithInvalidGPS(DCServerConfig dcsc, boolean dft)
{
return (dcsc != null)? dcsc.getIgnoreEventsWithInvalidGPS(dft) : dft;
}
// ------------------------------------------------------------------------
/**
*** Gets the "Use Last Valid GPS Location" config
*** @param dft The default "Use Last Valid GPS Location" state
*** @return The "Use Last Valid GPS Location" state
**/
public boolean getUseLastValidGPSLocation(boolean dft)
{
return this.getBooleanProperty(DCServerFactory.CONFIG_useLastValidGPSLocation(this.getName()), dft);
}
/**
*** Gets the "Use Last Valid GPS Location" config
*** @param dcsc The DCServerConfig instance
*** @param dft The default "Use Last Valid GPS Location" state
*** @return The "Use Last Valid GPS Location" state
**/
public static boolean getUseLastValidGPSLocation(DCServerConfig dcsc, boolean dft)
{
return (dcsc != null)? dcsc.getUseLastValidGPSLocation(dft) : dft;
}
// ------------------------------------------------------------------------
/**
*** Gets the "Use Alternate Current Timestamp for Event" config
*** @param dft The default "Use Alternate Current Timestamp for Event" state
*** @return The "Use Alternate Current Timestamp for Event" state
**/
public boolean getUseAltCurrentTimestamp(boolean dft)
{
return this.getBooleanProperty(DCServerFactory.CONFIG_useAltCurrentTimestamp(this.getName()), dft);
}
/**
*** Gets the "Use Alternate Current Timestamp for Event" config
*** @param dcsc The DCServerConfig instance
*** @param dft The default "Use Alternate Current Timestamp for Event" state
*** @return The "Use Alternate Current Timestamp for Event" state
**/
public static boolean getUseAltCurrentTimestamp(DCServerConfig dcsc, boolean dft)
{
return (dcsc != null)? dcsc.getUseAltCurrentTimestamp(dft) : dft;
}
// ------------------------------------------------------------------------
/**
*** Gets the "Save Session Statistics" config
*** @param dft The default "Save Session Statistics" state
*** @return The "Save Session Statistics" state
**/
public boolean getSaveSessionStatistics(boolean dft)
{
return this.getBooleanProperty(DCServerFactory.CONFIG_saveSessionStatistics(this.getName()), dft);
}
/**
*** Gets the "Save Session Statistics" config
*** @param dcsc The DCServerConfig instance
*** @param dft The default "Save Session Statistics" state
*** @return The "Save Session Statistics" state
**/
public static boolean getSaveSessionStatistics(DCServerConfig dcsc, boolean dft)
{
return (dcsc != null)? dcsc.getSaveSessionStatistics(dft) : dft;
}
// ------------------------------------------------------------------------
/**
*** Gets the "Debug Mode" config
*** @param dft The default "Debug Mode" state
*** @return The "Debug Mode" state
**/
public boolean getDebugMode(boolean dft)
{
return this.getBooleanProperty(DCServerFactory.CONFIG_debugMode(this.getName()), dft);
}
/**
*** Gets the "Debug Mode" config
*** @param dcsc The DCServerConfig instance
*** @param dft The default "Debug Mode" state
*** @return The "Debug Mode" state
**/
public static boolean getDebugMode(DCServerConfig dcsc, boolean dft)
{
return (dcsc != null)? dcsc.getDebugMode(dft) : dft;
}
// ------------------------------------------------------------------------
/**
*** Gets the "Show URL" config
*** @param dft The default "Show URL" state
*** @return The "Show URL" state
**/
public boolean getShowURL(boolean dft)
{
return this.getBooleanProperty(DCServerFactory.CONFIG_showURL(this.getName()), dft);
}
/**
*** Gets the "Show URL" config
*** @param dcsc The DCServerConfig instance
*** @param dft The default "Show URL" state
*** @return The "Show URL" state
**/
public static boolean getShowURL(DCServerConfig dcsc, boolean dft)
{
return (dcsc != null)? dcsc.getShowURL(dft) : dft;
}
// ------------------------------------------------------------------------
/**
*** Gets the "Command ACK bit" config
*** @param dft The default "Command ACK bit"
*** @return The "Command ACK bit"
**/
public int getCommandAckBit(String bitName, int dft)
{
return this.getIntProperty(DCServerFactory.CONFIG_commandAckBit(this.getName(),bitName), dft);
}
/**
*** Gets the "Command ACK bit" config
*** @param dcsc The DCServerConfig instance
*** @param dft The default "Command ACK bit"
*** @return The "Command ACK bit"
**/
public static int getCommandAckBit(DCServerConfig dcsc, String bitName, int dft)
{
return (dcsc != null)? dcsc.getCommandAckBit(bitName,dft) : dft;
}
// ------------------------------------------------------------------------
/**
*** Gets the "Battery Level Range" config
*** @param dft The default "Battery Level Range" min/max values
*** @return The "Battery Level Range" min/max values
**/
public double[] getBatteryLevelRange(double dft[])
{
String propKeys[] = DCServerFactory.CONFIG_batteryLevelRange(this.getName());
/* get property string */
String blrS = this.getStringProperty(propKeys, null);
if (StringTools.isBlank(blrS)) {
return dft;
}
/* parse */
double blr[] = StringTools.parseDouble(StringTools.split(blrS,','),0.0);
double min = 0.0;
double max = 0.0;
if (ListTools.size(blr) <= 0) {
min = (ListTools.size(dft) > 0)? dft[0] : 11.4;
max = (ListTools.size(dft) > 1)? dft[1] : 12.8;
} else
if (ListTools.size(blr) == 1) {
// 12.0
min = blr[0];
max = blr[0];
} else {
min = blr[0];
max = blr[1];
}
/* adjust */
if (min < 0.0) { min = 0.0; }
if (max < 0.0) { max = 0.0; }
if (max <= min) {
// 12.8,11.4
double tmp = max;
max = min;
min = tmp;
}
/* return */
return new double[] { min, max };
}
/**
*** Gets the "Battery Level Range" config
*** @param dcsc The DCServerConfig instance
*** @param dft The default "Battery Level Range" min/max values
*** @return The "Battery Level Range" min/max values
**/
public static double[] getBatteryLevelRange(DCServerConfig dcsc, double dft[])
{
return (dcsc != null)? dcsc.getBatteryLevelRange(dft) : dft;
}
/**
*** Calculates/returns the battery level based on the specified voltage range
*** @param voltage The current battery voltage
*** @param range The allowed voltage range
*** @return The battery level percent
**/
public static double CalculateBatteryLevel(double voltage, double range[])
{
/* no specified voltage? */
if (voltage <= 0.0) {
return 0.0;
}
/* no specified range? */
int rangeSize = ListTools.size(range);
if ((rangeSize < 1) || (voltage <= range[0])) {
return 0.0;
} else
if ((rangeSize < 2) || (voltage >= range[1])) {
return 1.0;
}
/* get percent */
// Note: the above filters out (range[1] == range[0])
double percent = (voltage - range[0]) / (range[1] - range[0]);
if (percent < 0.0) {
return 0.0;
} else
if (percent > 1.0) {
return 1.0;
} else {
return percent;
}
}
// ------------------------------------------------------------------------
/**
*** Gets the "Simulate Geozones" mask
*** @param dft The default Simulate Geozones mask
*** @return The Simulate Geozones mask
**/
public long getSimulateDigitalInputs(long dft)
{
String maskStr = this.getStringProperty(DCServerFactory.CONFIG_simulateDigitalInputs(this.getName()), null);
if (StringTools.isBlank(maskStr)) {
// not specified (or blank)
return dft;
} else
if (maskStr.equalsIgnoreCase("default")) {
// explicit "default"
return dft;
} else
if (maskStr.equalsIgnoreCase("true")) {
// explicit "true"
return 0xFFFFFFFFL;
} else
if (maskStr.equalsIgnoreCase("false")) {
// explicit "false"
return 0x00000000L;
} else {
// mask specified
long mask = StringTools.parseLong(maskStr, -1L);
return (mask >= 0L)? mask : dft;
}
}
/**
*** Gets the "Simulate Geozones" mask
*** @param dcsc The DCServerConfig instance
*** @param dft The default Simulate Geozones mask
*** @return The Simulate Geozones mask
**/
public static long getSimulateDigitalInputs(DCServerConfig dcsc, long dft)
{
return (dcsc != null)? dcsc.getSimulateDigitalInputs(dft) : dft;
}
/**
*** Returns true if this device supports digital inputs
*** @return True if this device supports digital inputs
**/
public boolean hasDigitalInputs()
{
return this.isAttributeFlag(F_HAS_INPUTS);
}
/**
*** Returns true if this device supports digital outputs
*** @return True if this device supports digital outputs
**/
public boolean hasDigitalOutputs()
{
return this.isAttributeFlag(F_HAS_OUTPUTS);
}
// ------------------------------------------------------------------------
// ------------------------------------------------------------------------
/**
*** Convenience for converting the initial/final packet to a byte array.
*** If the string begins with "0x" the the remain string is assumed to be hex
*** @return The byte array
**/
public static byte[] convertToBytes(String s)
{
if (s == null) {
return null;
} else
if (s.startsWith("0x")) {
byte b[] = StringTools.parseHex(s,null);
if (b != null) {
return b;
} else {
return null;
}
} else {
return StringTools.getBytes(s);
}
}
/**
*** Gets the "Initial Packet" byte array
*** @param dft The default "Initial Packet" byte array
*** @return The "Initial Packet" byte array
**/
public byte[] getInitialPacket(byte[] dft)
{
String s = this.getStringProperty(DCServerFactory.CONFIG_initialPacket(this.getName()), null);
if (s == null) {
return dft;
} else
if (s.startsWith("0x")) {
return StringTools.parseHex(s,dft);
} else {
return s.getBytes();
}
}
/**
*** Gets the "Final Packet" byte array
*** @param dft The default "Final Packet" byte array
*** @return The "Final Packet" byte array
**/
public byte[] getFinalPacket(byte[] dft)
{
String s = this.getStringProperty(DCServerFactory.CONFIG_finalPacket(this.getName()), null);
if (s == null) {
return dft;
} else
if (s.startsWith("0x")) {
return StringTools.parseHex(s,dft);
} else {
return s.getBytes();
}
}
// ------------------------------------------------------------------------
// ------------------------------------------------------------------------
/**
*** Sets the "Event Code Map Enable" config
*** @param enabled The "Event Code Map Enable" state
**/
public void setEventCodeEnabled(boolean enabled)
{
this.customCodeEnabled = enabled;
//Print.logDebug("[" + this.getName() + "] EventCode translation enabled=" + this.customCodeEnabled);
}
/**
*** Gets the "Event Code Map Enable" config
*** @return The "Event Code Map Enable" state
**/
public boolean getEventCodeEnabled()
{
return this.customCodeEnabled;
}
/**
*** Sets the EventCodeMap
**/
public void setEventCodeMap(Map codeMap)
{
this.customCodeMap = (codeMap != null)? codeMap : new HashMap();
}
/**
*** Prints the EventCodeMap
**/
public boolean printEventCodeMap()
{
if (ListTools.isEmpty(this.customCodeMap)) {
return false;
}
Vector